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: ai-native.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ In addition to reading individual pages, users can chat with the [assistant](/ai
16
16
17
17
The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job).
18
18
19
-
[Autopilot](/ai/autopilot) monitors connected repositories and proactively suggests documentation updates when it identifies user-facing changes.
19
+
You can configure the agent to monitor connected repositories and proactively [suggest](/ai/suggestions) documentation updates when it identifies user-facing changes.
20
20
21
21
Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/claude-code), and [Windsurf](/guides/windsurf) to reference the Mintlify schema, your style guide, and best practices.
22
22
@@ -41,7 +41,7 @@ Select any of the following cards for more information.
The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, so users can find answers quickly and succeed with your product.
14
14
15
-
The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4.5. When users ask questions, the assistant:
15
+
The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Opus 4.5. When users ask questions, the assistant:
16
16
17
17
***Searches and retrieves** relevant content from your documentation to provide accurate answers.
18
18
***Cites sources** and provides navigable links to take users directly to referenced pages.
Copy file name to clipboardExpand all lines: ai/model-context-protocol.mdx
+9-121Lines changed: 9 additions & 121 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,19 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"
8
8
9
9
## About MCP servers
10
10
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 and OpenAPI specifications, preparing your content for the broader AI ecosystem where any MCP client (like Claude, Cursor, Goose, and others) can connect to your documentation and APIs.
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, and others) can connect to your documentation.
12
12
13
-
Your MCP server exposes tools for AI applications to search your documentation and interact with your APIs.
13
+
Your MCP server exposes a search tool for AI applications to query your documentation.
14
14
15
15
### How MCP servers work
16
16
17
-
When an MCP server is connected to an AI tool, the LLM can decide to use your documentation and API tools during response generation.
17
+
When an MCP server is connected to an AI tool, the LLM can decide to use your documentation search tool during response generation.
18
18
19
-
- The LLM can proactively search your documentation or call your API endpoints while generating a response, not just when explicitly asked.
20
-
- The LLM determines when to use tools based on the context of the conversation and the relevance of your documentation and APIs.
21
-
- Each tool call happens during the generation process, allowing the LLM to incorporate real-time information from your documentation and APIs into its response.
19
+
- The LLM can proactively search your documentation while generating a response, not just when explicitly asked.
20
+
- The LLM determines when to use the search tool based on the context of the conversation and the relevance of your documentation.
21
+
- Each tool call happens during the generation process, allowing the LLM to incorporate real-time information from your documentation into its response.
22
22
23
-
For example, if a user asks a coding question and the LLM determines that your API documentation is relevant, it can search your API documentation and include that information in the response without the user explicitly asking about your documentation.
23
+
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.
24
24
25
25
## Accessing your MCP server
26
26
@@ -34,96 +34,13 @@ You can see and copy your MCP server URL in your [dashboard](https://dashboard.m
34
34
35
35
The `/mcp` path is reserved for hosted MCP servers and cannot be used for other navigation elements.
36
36
37
-
## Configuring your MCP server
38
-
39
-
All MCP servers include the `search` tool by default, which allows users to query information from your docs in other tools.
40
-
41
-
If you have a [Pro or Custom plan](https://mintlify.com/pricing?ref=mcp), you can expose endpoints from your OpenAPI specification as MCP tools.
42
-
43
-
To expose endpoints as MCP tools, use the `mcp` object within the `x-mint` extension at either the file or endpoint level. For example, the Mintlify MCP server includes tools to create assistant chats, get status updates, and trigger updates.
44
-
45
-
MCP servers follow a security-first approach where API endpoints are not exposed by default. You must explicitly enable endpoints to make them available as MCP tools. Only expose endpoints that are safe for public access through AI tools.
46
-
47
-
<ResponseFieldname="mcp"type="object">
48
-
The MCP configuration for the endpoint.
49
-
50
-
<Expandabletitle="MCP">
51
-
<ResponseFieldname="enabled"type="boolean">
52
-
Whether to expose the endpoint as an MCP tool. Takes precedence over the file-level configuration.
53
-
</ResponseField>
54
-
<ResponseFieldname="name"type="string">
55
-
The name of the MCP tool.
56
-
</ResponseField>
57
-
<ResponseFieldname="description"type="string">
58
-
The description of the MCP tool.
59
-
</ResponseField>
60
-
</Expandable>
61
-
</ResponseField>
62
-
63
-
### File-level configuration
64
-
65
-
Enable MCP for all endpoints by default in an OpenAPI specification file and selectively exclude endpoints:
66
-
67
-
```json
68
-
{
69
-
"openapi": "3.1.0",
70
-
"x-mint": {
71
-
"mcp": {
72
-
"enabled": true
73
-
}
74
-
},
75
-
// ...
76
-
"paths": {
77
-
"/api/v1/users": {
78
-
"get": {
79
-
"x-mint": {
80
-
"mcp": {
81
-
"enabled": false// Disables MCP for this endpoint
82
-
}
83
-
},
84
-
// ...
85
-
}
86
-
}
87
-
}
88
-
}
89
-
```
90
-
91
-
### Endpoint-level configuration
92
-
93
-
Enable MCP for specific endpoints:
94
-
95
-
```json
96
-
{
97
-
"paths": {
98
-
"/api/v1/users": {
99
-
"get": {
100
-
"x-mint": {
101
-
"mcp": {
102
-
"enabled": true,
103
-
"name": "get-users",
104
-
"description": "Get a list of users"
105
-
},
106
-
// ...
107
-
}
108
-
}
109
-
},
110
-
"/api/v1/delete": {
111
-
"delete": {
112
-
// No `x-mint: mcp` so this endpoint is not exposed as an MCP tool
113
-
// ...
114
-
}
115
-
}
116
-
}
117
-
}
118
-
```
119
-
120
37
## Using your MCP server
121
38
122
39
Your users must connect your MCP server to their preferred AI tools.
123
40
124
41
1. Make your MCP server URL publicly available.
125
42
2. Users copy your MCP server URL and add it to their tools.
126
-
3. Users access your documentation and API endpoints through their tools.
43
+
3. Users access your documentation through their tools.
127
44
128
45
These are some of the ways you can help your users connect to your MCP server:
129
46
@@ -229,7 +146,7 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co
229
146
230
147
### Example: Connecting to the Mintlify MCP server
231
148
232
-
Connect to the Mintlify MCP server to interact with the Mintlify API and search our documentation. This will give you more accurate answers about how to use Mintlify in your local environment and demonstrates how you can help your users connect to your MCP server.
149
+
Connect to the Mintlify MCP server to search our documentation. This will give you more accurate answers about how to use Mintlify in your local environment and demonstrates how you can help your users connect to your MCP server.
233
150
234
151
<Tabs>
235
152
<Tabtitle="Contextual menu">
@@ -327,11 +244,7 @@ See the [VS Code documentation](https://code.visualstudio.com/docs/copilot/chat/
327
244
</Tab>
328
245
</Tabs>
329
246
330
-
## Authentication
331
-
332
-
When you enable an API endpoint for MCP, the server includes the authentication requirements defined in your OpenAPI `securitySchemes` and `securityRequirement`. Any keys are handled directly by the tool and not stored or processed by Mintlify.
333
247
334
-
If a user asks their AI tool to call a protected endpoint, the tool will request the necessary authentication credentials from the user at that moment.
335
248
336
249
## Monitoring your MCP server
337
250
@@ -342,29 +255,4 @@ You can view all available MCP tools in the **Available tools** section of the [
342
255
<imgsrc="/images/mcp/mcp-server-page-dark.png"alt="MCP dashboard with Available tools section emphasized"className="hidden dark:block" />
343
256
</Frame>
344
257
345
-
## Troubleshooting
346
-
347
-
<AccordionGroup>
348
-
<Accordiontitle="MCP server only shows search tool">
349
-
If your MCP server only exposes the search tool despite having an OpenAPI specification:
350
-
351
-
1. Verify your OpenAPI specification is valid and accessible.
352
-
2. Ensure you've explicitly enabled MCP for specific endpoints using `x-mint.mcp.enabled: true`.
353
-
3. Check your deployment logs for OpenAPI processing errors.
354
-
355
-
If OpenAPI processing fails, the server continues with just the search tool to maintain functionality.
356
-
</Accordion>
357
-
<Accordiontitle="Authentication issues">
358
-
If users report authentication problems:
359
-
360
-
1. Check that your OpenAPI specification includes proper `securitySchemes` definitions.
361
-
2. Confirm that enabled endpoints work with the specified authentication methods.
362
-
</Accordion>
363
-
<Accordiontitle="Tool descriptions missing or unclear">
364
-
If AI tools aren't using your API endpoints effectively:
365
258
366
-
1. Add detailed `summary` and `description` fields to your endpoints.
367
-
2. Ensure parameter names and descriptions are self-explanatory.
368
-
3. Use the MCP dashboard to verify how your endpoints appear as tools.
description: "Add a bot that searches your docs to answers questions in your Slack workspace."
4
-
keywords: ["Slack bot", "workspace", "questions"]
3
+
description: "Add a bot to your Slack workspace that answers questions based on your documentation."
4
+
keywords: ["bot", "workspace", "Q&A", "Slack"]
5
5
---
6
6
7
7
<Info>
8
-
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app).
8
+
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant.
9
9
</Info>
10
10
11
-
The Slack app adds a bot to your Slack workspace that can search your documentation and answer users' questions. The bot responds to direct messages, @mentions, and to any questions in a channel specifically named `#ask-ai`. The bot's name is `@yourprojectname-assistant`. So if your project name is Mintlify, the bot's name is `@mintlify-assistant`.
11
+
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
12
13
-
The Slack app can incur costs: either using your AI assistant credits or incurring overages.
13
+
The bot responds to `@` mentions and to every message in channels named `#ask-ai`.
14
+
15
+
Each message sent by the bot counts toward your assistant message usage.
14
16
15
17
## Set up the Slack app
16
18
17
19
<Note>
18
20
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it.
19
21
</Note>
20
22
21
-
1. Navigate to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard.
22
-
2. Select **Connect** in the Slack Integration card.
23
-
3. Follow the Slack prompts to add the app to your workspace.
24
-
4. Test that the bot is working and responds when you:
25
-
- Send a direct message to the bot.
26
-
- Mention the bot in a channel.
27
-
- Create an `#ask-ai` channel, add the bot, and ask a question.
23
+
1. Navigate to the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab of the **Assistant Configurations** page in your dashboard.
24
+
1. In the Slack card, click **Connect**. This opens Slack.
25
+
<Frame>
26
+
<imgsrc="/images/assistant/slack-connect-light.png"alt="The Connect button in the Slack card in light mode."className="block dark:hidden" />
27
+
<imgsrc="/images/assistant/slack-connect-dark.png"alt="The Connect button in the Slack card in dark mode."className="hidden dark:block" />
28
+
</Frame>
29
+
1. Follow the Slack prompts to add the app to your workspace.
30
+
1. Mention the bot to add it to a channel. The bot's default name is `@mintlify-assistant`.
31
+
32
+
### Customize the bot's name
33
+
34
+
1. In Slack, select the Mintlify app in the **Apps** menu.
35
+
1. Click **About**.
36
+
1. Click **Configuration**. This opens the app configuration page in a web browser.
37
+
1. In the **Bot User** section, edit the bot name.
38
+
39
+
## Create an `#ask-ai` channel
40
+
41
+
To help your users quickly get answers to their questions, create a channel named `#ask-ai`. The bot will respond to every message in that channel. See [Create a channel](https://slack.com/help/articles/201402297-Create-a-channel) in the Slack Help Center for more information.
42
+
43
+
## Manage the Slack app
44
+
45
+
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.
0 commit comments