MCP Server
Connect AI tools to this documentation portal via the built-in MCP server.
About MCP
The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services. This portal includes a built-in MCP server so AI agents can query Ontopix documentation during their workflows.
When connected, an AI tool can:
- Search documentation proactively while generating responses
- Retrieve full page content when it determines the documentation is relevant
- Stay current with the latest published documentation
Server URL
The MCP server is available at:
https://docs.ontopix.dev/mcp
Available Tools
list-pages
Lists documentation pages with navigation structure. Supports filtering by path and badge maturity.
| Parameter | Type | Description |
|---|---|---|
path | string (optional) | Filter to a subtree (e.g., /schemas, /engineering) |
recursive | boolean (optional) | Return all pages in subtree (default: false) |
includeBadges | string (optional) | Only show pages with these badges |
excludeBadges | string (optional) | Hide pages with these badges |
get-page
Retrieves the full Markdown content of a specific documentation page.
| Parameter | Type | Description |
|---|---|---|
path | string (required) | The page path (e.g., /docs/about) |
get-collection-info
Get metadata about documentation collections, including source repository and issue URL.
| Parameter | Type | Description |
|---|---|---|
collection | string (optional) | Collection key for details (omit for overview of all) |
Overview mode (no parameters): Returns all collections with page counts and badges.
Detail mode (with collection): Adds sections, source repository info, and issue URL for reporting documentation problems.
search-pages
Full-text search across documentation content — titles, headings, and body text.
| Parameter | Type | Description |
|---|---|---|
query | string (required) | Search terms (e.g., "authentication patterns") |
collection | string (optional) | Limit search to one collection |
limit | number (optional) | Max results (default: 10, max: 50) |
Badge Filtering
Pages and collections carry badges indicating maturity and status. Use badge filtering in list-pages to focus on the right content:
| Badge | Meaning | Typical use |
|---|---|---|
production | Stable, approved for use | Default for trusted guidance |
beta | Feature complete, still testing | Use with awareness |
experimental | Proof of concept | May change or be removed |
draft | Work in progress | Not yet reviewed |
deprecated | Being phased out | Look for replacement |
Example: To list only production-ready engineering standards:
{ "path": "/engineering", "includeBadges": ["Production"] }
Setup
Claude Code
claude mcp add --transport http ontopix-docs https://docs.ontopix.dev/mcp
Cursor
Create or update .cursor/mcp.json in your project root:
{
"mcpServers": {
"ontopix-docs": {
"type": "http",
"url": "https://docs.ontopix.dev/mcp"
}
}
}
Visual Studio Code
Create or update .vscode/mcp.json:
{
"servers": {
"ontopix-docs": {
"type": "http",
"url": "https://docs.ontopix.dev/mcp"
}
}
}
Windsurf
Navigate to Settings > Windsurf Settings > Cascade > Manage MCPs > View raw config, then add:
{
"mcpServers": {
"ontopix-docs": {
"type": "http",
"url": "https://docs.ontopix.dev/mcp"
}
}
}
Customization
The MCP server uses @nuxtjs/mcp-toolkit. Custom tools can be added in server/mcp/tools/:
import { z } from 'zod'
export default defineMcpTool({
description: 'Search documentation by keyword',
inputSchema: {
query: z.string().describe('The search query'),
},
handler: async ({ query }) => {
const results = await searchDocs(query)
return {
content: [{ type: 'text', text: JSON.stringify(results) }],
}
},
})