Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@

When an AI tool like Claude, Cursor, or ChatGPT has your documentation MCP server connected, the AI tool can search your documentation directly during response generation rather than doing a generic web search.

- The LLM can proactively search your documentation while generating a response, not just when explicitly asked.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L19

Spell out 'LLM', if it's unfamiliar to the audience.
- The LLM determines when to use the search tool based on the context of the conversation and the relevance of your documentation.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L20

Spell out 'LLM', if it's unfamiliar to the audience.
- Each tool call happens during the generation process, allowing the LLM to incorporate real-time information from your documentation into 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

Spell out 'LLM', if it's unfamiliar to the audience.

For example, if a user asks a coding question and the LLM determines that your documentation is relevant, it can search your documentation and include that information in the response without the user explicitly asking about your documentation.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L23

Spell out 'LLM', if it's unfamiliar to the audience.

## Access your MCP server

<Note>
MCP servers are only available for public documentation. Documentation behind end-user authentication cannot generate an MCP server.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L28

Use 'can't' instead of 'cannot'.
</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 @@ -38,9 +38,39 @@
</Frame>

<Note>
Hosted MCP servers use the `/mcp` path in their URLs. Other navigation elements cannot use the `/mcp` path.

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 'can't' instead of 'cannot'.
</Note>

## Content filtering and indexing

Your MCP server searches content that Mintlify indexes from your documentation repository. File processing and search indexing control what content is available through your MCP server.

### File processing with `.mintignore`

If files match [.mintignore](/organize/mintignore) patterns, Mintlify does not process or index them. These files are not available through your MCP server.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L50

Use 'doesn't' instead of 'does not'.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L50

Use 'aren't' instead of 'are not'.

### Search indexing with `docs.json`

After Mintlify processes files, it determines which pages to index for search. By default, only pages included in your `docs.json` navigation are indexed and searchable through your MCP server.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L54

In general, use active voice instead of passive voice ('are indexed').

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 56 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L56

Use parentheses judiciously.

```json
"seo": {
"indexing": "all"
}
```

To exclude a specific page from search indexing, add `noindex: true` to its frontmatter.

```mdx
---
title: "Hidden page"
description: "This page is not in the navigation, but is available through search."
noindex: true
---
```

## Use your MCP server

Your users must connect your MCP server to their preferred AI tools.
Expand Down Expand Up @@ -173,7 +203,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 206 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L206

Use parentheses judiciously.
2. Select the Mintlify MCP server.
3. Ask Claude a question about Mintlify.
</Step>
Expand Down
7 changes: 4 additions & 3 deletions organize/mintignore.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: "Mintignore"
description: "Exclude specific files and directories from your published documentation."
title: "Exclude files from publishing"
sidebarTitle: "Exclude files"
description: "Exclude specific files and directories from your published documentation with a `.mintignore` file."
keywords: ["exclude", "ignore", "gitignore", "drafts", "private"]
---

The `.mintignore` file allows you to exclude specific files and directories from being processed and published to your documentation site.
The `.mintignore` file allows you to exclude specific files and directories in your documentation repository from being processed and published to your documentation site.

Check warning on line 8 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L8

In general, use active voice instead of passive voice ('being processed').

Use `.mintignore` to keep drafts, internal notes, and source files out of your public documentation while maintaining them in your repository.

Expand All @@ -31,7 +32,7 @@
- Don't appear in your published documentation.
- Aren't indexed for search.
- Aren't accessible to visitors.
- Are ignored by [broken link checks](/installation#find-broken-links). Links that point to ignored files are broken.

Check warning on line 35 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L35

In general, use active voice instead of passive voice ('Are ignored').

Check warning on line 35 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L35

In general, use active voice instead of passive voice ('are broken').

## Default ignored patterns

Expand All @@ -48,7 +49,7 @@

<Note>
Unlike [hidden pages](/organize/hidden-pages), files excluded by `.mintignore`
are completely removed from your site and cannot be accessed by URL.

Check warning on line 52 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L52

Use 'can't' instead of 'cannot'.

Check warning on line 52 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L52

In general, use active voice instead of passive voice ('be accessed').
</Note>

## Pattern syntax
Expand All @@ -61,4 +62,4 @@
| `*.draft.mdx` | Excludes all files ending in `.draft.mdx` |
| `private-notes.md` | Excludes a specific file |
| `**/internal/**` | Excludes any `internal` directory at any level |
| `!important.mdx` | Negates a previous pattern (includes the file) |

Check warning on line 65 in organize/mintignore.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/mintignore.mdx#L65

Use parentheses judiciously.