# Oauth Clients MCP Tools

> The MCP tools the SOAT server exposes for the Oauth Clients module, with the arguments each tool takes.

# Oauth Clients

MCP tools for the Oauth Clients module. See the [Oauth Clients module docs](/docs/modules/oauth-clients) for permissions and data model.

### `list-oauth-clients`

List OAuth clients

#### Arguments

| Argument | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `project_id` | `string` | no | Project ID (required if not using project key auth) |
| `limit` | `number` | no | Results per page. Above the maximum it is clamped; below 1 or not an integer it is `400 VALIDATION_FAILED`. |
| `cursor` | `string` | no | The previous page's `next_cursor`; omit it for the first page. Send it with the same filters as the request that returned it: a malformed cursor, or one sent with other filters, is `400 INVALID_CURSOR`. |

### `create-oauth-client`

Create an OAuth client

#### Arguments

| Argument | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `project_id` | `string` | no | Project ID (required if not using project key auth) |
| `name` | `string` | yes | A label for the client, such as the provider's name. |
| `authorize_url` | `string` | yes | The provider's authorization endpoint. Query parameters it already carries are kept. |
| `token_url` | `string` | yes | The provider's token endpoint. |
| `revocation_url` | `string \| null` | no | The provider's RFC 7009 revocation endpoint, called when a connection is deleted. `null` skips revocation. |
| `client_id` | `string` | yes | Your app's client ID at the provider. |
| `client_secret` | `string \| null` | no | A `{{secret:sec_...}}` reference to your app's client secret, never the value. `null` for a public client, which relies on PKCE. |
| `scopes` | `array<string>` | yes | The scopes requested at authorization. |
| `pkce` | `boolean` | no | Whether the authorization uses PKCE (`S256`). |
| `token_endpoint_auth_method` | `string` | no | How the client authenticates at the token endpoint. |
| `redirect_uri` | `string \| null` | no | The callback the provider redirects to, as registered with the provider. Absent on create, or `null`, it is the deployment's `OAUTH_DEFAULT_REDIRECT_URI` when set, else stored `null`: this server's own `{SOAT_BASE_URL}/api/v1/oauth-connections/callback`. A front end that receives the redirect itself forwards `code` and `state` there. |
| `authorize_params` | `object \| null` | no | Extra query parameters for the authorize URL, such as Google's `access_type: offline` and `prompt: consent` for a refresh token. |

### `get-oauth-client`

Get an OAuth client

#### Arguments

| Argument | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `oauth_client_id` | `string` | yes | OAuth client ID |

### `update-oauth-client`

Update an OAuth client

#### Arguments

| Argument | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `oauth_client_id` | `string` | yes | OAuth client ID |
| `name` | `string` | no | A label for the client, such as the provider's name. |
| `authorize_url` | `string` | no | The provider's authorization endpoint. Query parameters it already carries are kept. |
| `token_url` | `string` | no | The provider's token endpoint. |
| `revocation_url` | `string \| null` | no | The provider's RFC 7009 revocation endpoint, called when a connection is deleted. `null` skips revocation. |
| `client_id` | `string` | no | Your app's client ID at the provider. |
| `client_secret` | `string \| null` | no | A `{{secret:sec_...}}` reference to your app's client secret, never the value. `null` for a public client, which relies on PKCE. |
| `scopes` | `array<string>` | no | The scopes requested at authorization. |
| `pkce` | `boolean` | no | Whether the authorization uses PKCE (`S256`). |
| `token_endpoint_auth_method` | `string` | no | How the client authenticates at the token endpoint. |
| `redirect_uri` | `string \| null` | no | The callback the provider redirects to, as registered with the provider. Absent on create, or `null`, it is the deployment's `OAUTH_DEFAULT_REDIRECT_URI` when set, else stored `null`: this server's own `{SOAT_BASE_URL}/api/v1/oauth-connections/callback`. A front end that receives the redirect itself forwards `code` and `state` there. |
| `authorize_params` | `object \| null` | no | Extra query parameters for the authorize URL, such as Google's `access_type: offline` and `prompt: consent` for a refresh token. |

### `delete-oauth-client`

Delete an OAuth client

#### Arguments

| Argument | Type | Required | Description |
| -------- | ---- | -------- | ----------- |
| `oauth_client_id` | `string` | yes | OAuth client ID |
