You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .claude/CLAUDE.md
+2-23Lines changed: 2 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,6 @@
1
1
# Mintlify documentation
2
2
3
-
You are an experienced, pragmatic technical writer with robust content strategy and content design experience. You elegantly create just enough docs to solve users' needs and get them back to the product quickly.
4
-
5
-
If you want an exception to ANY rule, YOU MUST STOP and get explicit permission first from the user.
6
-
7
-
## Working relationship
8
-
9
-
- ALWAYS ask for clarification rather than making assumptions
10
-
- NEVER lie, guess, or make up information
11
-
- Push back if something seems wrong or like it makes the documentation worse
12
-
- NEVER be agreeable just to be nice - I need your honest technical judgment.
13
-
- NEVER tell me I'm "absolutely right" or anything like that. You ARE NOT a sycophant.
14
-
- If you are making an inference, stop and ask for confirmation or say that you need more information
3
+
You are an experienced, pragmatic technical writer with robust content strategy and content design experience. You elegantly create just enough docs to solve users' needs and get them back to the product quickly. NEVER lie, guess, or make up information.
15
4
16
5
## Context and tool usage
17
6
@@ -45,7 +34,6 @@ For major documentation restructuring or complex multi-page changes:
45
34
## Content strategy
46
35
- We document just enough so that users are successful. Too much content makes it hard to find what people are looking for. Too little makes it too challenging to accomplish users' goals.
47
36
- Prioritize accuracy and usability of information
48
-
- Make content evergreen when possible
49
37
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
50
38
- Check existing patterns for consistency
51
39
- Start by making the smallest reasonable changes
@@ -114,23 +102,15 @@ For major documentation restructuring or complex multi-page changes:
114
102
- Structure content in the order users need it with most commonly needed information first and most specific information last
115
103
- Combine related information to reduce redundancy
116
104
117
-
## Git workflow
118
-
- NEVER use --no-verify when committing
119
-
- Ask how to handle uncommitted changes before starting
120
-
- Create a new branch when no clear branch exists for changes
121
-
- Commit frequently throughout development
122
-
- NEVER skip or disable pre-commit hooks
123
-
124
105
## Before submitting work
125
-
-[ ] Preview changes locally with `mint dev`
126
106
-[ ] Run `mint broken-links` to check internal links
127
107
-[ ] Manually test external links don't 404
128
108
-[ ] Run `vale $(git diff --name-only main)` to check style and spelling
129
109
-[ ] Verify all code blocks have language tags
130
110
-[ ] Confirm frontmatter includes title, description, keywords
131
111
-[ ] Check formatting matches similar existing pages
132
112
-[ ] Read changes aloud to catch awkward phrasing
133
-
- List any uncertain areas that need extra review
113
+
-[ ]List any uncertain areas that need extra review
When you create a PR to update docs, only update English language files. Do not update any content in the `es/`, `fr/`, or `zh/` directories. A workflow handles all translations after a docs PR merges to production.
Copy file name to clipboardExpand all lines: ai/assistant.mdx
+2-8Lines changed: 2 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,15 +21,15 @@ The assistant uses agentic RAG (retrieval-augmented generation) with tool callin
21
21
***Generates copyable code examples** to help users implement solutions from your documentation.
22
22
***Supports multiple modalities** by allowing users to add text, images, and other files as context.
23
23
24
-
You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:
24
+
View assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:
25
25
26
26
* Frequently asked questions that might need better coverage.
27
27
* Content gaps where users struggle to find answers.
28
28
* Popular topics that could benefit from additional content.
29
29
30
30
### How indexing works
31
31
32
-
The assistant automatically indexes your published documentation and API specifications to answer questions accurately. When you publish changes, the assistant immediately indexes new, updated, or deleted content. The assistant does not index draft branches or preview deployments.
32
+
The assistant indexes your published documentation and API specifications to answer questions accurately. When you publish changes, the assistant immediately indexes new, updated, or deleted content. The assistant does not index draft branches or preview deployments.
33
33
34
34
By default, the assistant does not index hidden pages. To include hidden pages in the assistant's index, set `seo.indexing: "all"` in your `docs.json`. See [Hidden pages](/organize/hidden-pages#search-seo-and-ai-indexing) for more information.
35
35
@@ -171,10 +171,6 @@ If you want to disallow overages, disable them in the **Billing Controls** secti
171
171
172
172
In the Billing Controls section, set usage alerts to receive an email when you reach a certain percentage of your message allowance.
173
173
174
-
## Connect apps
175
-
176
-
In the connect apps section, add the assistant to your [Discord](/ai/discord) server and [Slack](/ai/slack-bot) workspace to allow users to get answers from your documentation on those platforms.
177
-
178
174
## Assistant insights
179
175
180
176
Use assistant insights to understand how users interact with your documentation and identify improvement opportunities.
@@ -206,8 +202,6 @@ Structure your documentation to help the assistant provide accurate, relevant an
206
202
207
203
Users have multiple ways to start a conversation with the assistant. Each method opens a chat panel on the right side of your docs. Users can ask any question and the assistant searches your documentation for an answer. If the assistant cannot retrieve relevant information, the assistant responds that it cannot answer the question.
208
204
209
-
Add the assistant as a bot to your [Slack workspace](/ai/slack-bot) or [Discord server](/ai/discord) so that your community can ask questions without leaving their preferred platform.
210
-
211
205
### UI placement
212
206
213
207
The assistant appears in two locations: as a button next to the search bar and as a bar at the bottom of the page.
Discord integrations are available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=discord) with access to the assistant.
9
-
</Info>
7
+
<Warning>
8
+
The Discord bot is deprecated.
9
+
10
+
New Discord bot installations are not available. Existing Discord bot integrations continue to work.
11
+
</Warning>
10
12
11
13
The Discord bot supports your community with real-time answers from your documentation. The bot uses the Mintlify assistant to search your docs and provide accurate, cited responses, so it is always up-to-date.
12
14
13
15
The Discord bot only works in public channels. It replies to `@` mentions or to all messages in a specific channel.
14
16
15
17
Each message sent by the Discord bot counts toward your assistant message usage.
16
18
17
-
## Add the Discord bot to your server
18
-
19
-
<Note>
20
-
You must have the "Manage Server" permission in Discord to add the bot.
21
-
</Note>
22
-
23
-
1. Navigate to the [Assistant](https://dashboard.mintlify.com/products/assistant) page in your dashboard.
24
-
1. In the Discord card, click **Configure**. This opens Discord.
25
-
<Frame>
26
-
<imgsrc="/images/assistant/connected-apps-light.png"alt="The connected apps section of the assistant page."className="block dark:hidden" />
27
-
<imgsrc="/images/assistant/connected-apps-dark.png"alt="The connected apps section of the assistant page."className="hidden dark:block" />
28
-
</Frame>
29
-
1. In Discord, select the server you want to add the bot to.
30
-
1. Authorize the bot to access your server.
31
-
1. Mention the bot to add it to a channel. The bot's default name is `@Mintlify Bot`.
32
-
33
19
## Create an `#ask-ai` channel
34
20
35
21
To help your community quickly get answers to their questions, the bot can reply to every message in a channel that you choose. By default, the bot replies to every message in channels named `#ask-ai`. Create an `#ask-ai` channel and let your community know that the bot replies to messages in that channel.
36
22
37
-
If you want the bot to reply to messages in a different channel, select a channel in the Discord bot [configuration menu](https://dashboard.mintlify.com/products/assistant/settings/integrations).
38
-
39
-
<Frame>
40
-
<imgsrc="/images/assistant/discord-configure-light.png"alt="The Discord configuration panel in light mode."className="block dark:hidden" />
41
-
<imgsrc="/images/assistant/discord-configure-dark.png"alt="The Discord configuration panel in dark mode."className="hidden dark:block" />
42
-
</Frame>
43
-
44
23
See [Starting Your First Discord Server](https://discord.com/blog/starting-your-first-discord-server) on the Discord blog for more information on creating a channel.
45
-
46
-
## Manage the Discord bot
47
-
48
-
After you add the Discord bot to your server, you can manage or remove the bot from the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab in your dashboard.
49
-
50
-
In the Discord bot configuration menu, customize the bot by changing its avatar or name, and choose which channel it automatically replies to all messages in.
Copy file name to clipboardExpand all lines: ai/llmstxt.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,8 @@ Mintlify automatically hosts an `llms.txt` file at the root of your project that
12
12
13
13
<Note>
14
14
If your site requires authentication, `llms.txt` and `llms-full.txt` also require authentication to view. LLMs and AI tools that cannot authenticate into your site cannot access these files. The files exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).
15
+
16
+
For more information on how authentication affects AI features, see [Feature availability](/deploy/authentication-setup#feature-availability).
15
17
</Note>
16
18
17
19
View your `llms.txt` by appending `/llms.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms.txt` for compatibility with tools that follow the `.well-known` convention.
Copy file name to clipboardExpand all lines: ai/model-context-protocol.mdx
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,20 +10,29 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"
10
10
11
11
The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. Mintlify generates an MCP server from your documentation, preparing your content for the broader AI ecosystem where any MCP client like Claude, Cursor, Goose, ChatGPT, and others can connect to your documentation.
12
12
13
-
Your MCP server exposes a search tool for AI applications to query your documentation. Your users must connect your MCP server to their tools.
13
+
Your MCP server exposes tools for AI applications to search your documentation and retrieve full page content. Your users must connect your MCP server to their tools.
14
14
15
15
### How MCP servers work
16
16
17
-
When an AI application connects to your documentation MCP server, it can search your documentation directly in response to a user's prompt instead of relying on information from its training data or making a generic web search. Your MCP server provides access to all indexed content on your documentation site.
17
+
When an AI application connects to your documentation MCP server, it can search your documentation and retrieve full page content directly in response to a user's prompt instead of relying on information from its training data or making a generic web search. Your MCP server provides access to all indexed content on your documentation site.
18
18
19
19
- AI applications can proactively search your documentation while generating a response even if not explicitly asked to search your documentation for an answer.
20
-
- AI applications determine when to use the search tool based on the context of the conversation and the relevance of your documentation.
21
-
- Each search, also known as a tool call, happens during the generation process, so the AI application searches up-to-date information from your documentation to generate its response.
20
+
- AI applications determine when to use the available tools based on the context of the conversation and the relevance of your documentation.
21
+
- Each tool call happens during the generation process, so the AI application uses up-to-date information from your documentation to generate its response.
22
22
23
23
<Tip>
24
24
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.
25
25
</Tip>
26
26
27
+
### MCP tools
28
+
29
+
Your MCP server provides two tools that AI applications can use:
30
+
31
+
-**Search**: Searches across your documentation to find relevant content, returning snippets with titles and links. Use this when you need to discover information or find pages matching a query.
32
+
-**Get page**: Retrieves the full content of a specific documentation page by its path. Use this when you already know the page path, such as from search results, and need the complete content rather than a snippet.
33
+
34
+
AI applications determine when to use each tool based on the context of the conversation. For example, an AI application might first search your documentation to find relevant pages, then use the get page tool to retrieve the full content of the most relevant result.
35
+
27
36
### Search parameters
28
37
29
38
The MCP search tool supports optional parameters that AI applications use to control and refine search results.
@@ -35,6 +44,12 @@ The MCP search tool supports optional parameters that AI applications use to con
35
44
36
45
AI applications determine when to apply these parameters based on the context of the user's query. For example, if a user asks about a specific API version, the AI application may automatically apply the appropriate filter to provide more relevant results.
37
46
47
+
### Get page parameters
48
+
49
+
The get page tool accepts one required parameter:
50
+
51
+
-**`page`**: The page path to retrieve, such as `'api-reference/create-customer'`. Use page paths returned from search results.
52
+
38
53
### MCP compared to web search
39
54
40
55
AI tools can search the web, but MCP provides distinct advantages for documentation.
@@ -96,7 +111,10 @@ To protect availability, Mintlify applies rate limits to MCP servers.
96
111
| Scope | Limit | Description |
97
112
| :---- | :---- | :---------- |
98
113
| Per user (IP address) | 5,000 requests per hour | Limits how frequently a single user can query your MCP server configuration. |
99
-
| Per documentation site (domain) | 10,000 requests per hour | Limits total searches across all users of your MCP server. |
114
+
| Search per documentation site (domain) | 10,000 requests per hour | Limits total search tool calls across all users of your MCP server. |
115
+
| Get page per documentation site (domain) | 10,000 requests per hour | Limits total get page tool calls across all users of your MCP server. |
116
+
| Authenticated search per documentation site (domain) | 5,000 requests per hour | Limits total authenticated search tool calls across all users of your MCP server. |
117
+
| Authenticated get page per documentation site (domain) | 5,000 requests per hour | Limits total authenticated get page tool calls across all users of your MCP server. |
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant.
9
-
</Info>
7
+
<Warning>
8
+
The Slack bot is deprecated.
9
+
10
+
New Slack bot installations are not available. Existing Slack bot integrations continue to work.
11
+
</Warning>
10
12
11
13
The Slack app adds a bot to your workspace that supports your community with real-time answers. The bot uses the Mintlify assistant to search your docs and provide accurate, cited responses, so it is always up-to-date.
12
14
@@ -16,36 +18,6 @@ The bot responds to `@` mentions or to all messages in a specific channel that y
16
18
17
19
Each message sent by the bot counts toward your assistant message usage.
18
20
19
-
## Set up the Slack app
20
-
21
-
<Note>
22
-
You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one deployment at a time to a workspace. You must disconnect the app from one deployment before connecting it to another.
23
-
</Note>
24
-
25
-
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it.
26
-
27
-
1. Navigate to the [Assistant](https://dashboard.mintlify.com/products/assistant) page in your dashboard.
28
-
1. In the Slack card, click **Configure**. This opens Slack.
29
-
<Frame>
30
-
<imgsrc="/images/assistant/connected-apps-light.png"alt="The connected apps section of the assistant page."className="block dark:hidden" />
31
-
<imgsrc="/images/assistant/connected-apps-dark.png"alt="The connected apps section of the assistant page."className="hidden dark:block" />
32
-
</Frame>
33
-
1. Follow the Slack prompts to add the app to your workspace.
34
-
1. Mention the bot to add it to a channel. The bot's default name is `@mintlify-assistant`.
35
-
36
21
## Create an `#ask-ai` channel
37
22
38
23
To help your users quickly get answers to their questions, the bot can reply to every message in a channel that you choose. By default, the bot replies to every message in channels named `#ask-ai`. Create an `#ask-ai` channel and let your users know that the bot replies to messages in that channel. See [Create a channel](https://slack.com/help/articles/201402297-Create-a-channel) in the Slack Help Center for more information.
39
-
40
-
If you want the bot to reply to messages in a different channel, select a channel in the Slack bot [configuration menu](https://dashboard.mintlify.com/products/assistant/settings/integrations).
41
-
42
-
<Frame>
43
-
<imgsrc="/images/assistant/slack-configure-light.png"alt="The Slack configuration panel in light mode."className="block dark:hidden" />
44
-
<imgsrc="/images/assistant/slack-configure-dark.png"alt="The Slack configuration panel in dark mode."className="hidden dark:block" />
45
-
</Frame>
46
-
47
-
## Manage the Slack app
48
-
49
-
After you add the app to your workspace, you can manage or remove the app from the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab.
50
-
51
-
In the Slack bot configuration menu, customize the bot by changing its avatar or name, and choose which channel it automatically replies to all messages in.
0 commit comments