diff --git a/agent/index.mdx b/agent/index.mdx index abb201cdf8..139e57bbcf 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -70,7 +70,7 @@ Contact Mintlify about the deployment that you want to enable static agent egres ## Use AI tools alongside the agent -The agent works asynchronously through pull requests, but you can also use AI coding tools like Cursor or Claude Code locally for fast, iterative edits. Install the Mintlify [skill](/ai/skillmd) and connect the [MCP server](/ai/model-context-protocol) so your editor has the same context the agent uses. +The agent works asynchronously through pull requests, but you can also use AI coding tools like Cursor or Claude Code locally for fast, iterative edits. Install the Mintlify [skill](/ai/skillmd) and connect the [Model Context Protocol (MCP) server](/ai/model-context-protocol) so your editor has the same context the agent uses. To let an external agent edit your content directly through MCP tool calls, connect it to the [Mintlify MCP server](/ai/mintlify-mcp). diff --git a/ai-native.mdx b/ai-native.mdx index 6606049d52..99876e4246 100644 --- a/ai-native.mdx +++ b/ai-native.mdx @@ -37,7 +37,7 @@ Mintlify hosts `llms.txt` and `skill.md` files for your documentation. These ind ``` -Your documentation site also hosts an MCP server that lets users connect your documentation directly to their AI tools for up-to-date information about your product directly where they want it. +Your documentation site also hosts a Model Context Protocol (MCP) server that lets users connect your documentation directly to their AI tools for up-to-date information about your product directly where they want it. For implementation questions that span multiple products or require web search, [Mintlify Index](/search-index) gives coding agents one MCP server and REST API for retrieving context from publisher-maintained documentation and the web. diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index 550fd15f33..cb0c884133 100644 --- a/ai/contextual-menu.mdx +++ b/ai/contextual-menu.mdx @@ -10,7 +10,7 @@ import IconsRequired from "/snippets/icons-required.mdx"; The contextual menu provides quick access to AI-optimized content and direct integrations with popular AI tools. When users click the contextual menu on any page, they can copy content as context for AI tools or open it in an AI conversation. Supported tools include ChatGPT, Claude, Perplexity, Google AI Studio, Grok, Devin, Devin Desktop, and any custom tool you configure. - Pair the contextual menu with your hosted [`skill.md`](/ai/skillmd) file and [MCP server](/ai/model-context-protocol). This lets users install your product's full capabilities into their AI tools, not just the page they are reading. + Pair the contextual menu with your hosted [`skill.md`](/ai/skillmd) file and [Model Context Protocol (MCP) server](/ai/model-context-protocol). This lets users install your product's full capabilities into their AI tools, not just the page they are reading. ## Menu options diff --git a/ai/mintlify-mcp.mdx b/ai/mintlify-mcp.mdx index e6a665d03e..e99dd42593 100644 --- a/ai/mintlify-mcp.mdx +++ b/ai/mintlify-mcp.mdx @@ -7,7 +7,7 @@ keywords: ["MCP", "write access", "AI", "editing", "Claude", "ChatGPT", "Cursor" ## About the admin MCP -The admin MCP server gives AI tools write access to your Mintlify content and settings. Use it to update content and access your dashboard. With the admin MCP, you can use your preferred AI tools to edit pages, restructure navigation, update `docs.json`, open pull requests, change settings, create workflows, and more. +The admin Model Context Protocol (MCP) server gives AI tools write access to your Mintlify content and settings. Use it to update content and access your dashboard. With the admin MCP, you can use your preferred AI tools to edit pages, restructure navigation, update `docs.json`, open pull requests, change settings, create workflows, and more. Connect any MCP client like Claude, Claude Code, ChatGPT, or Cursor to the admin MCP server to collaborate on your Mintlify content and settings with the same tools you use to write code. When you use the admin MCP server, all changes happen on a branch and require a pull request to merge. If your organization has multiple deployments, a single admin MCP connection can access and switch between all of them. diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 41b4f22b86..b5d8d757bc 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -62,7 +62,7 @@ AI tools can search the web, but the search MCP provides distinct advantages. - **Direct source access**: Web search depends on what search engines have indexed, which may be stale or incomplete. The search MCP searches your current indexed content directly. - **Integrated workflow**: MCP allows the AI to search during response generation rather than performing a separate web search. -- **No search noise**: SEO and ranking algorithms influence web search results. MCP goes straight to your content. +- **No search noise**: Search Engine Optimization (SEO) and ranking algorithms influence web search results. MCP goes straight to your content. ## Access your search MCP server diff --git a/api/introduction.mdx b/api/introduction.mdx index 5781adc490..ee9d23ec23 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -47,7 +47,7 @@ The Mintlify REST (Representational State Transfer) API enables you to programma ## Authentication -Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin and Index API keys belong to an organization-you can use the same keys across multiple deployments withing the same organization. Assistant API keys belong to the deployment where you create them. +Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin and Index API keys belong to an organization. You can use the same keys across multiple deployments within the same organization. Assistant API keys belong to the deployment where you create them. You can create up to 10 API keys per hour per organization. @@ -113,7 +113,7 @@ The Index API key is a server-side secret. Do not expose it in client-side code. ### Restrict keys by IP address -Optionally restrict an API key to a list of allowed IP addresses or CIDR ranges. When a key has an allowlist, requests from any other IP address return a `403` response. Admin, assistant, and Index API keys support allowlists. +Optionally restrict an API key to a list of allowed IP addresses or Classless Inter-Domain Routing (CIDR) ranges. When a key has an allowlist, requests from any other IP address return a `403` response. Admin, assistant, and Index API keys support allowlists. Set the allowlist when you create a key on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. You set the allowlist for the lifetime of the key when you create it. To change the allowlist, you must create a new key. If you don't set an allowlist, the key accepts requests from any IP address. @@ -124,7 +124,7 @@ Allowlist entries support: You cannot use catch-all entries like `0.0.0.0/0` and `::/0`. -Use IP allowlists when a stable set of egress IPs call your API key. For example, a CI/CD runner, a static NAT gateway, or your backend server. Avoid allowlists for keys used from developer laptops or other environments with changing IPs. +Use IP allowlists when a stable set of egress IPs call your API key. For example, a CI/CD runner, a static Network Address Translation (NAT) gateway, or your backend server. Avoid allowlists for keys used from developer laptops or other environments with changing IPs. ### Restrict admin keys by scope @@ -151,4 +151,4 @@ Set the expiration on the [API keys page](https://app.mintlify.com/settings/orga The expiration must be a future ISO 8601 timestamp. Past or invalid timestamps return a `400` response at key creation. The expiration returns as `expiresAt` when you list keys, or `null` for keys with no expiration. -Use expirations for short-lived credentials, such as CI/CD tokens, external contractors, or one-off scripts. Rotate long-lived keys by creating a replacement, updating your integrations, and deleting the old key. +Use expiration dates for short-lived credentials, such as CI/CD tokens, external contractors, or one-off scripts. Rotate long-lived keys by creating a replacement, updating your integrations, and deleting the old key. diff --git a/api/search-index/introduction.mdx b/api/search-index/introduction.mdx index 623547045a..41fe9e3840 100644 --- a/api/search-index/introduction.mdx +++ b/api/search-index/introduction.mdx @@ -12,7 +12,7 @@ Use the Mintlify Index REST API to retrieve technical knowledge for applications - [`contents`](/api/search-index/contents) retrieves content for selected Mintlify result IDs or result URLs. - The REST API requires an API key for your organization. The public [Index MCP server](/search-index/mcp) does not require an API key. + The REST API requires an API key for your organization. The public [Index server](/search-index/mcp), which uses the Model Context Protocol (MCP), does not require an API key. ## Base URL @@ -80,7 +80,7 @@ REST API limits apply per Mintlify organization. All API keys in an organization | Per second | 10 requests | | Per day | 1,000 requests | -Requests exceeding either limit return `429 Too Many Requests`. Use exponential backoff before retrying. +Requests exceeding either limit return `429 Too Many Requests`. Wait increasingly longer between retries. ## Errors diff --git a/api/static-export/overview.mdx b/api/static-export/overview.mdx index 97e049bfab..4cdf559c15 100644 --- a/api/static-export/overview.mdx +++ b/api/static-export/overview.mdx @@ -8,7 +8,7 @@ keywords: ["static export", "static site", "bundle", "self-host", "enterprise"] Static export is in private beta and requires an enterprise agreement. Please contact [sales@mintlify.com](mailto:sales@mintlify.com) to inquire further. -Use the static export API to programmatically pre-render your site into a self-contained set of static files and download the result as a single bundle. The exported bundle is pure HTML, CSS, and JavaScript with no runtime dependencies, so you can host it on any static file storage or CDN. +Use the static export API to programmatically pre-render your site into a self-contained set of static files and download the result as a single bundle. The exported bundle is pure HTML, CSS, and JavaScript with no runtime dependencies, so you can host it on any static file storage or a Content Delivery Network (CDN). ## How static export works diff --git a/assistant/configure.mdx b/assistant/configure.mdx index e21e5f6247..247410542b 100644 --- a/assistant/configure.mdx +++ b/assistant/configure.mdx @@ -26,12 +26,12 @@ Enter one or both of the following addresses: When you enable deflection and the assistant detects a matching question, an in-chat contact form appears. The form asks for the user's first name, last name, company, company email, and a message. Mintlify emails the submission to the appropriate team, which can respond directly to the user's email. -The same contact form is available in the [assistant widget](/assistant/widget) embedded on other sites. No extra widget configuration is required. +The same contact form is available in the [assistant widget](/assistant/widget) embedded on other sites. You don't need extra widget configuration. If you prefer to route support questions to your existing support channels instead, disable the **Contact form** in the Response handling section. -When you disable the contact form, the assistant directs users to your support email address in plain text instead of showing the in-chat form. Sales questions still use the in-chat form when a sales email is configured. +When you disable the contact form, the assistant directs users to your support email address in plain text instead of showing the in-chat form. Sales questions still use the in-chat form when you configure a sales email. ## Search domains diff --git a/assistant/widget.mdx b/assistant/widget.mdx index 01039cb46f..ca0207e4a4 100644 --- a/assistant/widget.mdx +++ b/assistant/widget.mdx @@ -10,7 +10,7 @@ import { AssistantWidgetPlayground } from "/snippets/assistant-widget-playground export const WidgetCodeBlock = ({ children, ...props }) => ( {children} -); +) The [assistant](/assistant) answers questions on your Mintlify site. To embed the same capability on another site or web app, use the widget. With the widget, you can give your users access to AI chat trained on your content in your product dashboard, marketing site, support portal, or elsewhere. @@ -172,7 +172,7 @@ Pass this object to `init()`. | `id` | string | Public widget ID from the Mintlify dashboard. | | `endpoint` | string | Overrides the hosted widget API endpoint. | | `identity` | string | Signed end-user identity token. Omit for anonymous visitors. | -| `nonce` | string | CSP nonce copied to resources created by the widget. | +| `nonce` | string | Content Security Policy (CSP) nonce copied to resources created by the widget. | | `defaultOpen` | boolean | Opens the widget on its first initialization. The default is `false`. | | `appearance` | [`AssistantAppearance`](#assistantappearance) | Visual and presentation overrides. | | `labels` | [`AssistantLabels`](#assistantlabels) | Customer-facing text overrides. | @@ -294,6 +294,6 @@ If your site uses a Content Security Policy, allow the origins required by your | `script-src` | `https://js.hcaptcha.com` | hCaptcha bot protection | | `connect-src` and `frame-src` | `https://*.hcaptcha.com` | hCaptcha bot protection | -A strict `script-src` policy must still authorize both the loader and initialization script. A strict `style-src` policy must authorize the nonce you pass to `init()`, which the widget copies to its injected stylesheet. Passing `nonce` to `init()` propagates it only to resources the widget creates after initialization. +A strict `script-src` policy must still authorize both the loader and initialization script. A strict `style-src` policy must authorize the nonce you pass to `init()`, which the widget copies to its injected style sheet. Passing `nonce` to `init()` propagates it only to resources the widget creates after initialization. diff --git a/automations/manage.mdx b/automations/manage.mdx index 0a0784aa43..1781b16482 100644 --- a/automations/manage.mdx +++ b/automations/manage.mdx @@ -135,9 +135,9 @@ Each automation keeps a log of past runs, including the status and a summary of Each run shows one of the following statuses: -- **Review needed**: The agent finished the run, but the changes must be reviewed and merged by someone on your team. +- **Review needed**: The agent finished the run, but someone on your team must review and merge the changes. - **Running**: The agent is actively working on the automation job. -- **Accepted**: The agent finished the run and the changes merged into your repository. +- **Accepted**: The agent finished the run, and the changes are now in your repository. - **Closed**: The agent finished the run, but someone rejected the changes. - **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit. - **No action needed**: The agent finished the run but did not find anything to update. diff --git a/cli/commands.mdx b/cli/commands.mdx index d4485a4046..3f8eb782b1 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -126,7 +126,7 @@ mint add-domain [--basePath ] The command uses your configured subdomain from `mint config`. If you do not have a configured subdomain, it uses the first subdomain on your account. -After registering the domain, the CLI waits up to 10 seconds for DNS records to generate, then prints the `TXT` and `CNAME` records to add at your domain provider: +After registering the domain, the CLI waits up to 10 seconds for Domain Name System (DNS) records to generate, then prints the `TXT` and `CNAME` records to add at your domain provider: ```text TXT _acme-challenge → @@ -134,7 +134,7 @@ TXT _cf-custom-hostname → CNAME @ → cname.mintlify.builders ``` -Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details. +Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and Transport Layer Security (TLS) provisioning details. If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values. @@ -415,7 +415,7 @@ The score evaluates the following areas: | `skillMd` | Agents can reach a [skill.md](https://www.mintlify.com/docs/ai/skillmd) file for agent tool use. | | `contentNegotiationMarkdown` | The site returns Markdown when agents request it through content negotiation. | | `contentNegotiationPlaintext` | The site returns plain text when agents request it through content negotiation. | -| `mcpServerDiscoverable` | Agents can discover an [MCP server](/ai/model-context-protocol) for tool-based agents. | +| `mcpServerDiscoverable` | Agents can discover a [Model Context Protocol (MCP) server](/ai/model-context-protocol) for tool-based agents. | | `mcpToolCount` | The MCP server exposes at least one tool. | | `openApiSpec` | There is an available OpenAPI or Swagger specification at a standard path. | | `robotsTxtAllowsAI` | The `robots.txt` file does not block AI crawlers. | @@ -472,7 +472,7 @@ mint deslop docs/guide.mdx --fix-whitespace ## `mint format` -Format every `.mdx` file in the current directory to Mintlify's canonical style. The command parses each file with the same MDX parser the web editor uses, then rewrites it in place if the canonical output differs. +Format every Markdown JSX (`.mdx`) file in the current directory to Mintlify's canonical style. The command parses each file with the same MDX parser the web editor uses, then rewrites it in place if the canonical output differs. ```bash mint format @@ -484,7 +484,7 @@ Run the command from the root of your docs project. It walks every subdirectory, `mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff. -When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting. +When it finishes, the command prints the number of MDX files it reformatted and the number that failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting. --- diff --git a/cli/index.mdx b/cli/index.mdx index dac40af0d6..58ccb60141 100644 --- a/cli/index.mdx +++ b/cli/index.mdx @@ -39,14 +39,14 @@ Run `mint score` to evaluate how well agents can navigate a documentation site. ### Detect AI-sounding prose Run `mint deslop` to check pages for AI-generated prose and get human-style rewrite suggestions. With no arguments, the command checks the pages you have changed. It flags the specific passages that read as AI-generated so you can revise them. -### Format MDX files +### Format Markdown (MDX) files Run `mint format` to rewrite the MDX files in your project to Mintlify's canonical style. The command walks every subdirectory and reformats files in place. ### Manage configuration Run `mint config` to set persistent defaults like your documentation subdomain. - Working on your docs locally with an AI coding tool? Install the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) so your editor has the context it needs to write Mintlify-aware content. + Working on your docs locally with an AI coding tool? Install the Mintlify [skill](/ai/skillmd) and [Model Context Protocol (MCP) server](/ai/model-context-protocol) so your editor has the context it needs to write Mintlify-aware content. diff --git a/cli/install.mdx b/cli/install.mdx index e8fbba5be1..8e3ec6a61a 100644 --- a/cli/install.mdx +++ b/cli/install.mdx @@ -115,7 +115,7 @@ If `mint update` is not available on your version, reinstall the CLI with the la ## Formatting -For syntax highlighting and code formatting in MDX files, use the following extensions: +For syntax highlighting and code formatting in Markdown (MDX) files, use the following extensions: - **Cursor, Devin Desktop, VS Code**: [MDX VS Code extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - **JetBrains**: [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) and [Prettier](https://prettier.io/docs/webstorm) diff --git a/create/personalization.mdx b/create/personalization.mdx index dd6a96fc55..0dc180d267 100644 --- a/create/personalization.mdx +++ b/create/personalization.mdx @@ -25,7 +25,7 @@ Automatically populate API playground fields with user-specific values by return The field names must match the names defined in your OpenAPI specification. Mintlify applies only values that match the current endpoint's security scheme. -## Dynamic MDX content +## Dynamic Markdown (MDX) content Display content based on user information like name, plan, or organization with the `user` variable in your MDX pages. Include custom data in the `content` field of your [user data](/deploy/authentication-setup#user-data-format). diff --git a/customize/custom-scripts.mdx b/customize/custom-scripts.mdx index 8ac4ea3838..0b86d808b5 100644 --- a/customize/custom-scripts.mdx +++ b/customize/custom-scripts.mdx @@ -390,9 +390,9 @@ gtag('config', 'TAG_ID'); ### Access authenticated user data -If your site uses [authentication](/deploy/authentication-setup), custom scripts can read the signed-in user from `window.mintlify.user`. This is the same object exposed to MDX pages as the [`user` variable](/create/personalization#dynamic-mdx-content), so it reflects the `content` field of your user data. +If your site uses [authentication](/deploy/authentication-setup), custom scripts can read the signed-in user from `window.mintlify.user`. This is the same object exposed to Markdown (MDX) pages as the [`user` variable](/create/personalization#dynamic-mdx-content), so it reflects the `content` field of your user data. -Because custom scripts run before user info resolves, listen for the `mintlify:user` event to identify when the user object is available. The event fires when user info resolves and again on any change. Its `detail` is the user object, or `null` when the visitor is signed out. +Because custom scripts run before user info resolves, listen for the `mintlify:user` event to identify when the user object is available. The event fires when user info resolves and again on any change. Its `detail` is the user object, or `null` when the visitor signs out. ```js Read the user after it resolves window.addEventListener('mintlify:user', (event) => { diff --git a/migration-services/go-live-checklist.mdx b/migration-services/go-live-checklist.mdx index 44609e4c5c..78c0972356 100644 --- a/migration-services/go-live-checklist.mdx +++ b/migration-services/go-live-checklist.mdx @@ -17,7 +17,7 @@ This is a comprehensive list of configurations to set up and settings to validat - Review who can access your dashboard. - Set up [dashboard SSO](/dashboard/sso) for your team to access your dashboard and editor. - Set up [dashboard access policies](/dashboard/network-access). - - Set up [SCIM provisioning](/dashboard/scim). + - Set up [System for Cross-domain Identity Management (SCIM) provisioning](/dashboard/scim). - Review your Mintlify site access. - If you restrict your site to certain users, set up [authentication](/deploy/authentication-setup). - Review which groups have access to pages and which pages are public. @@ -27,7 +27,7 @@ This is a comprehensive list of configurations to set up and settings to validat - **Verify your information architecture.** Is this the proper navigation structure? Are there missing sections? See [content types](/guides/content-types) for reference. - **Verify your information is up-to-date.** Are all recent content changes reflected on your site? - If required, set up [redirects](/create/redirects). -- **Configure SEO settings.** Set your site description, meta tags, and indexing preferences in `docs.json`. See [SEO and search settings](/organize/settings-seo). +- **Configure Search Engine Optimization (SEO) settings.** Set your site description, meta tags, and indexing preferences in `docs.json`. See [SEO and search settings](/organize/settings-seo). - **Review page-level SEO.** Configure meta tags, Open Graph properties, and canonical URLs where needed. See [SEO](/optimize/seo). ## Dashboard features diff --git a/optimize/analytics.mdx b/optimize/analytics.mdx index 0b369ea9b8..d6e6fb3ee2 100644 --- a/optimize/analytics.mdx +++ b/optimize/analytics.mdx @@ -59,7 +59,7 @@ Review your assistant analytics to: - **Monitor assistant usage**: Observe changes in assistant usage to understand how your users engage with your content. - **Identify frequent topics**: Drill into categories and topics to understand what your users ask about most. Identify gaps in coverage and prioritize content updates. - **Find where users struggle**: Filter by negative feedback to see which conversations users rated poorly and prioritize improving the underlying content. -- **Review chat history**: Get detailed high intent data about how your users think about your product by reviewing conversations with the assistant. See what terms they use, what they need help with, and what tasks they try to accomplish. +- **Review chat history**: Get detailed high-intent data about how your users think about your product by reviewing conversations with the assistant. See what terms they use, what they need help with, and what tasks they try to accomplish. @@ -244,7 +244,7 @@ To stop streaming to a destination, open the streaming configuration and select | Page components | Expandable, accordion, code block, and API playground interactions. | | Feedback | Thumbs up, thumbs down, and detailed feedback submissions. | | AI Assistant | Assistant conversations, sources, suggestions, feedback, and errors. | - | Context menu & MCP | Context menu actions, MCP link copies, MCP server installs, and MCP tool calls. | + | Context menu & Model Context Protocol (MCP) | Context menu actions, MCP link copies, MCP server installs, and MCP tool calls. | The examples summarize each category. Use the streamed `eventType` value to identify the exact event. @@ -263,7 +263,7 @@ No events stream until you select at least one category and at least one deploym ### Understand streamed data -Mintlify writes newline-delimited JSON (`.jsonl`) objects to your bucket. Mintlify generates object names from UTC timestamps. If you configure a key prefix, Mintlify writes the objects under that prefix. +Mintlify writes newline-delimited JSON (`.jsonl`) objects to your bucket. Mintlify generates object names from Coordinated Universal Time (UTC) timestamps. If you configure a key prefix, Mintlify writes the objects under that prefix. Each line contains an event envelope with an `eventType` and `payload`. The `eventType` is the event name, such as `docs.content.view`. The `payload` contains the analytics event as a JSON object or a JSON-encoded string. If `payload` is a string, parse it as JSON before loading it into your warehouse. diff --git a/organize/pages.mdx b/organize/pages.mdx index 8fefcc647e..651bebea39 100644 --- a/organize/pages.mdx +++ b/organize/pages.mdx @@ -5,7 +5,7 @@ keywords: ["tags", "tag", "frontmatter", "metadata", "layout"] boost: 3 --- -Each page is a Markdown file. You can use either `.mdx` or `.md` file types for your pages. Use MDX, which combines Markdown with React components for rich, interactive documentation. Plain Markdown (`.md`) can expedite migration from other platforms, but switching to MDX enables more features. +Each page is a Markdown file. You can use either `.mdx` or `.md` file types for your pages. Use Markdown (MDX), which combines Markdown with React components for rich, interactive documentation. Plain Markdown (`.md`) can expedite migration from other platforms, but switching to MDX enables more features. ## Page metadata @@ -18,7 +18,7 @@ Use frontmatter to control: - Page titles and descriptions - Sidebar titles, icons, and tags - Page layouts -- SEO meta tags +- Search Engine Optimization (SEO) meta tags - Custom metadata diff --git a/quickstart.mdx b/quickstart.mdx index 6adeca6b36..ae360ff3d7 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -13,7 +13,7 @@ After you complete this guide, you'll have a live documentation site ready to cu Using an AI agent? - Copy the following prompt to have your agent set up your site for you. It directs your agent to create your account and deploy your site. It also adds the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when you update your content. + Copy the following prompt to have your agent set up your site for you. It directs your agent to create your account and deploy your site. It also adds the Mintlify [skill](/ai/skillmd) and [Model Context Protocol (MCP) server](/ai/model-context-protocol) for better results when you update your content. The prompt splits the quickstart into tasks your agent can complete and directs it to ask you for any information it needs while getting everything set up. diff --git a/search-index/connect.mdx b/search-index/connect.mdx index bcd232bc45..ab71705e58 100644 --- a/search-index/connect.mdx +++ b/search-index/connect.mdx @@ -10,7 +10,7 @@ import { PreviewButton } from "/snippets/previewbutton.jsx" Connect your coding agent to Mintlify Index so it can retrieve current technical documentation and web context while it plans and writes code. Index supports Claude Code, Cursor, VS Code, Codex, OpenCode, Windsurf, and Zed. - You do not need a Mintlify account or API key to connect to the public Index MCP server. + The public Index server uses the Model Context Protocol (MCP). You do not need a Mintlify account or API key to connect to it. ## Set up with the CLI diff --git a/search-index/index.mdx b/search-index/index.mdx index ee0d210e5f..9ef42a5cf0 100644 --- a/search-index/index.mdx +++ b/search-index/index.mdx @@ -7,7 +7,7 @@ keywords: ["Mintlify Index", "technical search", "coding agents", "MCP", "REST A Mintlify Index gives coding agents one search layer for technical knowledge. It routes questions about indexed products to publisher-maintained documentation hosted on Mintlify and uses web search for questions outside that corpus. -Use Index through the public MCP server or the access-controlled REST API. +Use Index through the public Model Context Protocol (MCP) server or the access-controlled REST API. - **MCP server**: Connect an AI tool and let it retrieve source-cited context while you work. Publicly available. Does not require an API key. - **REST API**: Search for ranked sources, assemble context within a token budget, or retrieve the contents of selected results. Access-controlled. Requires an Index API key. diff --git a/search-index/mcp.mdx b/search-index/mcp.mdx index 09e0328048..e4ecae8192 100644 --- a/search-index/mcp.mdx +++ b/search-index/mcp.mdx @@ -5,7 +5,7 @@ description: "Reference for the public Mintlify Index MCP server, including its keywords: ["Mintlify Index", "MCP server", "context tool", "rate limits"] --- -The Mintlify Index MCP server gives AI tools read-only access to technical documentation and web context. Connect to it at: +The Mintlify Index server uses the Model Context Protocol (MCP) to give AI tools read-only access to technical documentation and web context. Connect to it at: ```text https://index.mintlify.com @@ -19,7 +19,7 @@ You do not need to authenticate to the public server. See [Connect](/search-inde ## `context` tool -Use `context` to research an implementation task and return compact, source-cited context in one call. The tool is read-only and can access the open web. +Use `context` to research an implementation task and return compact, source-cited context in one call. The context call only reads data and can access the open web. Implementation question to research.