Skip to content

Document MCP support for partially authenticated docs #3865

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

Closed
mintlify wants to merge 1 commit into from
+1 −1
Closed

Document MCP support for partially authenticated docs #3865

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
2 changes: 1 addition & 1 deletion ai/model-context-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

- The AI application can proactively search your documentation while generating a response, not just when explicitly asked.
- The AI application determines when to use the search tool based on the context of the conversation and the relevance of your documentation.
- Each search (tool call) happens during the generation process, so the AI application searches up-to-date information from your documentation to generate its response.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L21 

Use parentheses judiciously.

<Tip>
Some AI tools like Claude support both MCP and Skills. MCP gives the AI access to your documentation content, while Skills instruct the AI how to use that content effectively. They're complementary. MCP provides the data and Skills provide the instructions.
Expand All @@ -44,7 +44,7 @@
## Access your MCP server

<Note>
MCP servers are only available for public documentation. Documentation behind end-user authentication cannot generate an MCP server.
MCP servers are only available for public content. If your site uses [authentication](/deploy/authentication-setup), only pages marked as [public](/deploy/authentication-setup#make-pages-public) are searchable through your MCP server. Documentation that is fully behind authentication without any public pages cannot generate an MCP server.
</Note>

Mintlify automatically generates an MCP server for your documentation and hosts it at your documentation URL with the `/mcp` path. For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.
Expand All @@ -66,8 +66,8 @@

| Scope | Limit | Description |
| :---- | :---- | :---------- |
| Per user (IP address) | 200 requests per hour | Limits how frequently a single user can search your documentation. |

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L69 

Use parentheses judiciously.
| Per documentation site (domain) | 1,000 requests per hour | Limits total searches across all users of your MCP server. |

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L70 

Use parentheses judiciously.

## Content filtering and indexing

Expand All @@ -81,7 +81,7 @@

By default, Mintlify only indexes pages included in your `docs.json` navigation for search through your MCP server.

Mintlify excludes [hidden pages](/organize/hidden-pages) (pages not in your navigation) from the search index unless you choose to index all pages. To include hidden pages in your MCP server's search results, add the `seo.indexing` property to your `docs.json`.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L84 

Use parentheses judiciously.

```json
"seo": {
Expand Down Expand Up @@ -232,7 +232,7 @@
4. Select **Add**.
</Step>
<Step title="Access the MCP server in your chat">
1. When using Claude, select the attachments button (the plus icon).

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L235 

Use parentheses judiciously.
2. Select the Mintlify MCP server.
3. Ask Claude a question about Mintlify.
</Step>
Expand Down