使用说明
CodeWiki MCP服务器
一个MCP(模型上下文协议)服务器,提供工具查询谷歌的CodeWiki服务,以获取存储库信息、代码解释和项目详细信息。适用于Claude Desktop、Cursor和任何兼容MCP的客户端。
特征
- 查询任何存储库:询问有关任何GitHub/GitLab存储库的自然语言问题
- 获取存储库概述:项目功能的快速总结
- 了解项目结构:架构和代码组织解释
- 入门指南:安装和设置说明
- 依赖关系信息:使用的技术和图书馆
- API文档:了解暴露的API
- 代码组件说明:深入了解特定文件、函数或功能
- 存储库比较:比较两个存储库
安装
cd codewiki-mcp
npm install
npm run build
用法
使用克劳德桌面
将此添加到您的Claude Desktop配置文件中:
视窗: %APPDATA%\Claude\claude_desktop_config.json
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"codewiki": {
"command": "node",
"args": ["D:\\Projects\\vibe-ai\\codewiki-mcp\\dist\\index.js"]
}
}
}
带光标
将此添加到光标MCP设置中(.cursor/mcp.json 在项目或全局设置中):
{
"mcpServers": {
"codewiki": {
"command": "node",
"args": ["D:\\Projects\\vibe-ai\\codewiki-mcp\\dist\\index.js"]
}
}
}
与其他MCP客户端
通过stdio运行服务器:
node dist/index.js
可用工具
query_repository
询问有关存储库的任何问题。
参数:
repository(必填):存储库URL或路径(例如。,https://github.com/owner/repo,github.com/owner/repo,或owner/repo)query(必填):您关于存储库的问题
例子:
repository: "facebook/react"
query: "How does the virtual DOM diffing algorithm work?"
get_repository_overview
全面了解存储库。
参数:
repository(必填):存储库URL或路径
get_project_structure
获取项目结构和架构说明。
参数:
repository(必填):存储库URL或路径
get_getting_started
获取如何开始项目的说明。
参数:
repository(必填):存储库URL或路径
get_dependencies
获取有关依赖关系和所用技术的信息。
参数:
repository(必填):存储库URL或路径
get_api_info
获取有关存储库公开的API的信息。
参数:
repository(必填):存储库URL或路径
explain_code_component
获取特定组件的详细说明。
参数:
repository(必填):存储库URL或路径component(必填):要解释的组件(例如。,AuthService,src/utils/helpers.ts)
compare_repositories
比较两个存储库。
参数:
repository1(必填):第一个存储库URL或路径repository2(必填):第二个存储库URL或路径aspect(可选):比较哪个方面(例如。,architecture,performance)
查询示例
# Get overview of a popular project
Tool: get_repository_overview
repository: "vercel/next.js"
# Ask specific questions
Tool: query_repository
repository: "prisma/prisma"
query: "How does Prisma handle database migrations?"
# Understand a component
Tool: explain_code_component
repository: "tailwindlabs/tailwindcss"
component: "the JIT compiler"
# Compare frameworks
Tool: compare_repositories
repository1: "facebook/react"
repository2: "vuejs/vue"
aspect: "state management"
发展
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build for production
npm run build
# Start production server
npm start
原理
这个MCP服务器与谷歌的CodeWiki服务连接,该服务使用人工智能来分析和理解公共代码库。它将您的问题发送到CodeWiki,并以任何兼容MCP的客户端都可以使用的格式返回回复。
贡献
欢迎投稿!请随时提交拉取请求。
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
许可证
MIT许可证-请参阅 许可证 文件以获取详细信息。