Skip to content

feat: docs mcp server #568

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

Open
sanny-io wants to merge 4 commits into
base: main
Choose a base branch
from
+941 −0
Open

feat: docs mcp server #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b74748
feat: docs mcp server
sanny-io Feb 24, 2026
3b89793
fix: base url
sanny-io Feb 24, 2026
576a674
reorganize
sanny-io Feb 24, 2026
b92aacb
fix: paths
sanny-io Feb 24, 2026
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
12 changes: 12 additions & 0 deletions api/docs/mcp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { createVercelHandler } from 'docusaurus-plugin-mcp-server/adapters';
import path from 'path';
import { fileURLToPath } from 'url';

const __dirname = path.dirname(fileURLToPath(import.meta.url));
Copy link
Member

@ymc9 ymc9 Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the doc project is CJS and it seems the server function crashes when I hit the "/docs/mcp" endpoint.

I'm not sure how much work it is to migrate to ESM, but maybe it's simpler to have this file as CJS instead?


export default createVercelHandler({
docsPath: path.join(__dirname, '../../build/mcp/docs.json'),
indexPath: path.join(__dirname, '../../build/mcp/search-index.json'),
name: 'zenstack-docs',
baseUrl: 'https://zenstack.dev/docs',
});
9 changes: 9 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,15 @@ const config = {
blogSidebarCount: 10,
},
],
[
'docusaurus-plugin-mcp-server',
{
Copy link
Member

@ymc9 ymc9 Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems by default the mcp generation include all files, including blog and 2.x docs. Shall we limit it to only 3.x docs?

server: {
name: 'zenstack-docs',
version: '1.0.0',
},
},
],
],

markdown: {
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"@docusaurus/preset-classic": "3.4.0",
"@docusaurus/theme-common": "3.4.0",
"@docusaurus/theme-mermaid": "3.4.0",
"docusaurus-plugin-mcp-server": "^0.10.2",
"@giscus/react": "^2.4.0",
"@mdx-js/react": "^3.0.1",
"autoprefixer": "^10.4.13",
Expand Down
Loading