CodeWiki MCP — AI-generated docs for GitHub repos

📖 概览

codewiki-mcp 是一款 Model Context Protocol 服务，可让 AI 助手访问 codewiki.google——这项服务可为任意 GitHub 仓库生成全面的 Wiki 文档。搜索仓库、获取完整文档，或用自然语言提问——所有操作都通过 MCP 完成。

✨ 功能

🚀 快速开始

使用 npx（无需安装）

npx -y codewiki-mcp@latest

从源代码构建

git clone https://github.com/izzzzzi/codewiki-mcp.git
cd codewiki-mcp
npm install
npm run build

传输方式

# stdio (default)
node dist/cli.js

# Streamable HTTP
node dist/cli.js --http --port 3000

# SSE
node dist/cli.js --sse --port 3001

🐳 Docker

docker build -t codewiki-mcp .

# stdio
docker run -it --rm codewiki-mcp

# HTTP
docker run -p 3000:3000 codewiki-mcp --http

# with environment variables
docker run -p 3000:3000 \
  -e CODEWIKI_REQUEST_TIMEOUT=60000 \
  -e CODEWIKI_MAX_RETRIES=5 \
  -e GITHUB_TOKEN=ghp_your_token \
  codewiki-mcp --http

🔧 MCP 客户端配置

{
  "mcpServers": {
    "codewiki-mcp": {
      "command": "npx",
      "args": ["-y", "codewiki-mcp@latest"]
    }
  }
}

{
  "mcpServers": {
    "codewiki-mcp": {
      "command": "npx",
      "args": ["-y", "codewiki-mcp@latest"]
    }
  }
}

claude mcp add codewiki-mcp -- npx -y codewiki-mcp@latest

{
  "mcpServers": {
    "codewiki-mcp": {
      "command": "npx",
      "args": ["-y", "codewiki-mcp@latest"]
    }
  }
}

{
  "servers": {
    "codewiki-mcp": {
      "command": "npx",
      "args": ["-y", "codewiki-mcp@latest"]
    }
  }
}

{
  "mcpServers": {
    "codewiki-mcp": {
      "command": "node",
      "args": ["/path/to/codewiki-mcp/dist/cli.js"]
    }
  }
}

💡 使用方法

可在任何兼容 MCP 的客户端中使用的提示词：

codewiki fetch how routing works in Next.js

codewiki search state management libraries

codewiki ask how does React fiber reconciler work?

获取完整文档：

codewiki fetch vercel/next.js
codewiki fetch https://github.com/fastify/fastify

获取结构化页面：

codewiki fetch pages tailwindlabs/tailwindcss

使用自然语言提问：

codewiki ask fastify how to add authentication?

🛠️ MCP 工具

🔍 codewiki_search_repos

搜索由 codewiki.google 编入索引的仓库。

📄 codewiki_fetch_repo

获取仓库生成的 Wiki 内容。

💬 codewiki_ask_repo

用自然语言提问有关仓库的问题。

📊 响应格式

{
  "query": "fastify",
  "count": 1,
  "items": [
    {
      "fullName": "fastify/fastify",
      "url": "https://github.com/fastify/fastify",
      "description": "Fast and low overhead web framework",
      "avatarUrl": "https://avatars.githubusercontent.com/u/24939....",
      "extraScore": 555
    }
  ],
  "meta": {
    "totalBytes": 12500,
    "totalElapsedMs": 450
  }
}

{
  "repo": "fastify/fastify",
  "commit": "abc123",
  "canonicalUrl": "https://github.com/fastify/fastify",
  "pages": [
    {
      "title": "Overview",
      "level": 1,
      "anchor": "#overview",
      "markdown": "# Overview\n\nFastify is a web framework...",
      "diagramCount": 1
    }
  ],
  "meta": {
    "totalBytes": 25000,
    "totalElapsedMs": 1200
  }
}

{
  "answer": "Fastify uses a plugin-based architecture where...",
  "meta": {
    "totalBytes": 8500,
    "totalElapsedMs": 2300
  }
}

{
  "error": {
    "code": "RPC_FAIL",
    "message": "CodeWiki RPC VSX6ub failed with status 404",
    "rpcId": "VSX6ub",
    "statusCode": 404
  }
}

⚙️ 工作原理

数据流

AI Assistant → MCP protocol → codewiki-mcp → HTTPS → codewiki.google
                                                            ↓
AI Assistant ← MCP protocol ← codewiki-mcp ← JSON  ← Google RPC API

Google Batchexecute RPC

codewiki.google 使用 Google 内部的 batchexecute RPC 格式（不是 REST，也不是 GraphQL）。客户端会：

1. 使用 f.req=... 请求正文构建 POST 请求
2. 将请求发送到 /_/BoqAngularSdlcAgentsUi/data/batchexecute
3. 接收带有 XSSI 前缀 )]}'\n 的响应
4. 解析 wrb.fr 帧并提取类型化负载

每个工具都对应一个 RPC ID：

🧠 NLP 仓库解析

用户可以输入自然语言，而不是 owner/repo：

"the fastify web framework"
  → wink-nlp extracts keyword "fastify" (POS tag: NOUN/PROPN)
  → GitHub Search API: GET /search/repositories?q=fastify&sort=stars
  → top result: "fastify/fastify"
  → normalizeRepoInput("fastify/fastify") → URL for codewiki

🔄 指数退避重试

4xx 错误（客户端错误）绝不会重试。

🖥️ 命令行

codewiki-mcp [options]

Options:
  --http           Streamable HTTP transport
  --sse            SSE transport
  --port <number>  Port for HTTP/SSE (default: 3000)
  --endpoint <str> URL endpoint (default: /mcp)
  --help, -h       Show help

⚡ 配置

环境变量：

你也可以在项目根目录创建 .env 文件：

CODEWIKI_REQUEST_TIMEOUT=60000
CODEWIKI_MAX_RETRIES=5
GITHUB_TOKEN=ghp_your_token

📁 项目结构

src/
├── cli.ts                  # CLI entry point
├── server.ts               # Transport setup (stdio/HTTP/SSE)
├── index.ts                # Library re-exports
├── schemas.ts              # Zod input schemas
├── lib/
│   ├── codewikiClient.ts   # API client with retry + metadata
│   ├── batchexecute.ts     # Google RPC response parser
│   ├── repo.ts             # Repo normalization + NLP resolution
│   ├── extractKeyword.ts   # NLP keyword extraction (wink-nlp)
│   ├── resolveRepo.ts      # GitHub Search API resolver
│   ├── errors.ts           # CodeWikiError + formatMcpError
│   └── config.ts           # Env-based configuration
└── tools/
    ├── searchRepos.ts      # codewiki_search_repos
    ├── fetchRepo.ts        # codewiki_fetch_repo
    └── askRepo.ts          # codewiki_ask_repo

❓ 故障排除

chmod +x ./node_modules/.bin/codewiki-mcp

# Check if port is in use
lsof -i :3000

CODEWIKI_REQUEST_TIMEOUT=60000 node dist/cli.js

# Instead of "the fastify framework"
fastify/fastify
# or
https://github.com/fastify/fastify

🧑‍💻 开发

npm run dev          # stdio with tsx
npm run dev:http     # HTTP with tsx
npm run dev:sse      # SSE with tsx
npm run typecheck    # type check
npm run test         # run tests
npm run test:watch   # tests in watch mode
npm run build        # compile to dist/

🤝 贡献

欢迎贡献！请：

1. Fork 此仓库
2. 创建功能分支（git checkout -b feat/my-feature）
3. 使用 Conventional Commits 编写提交消息
4. 提交前运行 npm run typecheck && npm run test
5. 发起 Pull Request

📄 许可证

MIT © codewiki-mcp 贡献者