Skip to content

Allow /api path #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 16, 2025
Merged

Allow /api path #935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6ae0ceb
remove warning to not use `/api`
ethanpalm Jul 22, 2025
ab466a8
Merge branch 'main' into support-api-path
ethanpalm Aug 5, 2025
95e7293
add info about `/mcp` path
ethanpalm Aug 5, 2025
07511cf
Merge branch 'main' into support-api-path
ethanpalm Sep 16, 2025
fa08bdf
remove note about reserved paths
ethanpalm Sep 16, 2025
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
4 changes: 3 additions & 1 deletion ai/model-context-protocol.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@
MCP servers can only be generated for public documentation. Documentation behind end-user authentication cannot be accessed for server generation.
</Note>

Your MCP server is automatically generated and hosted at your documentation URL with the `/mcp` path. For example, Mintlify's MCP server is available at `https://mintlify.com/docs/mcp`.
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`.

You can see and copy your MCP server URL in your [dashboard](https://dashboard.mintlify.com/products/mcp).

The `/mcp` path is reserved for hosted MCP servers and cannot be used for other navigation elements.

## Configuring your MCP server

All MCP servers include the `search` tool by default, allowing users to query information from your docs in other tools.
Expand All @@ -33,7 +35,7 @@

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.

<ResponseField name="mcp" type="object">

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L38 

Did you really mean 'mcp'?
The MCP configuration for the endpoint.

<Expandable title="MCP">
Expand All @@ -57,7 +59,7 @@
{
"openapi": "3.1.0",
"x-mint": {
"mcp": {

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L62 

Did you really mean 'mcp'?
"enabled": true
}
},
Expand Down Expand Up @@ -271,7 +273,7 @@

<Steps>
<Step title="Open MCP settings">
1. Use <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> on Windows) to open the command palette.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L276 

Did you really mean 'Ctrl'?
2. Search for "Open MCP settings".
3. Select **Add custom MCP**. This will open the `mcp.json` file.
</Step>
Expand Down
7 changes: 0 additions & 7 deletions navigation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

With proper navigation configuration, you can organize your content so that users can find exactly what they're looking for.


## Pages

Pages are the most fundamental navigation component. Pages map to the MDX files that make up your documentation.
Expand Down Expand Up @@ -95,7 +94,7 @@

### Default expanded state

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.

Check warning on line 97 in navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

navigation.mdx#L97 

Did you really mean 'discoverability'?

```json
{
Expand Down Expand Up @@ -632,9 +631,3 @@
- Set to `true` to force automatic navigation to the first page when a navigation group is selected.
- Set to `false` to prevent navigation and only expand or collapse the group when it is selected.
- Leave unset to use the theme's default behavior.

## FAQ

<Accordion title="What navigation folders should I avoid?">
Do not use `/api` or `/mcp` as root path names (titles or folders). The `/api` and `/mcp` paths are reserved in production and will cause pages to return 404 errors if their URLs contain `/api` or `/mcp`.
</Accordion>