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/model-context-protocol.mdx
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,20 @@ 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 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.
12
12
13
13
Your MCP server exposes tools for AI applications to search your documentation and interact with your APIs.
14
14
15
+
### How MCP servers work
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.
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.
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.
Copy file name to clipboardExpand all lines: deploy/preview-deployments.mdx
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,3 +57,16 @@ By default, preview deployments are publicly accessible to anyone with the URL.
57
57
<imgsrc="/images/previews/preview-auth-light.png"alt="The preview authentication toggle in the Add-ons page"className="block dark:hidden" />
58
58
<imgsrc="/images/previews/preview-auth-dark.png"alt="The preview authentication toggle in the Add-ons page"className="hidden dark:block" />
59
59
</Frame>
60
+
61
+
## Troubleshooting preview deployments
62
+
63
+
If your preview deployment fails, try these troubleshooting steps.
64
+
65
+
-**View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures.
66
+
-**Check your configuration**:
67
+
- Invalid `docs.json` syntax
68
+
- Missing or incorrect file paths referenced in your navigation
69
+
- Invalid frontmatter in MDX files
70
+
- Broken image links or missing image files
71
+
-**Validate locally**: Run `mint dev` locally to catch build errors before pushing to the repository.
72
+
-**Check recent changes**: Review the most recent commits in your branch to identify what changes caused the build to fail.
Copy file name to clipboardExpand all lines: integrations/analytics/mixpanel.mdx
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,21 @@ Add the following to your `docs.json` file to send analytics to Mixpanel.
9
9
```json Analytics options in docs.json
10
10
"integrations": {
11
11
"mixpanel": {
12
-
"projectToken": "required"
12
+
"projectToken": "YOUR_MIXPANEL_PROJECT_TOKEN"
13
13
}
14
14
}
15
15
```
16
+
17
+
Replace `YOUR_MIXPANEL_PROJECT_TOKEN` with your Mixpanel project token. You can find this in your [Mixpanel project settings](https://mixpanel.com/settings/project).
18
+
19
+
## Tracked events
20
+
21
+
Mintlify automatically tracks the following user interactions:
22
+
23
+
- Page views
24
+
- Search queries
25
+
- Feedback submissions
26
+
- Context menu interactions
27
+
- Navigation clicks
28
+
29
+
If you're not seeing events in Mixpanel, ensure your project token is correct and that no content security policies are blocking the Mixpanel script.
Copy file name to clipboardExpand all lines: integrations/support/overview.mdx
+1-8Lines changed: 1 addition & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,11 +38,4 @@ horizontal
38
38
39
39
## Enabling support integrations
40
40
41
-
Integrate customer support widgets into your documentation. Add the `integrations` field to your `docs.json` file with your respective app ID.
42
-
43
-
```json
44
-
"integrations": {
45
-
"intercom": "APP_ID",
46
-
"frontchat": "CHAT_ID"
47
-
}
48
-
```
41
+
Integrate customer support widgets into your documentation. Add the `integrations` field to your `docs.json` file with your respective app ID or chat ID. See each integration's documentation for instructions on finding your ID.
Copy file name to clipboardExpand all lines: organize/navigation.mdx
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,12 @@ In the `navigation` object, `groups` is an array where each entry is an object t
94
94
95
95
### Default expanded state
96
96
97
-
Set `expanded: true` on a group to make it expanded by default in the navigation sidebar. This is useful for highlighting important sections or improving discoverability of key content.
97
+
Use the `expanded` property to control the default state of a group in the navigation sidebar.
98
+
99
+
-`expanded: true`: Group is expanded by default.
100
+
-`expanded: false` or omitted: Group is collapsed by default.
101
+
102
+
This is useful for highlighting important sections or improving discoverability of key content.
0 commit comments