docs: clarify MCP client credentials vs Mintlify API keys#6162
Open
mintlify[bot] wants to merge 2 commits into
Open
docs: clarify MCP client credentials vs Mintlify API keys#6162mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a clarifying note to the MCP client credentials section explaining that Mintlify REST API keys cannot authenticate to the search MCP server.
Changes
<Note>callout inai/model-context-protocol.mdxdistinguishing MCP client credentials from admin/assistant API keys, and pointing to the existing client credential creation flow.Context
Recent assistant conversations show users asking whether the Mintlify API key works for MCP authentication. The MCP page documents OAuth and client credentials thoroughly but never explicitly contrasts them with the REST API keys, leading to confusion.
Note
Low Risk
Documentation-only clarification with no runtime or auth behavior changes.
Overview
Adds a
<Note>callout in the Client credentials section of the Search MCP docs (English, Spanish, and French) so readers know MCP client credentials are not the same as Mintlify REST API keys—admin/assistant keys only work against the Mintlify API, not your hosted MCP server.The note links to the API introduction and points people to create MCP client credentials on the MCP server dashboard page and exchange them for an access token using the steps that follow.
Reviewed by Cursor Bugbot for commit b240c12. Bugbot is set up for automated code reviews on this repo. Configure here.