概览
What is GitHub Wiki MCP Server?
A server that exposes a locally cloned GitHub Wiki as a Model Context Protocol (MCP) API. It is designed to integrate with editors like Cursor, allowing the editor to retrieve context from the wiki for use in AI-assisted development.
How to use GitHub Wiki MCP Server?
Install by cloning the repository and running npm install, or by globally installing the npm package github-wiki-mcp-server. Configure the wiki path in config/default.js or via the --wiki flag or WIKI_PATH environment variable. Start the server with npm start (or npm run dev for development), then in Cursor add an MCP server pointing to http://localhost:3333/mcp.
Key features of GitHub Wiki MCP Server
- Provides MCP-compliant context API endpoints.
- Fetches content from a local GitHub Wiki clone.
- Searches wiki pages based on a query.
- Supports configuration via environment variables and CLI flags.
- Designed for seamless integration with Cursor editor.
Use cases of GitHub Wiki MCP Server
- Provide a personal project wiki as context to an AI coding assistant.
- Enable an editor to search and retrieve internal documentation during development.
- Use local wiki clones for offline or private wiki context without internet access.
FAQ from GitHub Wiki MCP Server
What does GitHub Wiki MCP Server do?
It turns a local GitHub Wiki repository into an MCP server, so applications (like Cursor) can query the wiki and receive relevant page content as context.
What are the runtime requirements?
Node.js 14 or higher and a local clone of a GitHub Wiki repository are required.
How do I configure the wiki path?
Edit config/default.js or set the environment variable WIKI_PATH to the path of your cloned wiki directory. Alternatively, use the --wiki flag when starting the server.
How do I connect this server to Cursor?
Start the server, then in Cursor’s settings add an external MCP server with the URL http://localhost:3333/mcp.
How can I install the server globally?
Run npm install -g github-wiki-mcp-server and then use the command github-wiki-mcp (optionally with --port and --wiki flags) to start it.
