关于 repowiki
repowiki 为公开 GitHub 仓库提供 DeepWiki 文档的 CLI 和本地 MCP 接入。它可列出 wiki 主题、返回完整文档,并利用 DeepWiki 托管服务回答代码库问题。
主要功能
- 01列出仓库 wiki 主题
- 02获取完整 wiki 文档
- 03询问代码库相关问题
- 04CLI 与本地 stdio MCP 服务
适用场景
- 01浏览仓库文档主题后再深入查看
- 02查找公开 GitHub 项目的文档内容
- 03询问仓库代码相关问题
MCP 相关
通过 stdio 向 MCP 客户端提供 `read_wiki_structure`、`read_wiki_contents` 和 `ask_question` 三种工具。请求转发至 DeepWiki 托管的 MCP 端点,仅支持公开仓库。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
3收录的工具列表 · 更新于 2 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| repoName | string | 是 | 要列出文档主题的 GitHub 仓库,格式为 "owner/repo"。 |
详细介绍
repowiki
repowiki 提供命令行和本地 MCP 服务,连接 DeepWiki——一项为公开 GitHub
代码仓库编写文档 wiki 的服务。指定 owner/repo 格式的代码仓库后,它可以
列出 DeepWiki 为该项目编写的主题,返回完整的文档文本,或使用 DeepWiki 自身的
索引和模型,回答有关代码库的自然语言问题。
答案来自 DeepWiki 的公开托管服务,该服务免费使用,无需账户或 API 密钥。repowiki 是本地端:它使用该服务公开的协议,并通过标准输入/输出提供相同的三个 工具,因此任何 MCP 客户端都无需配置远程传输即可使用它们。
安装
npx @reneturcios/repowiki structure facebook/react
或者运行容器镜像:
docker run -i ghcr.io/cloudcorprecords/repowiki
容器默认启动 MCP 服务(见下文)。传入 CLI 参数即可将其用作 CLI。
CLI
# List the documentation topics for a repository
repowiki structure facebook/react
# Print the full documentation text
repowiki contents facebook/react
# Ask a question about the repository
repowiki ask facebook/react "How is state managed?"
repowiki --version
退出代码:成功时为 0,上游服务报告错误或无法访问时为 1,用法错误时为 2。
代码仓库名称必须采用 owner/repo 格式;其他格式会在发出请求前被拒绝。
MCP 服务
一个可执行文件提供两种用法。mcp 子命令会启动一个标准输入/输出 MCP
服务:
npx -y @reneturcios/repowiki mcp
MCP 客户端配置:
{
"mcpServers": {
"repowiki": {
"command": "npx",
"args": ["-y", "@reneturcios/repowiki", "mcp"]
}
}
}
工具
| 工具 | 输入 | 返回内容 |
|---|---|---|
read_wiki_structure | repoName(字符串,必填,owner/repo) | DeepWiki 为该代码仓库提供的文档主题列表。 |
read_wiki_contents | repoName(字符串,必填,owner/repo) | 该代码仓库的完整文档文本。 |
ask_question | repoName(字符串,必填),question(字符串,必填) | 基于 DeepWiki 代码和文档索引生成的代码仓库相关回答。 |
在幕后,每次调用都会作为 JSON-RPC tools/call
请求转发到 DeepWiki 的托管 MCP 端点(https://mcp.deepwiki.com/mcp);响应以纯 JSON
或服务器发送事件流的形式返回,并提取为结果文本。不会发送任何凭据:
该公开服务无需凭据。与上游仅支持公开访问的限制一致,私有代码仓库不在支持范围内。
开发
npm install
npm run build # tsc -> dist/
npm test # node test runner over test/*.test.ts, no network (fake fetch fixtures)
npm run dev # run the CLI from source via tsx
许可证
MIT — 参见 LICENSE。
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。