Repo Context Mcp

Repo Context MCP 🚀

直接从 VS Code 探索和分析任意代码仓库，无论仓库位于本地还是远程。

---

🚀 为什么使用 Repo-context-mcp？

了解在 VS Code 中使用和不使用此工具的区别：

	❌ 不使用 Repo-context-mcp	✅ 使用 Repo-context-mcp
🔍 探索仓库结构	手动浏览文件和文件夹	即时列出任意仓库中的文件和文件夹
📄 读取文件内容	逐个打开文件	通过一条命令读取任意文件的内容
🧑‍💻 分析代码	手动检查／导出函数	自动获取导出的函数和类型
🔒 私有／公共仓库	需要在本地克隆并设置	分析本地或远程仓库（包括私有仓库）
⚡ GitHub 端点	手动调用 API 或克隆	无需克隆即可获取文件和元数据

---

✨ 功能

• 📂 列出任意仓库（本地或 GitHub）中的文件和文件夹
• 📄 即时读取文件内容
• 🧑‍💻 分析 TypeScript/JavaScript 文件中导出的函数和类型
• 🔒 支持私有和公共仓库
• ⚡ 无需克隆：从 GitHub 端点获取文件和元数据

---

🛠️ 安装

1. 在 VS Code 中安装

   打开工作区并运行：

   npm install
   

2. 构建项目

   npm run build
   

3. 以开发模式启动服务

   npm run start:dev
   

   或者，运行编译后的代码：

   npm start
   

---

🚦 工作原理

使用此 MCP 服务，你可以：

• 设置要分析的仓库路径（本地或远程）
• 列出文件和文件夹
• 读取文件内容
• 分析 TypeScript/JavaScript 文件，提取导出的函数及其类型信息

所有这些工具都可以直接从 VS Code 使用，让你在工作时轻松理解和记录代码库。

---

🎯 示例：即时了解端点需要什么

使用 Repo Context MCP，你可以分析 TypeScript 仓库，并针对 API 端点提出非常具体的问题，例如成功发送请求需要提供什么对象和类型。

例如：

“要创建新用户，我需要向 POST /users/register 发送什么内容？”

Repo Context MCP 将分析源代码，并提供所需的确切 JSON 结构和 TypeScript 类型，包括枚举和嵌套对象。
这样，你就能准确知道要发送什么，无需浪费时间猜测或查找文档。

这能极大提升开发者的工作效率：

• 即时了解端点的请求数据和类型
• 避免反复试错和请求失败
• 更快地与任何后端集成，即使是私有 API

如果你需要具体示例，或想查看任意端点的请求数据，只需询问，Repo Context MCP 就会直接提取相关内容。

---

🔗 集成

在 mcp.json 中将此 MCP 服务注册为上下文提供方：

{
  "servers": {
    "repo-context-mcp": {
      "command": "npx",
      "args": [
        "ts-node",
        "/home/pablo/Apps/repo-context/src/index.ts"
      ],
      "type": "stdio",
      "env": {
        "ENVIRONMENT": "local",
        "GITHUB_TOKEN": "",
        "GITHUB_NAME": ""
      }
    }
  }
}

---

🔒 分析私有和本地仓库

• 本地仓库：使用 setRepoPath 工具设置路径。

• 私有 GitHub 仓库：在 MCP 服务配置（mcp.json）的环境变量中添加你的 GitHub 用户名和令牌：

  "env": {
    "GITHUB_TOKEN": "<your-github-token>",
    "GITHUB_NAME": "<your-github-username>"
  }
  

  然后，指定仓库所有者、名称和文件路径，使用这些工具从私有仓库获取并分析文件。

注意： 对于私有 GitHub 仓库，请在配置中提供你的 GitHub 凭据。对于本地仓库，只需传入本地路径。

---

📦 要求

• Node.js 18+
• npm

---

💡 备注

• 使用 setRepoPath 工具动态设置要分析的仓库。
• 此服务提供用于文件探索和类型分析的工具，非常适合理解代码和编写文档。
• 无需克隆即可从 GitHub 端点获取文件和元数据