Skip to content

Add MCP client credentials documentation #5223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −0
Open

Add MCP client credentials documentation #5223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions ai/model-context-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
The MCP search tool supports optional parameters that AI applications use to control and refine search results.

- **`pageSize`**: Number of results to return, between 1 and 50. Defaults to 10.
- **`scoreThreshold`**: Minimum relevance score between 0 and 1. Only returns results at or above this threshold. Use this to filter out low-relevance matches.

Check warning on line 41 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L41 

Use 'preceding' instead of 'above'.
- **`version`**: Filter results to a specific documentation version. For example, `'v0.7'`. Only returns content tagged with the specified version or content available across all versions.
- **`language`**: Filter results to a specific language code. For example, `'en'`, `'zh'`, or `'es'`. Only returns content in the specified language or content available across all languages.

Expand Down Expand Up @@ -104,6 +104,48 @@
</Step>
</Steps>

### Client credentials

Client credentials enable programmatic, machine-to-machine access to your authenticated MCP server without interactive login. Use client credentials when you need automated systems, CI/CD pipelines, or backend services to access your MCP server.

With client credentials, your application authenticates using a client ID and client secret instead of going through the interactive OAuth flow. The token endpoint issues an access token scoped to `mcp:search`.

<Steps>
<Step title="Generate client credentials">
1. Navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
2. In the **Client credentials** section, click **Generate credentials**.
3. Enter a label to identify the credential, such as `Production server`.
4. Click **Generate**.
5. Copy and securely store the client ID and client secret. The secret is only shown once.
</Step>
<Step title="Request an access token">
Exchange your client credentials for an access token by making a `POST` request to your MCP server's token endpoint. Pass your credentials using `client_secret_post` (form body) or HTTP Basic authentication (`Authorization: Basic`).

```bash
curl -X POST https://<your-docs-domain>/mcp/oauth/token \
-d grant_type=client_credentials \
-d client_id=<your-client-id> \
-d client_secret=<your-client-secret>
```

A successful response returns a bearer token:

```json
{
"access_token": "<token>",
"token_type": "Bearer",
"expires_in": 1209600,
"scope": "mcp:search"
}
```
</Step>
<Step title="Connect to your MCP server">
Use the access token to authenticate requests to your MCP server. Pass the token in the `Authorization` header when connecting.
</Step>
</Steps>

To delete a client credential, navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard and click the delete icon next to the credential you want to remove. Deleted credentials are immediately revoked.

### Rate limits

To protect availability, Mintlify applies rate limits to MCP servers.
Expand Down
Loading