Codebase MCP Server

Codebase MCP 服务

用于安全、高效分析 Codebase 的 Model Context Protocol 服务

主要功能 • 支持的语言 • 工具 • 快速开始 • 构建 • 参与贡献

🌟 主要功能

• 安全访问：将文件操作限制在预定义的根目录中。
• 高效文件管理：提供读取和搜索文件的工具。
• 详细元数据：获取全面的文件元数据，包括大小、创建时间、最后修改时间、权限和类型。
• 依赖分析：遍历并分析项目中的依赖树。

📋 支持的语言

• JavaScript/TypeScript
• CSS / CSS 预处理器

🛠️ 工具

• get-project-basics：获取项目基本信息，包括 package.json 详情和目录结构。
• search-config-files：搜索根目录中的配置文件并返回其路径。
• get-dependency-tree：根据给定的文件路径和根目录遍历依赖树，并返回遍历结果。
• list-directory：列出指定目录的内容，并区分文件和目录。
• read-file-with-metadata：读取指定文件的内容并获取其元数据。

🚀 快速开始

前置条件

• Node.js v18 或更高版本
• 用于与大模型通信的 Codebase

安装

首先，使用你的客户端安装 Codebase MCP 服务。典型配置如下：

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest", "/path/to/your/codebase"]
    }
  }
}

或者，你也可以使用 Docker 安装 Codebase MCP 服务。

克隆此仓库后，构建 Docker 镜像：

docker build -t mcp/codebase -f .

然后将以下内容添加到 MCP 服务配置文件中：

{
  "mcpServers": {
    "Codebase": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--mount",
        "type=bind,src=/path/to/your/codebase/dir,dst=/projects/path/to/your/codebase/dir,ro",
        "--mount",
        "type=bind,src=/path/to/some/file.txt,dst=/projects/path/to/some/file.txt",
        "mcp/codebase",
        "/projects"
      ]
    }
  }
}

# For VS Code
code --add-mcp '{"name":"Codebase","command":"npx","args":["codebase-mcp-server@latest"]}'

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": ["codebase-mcp-server@latest"]
    }
  }
}

🔧 构建

本地开发构建

# Install dependencies
npm ci

# Build TypeScript
npm run build

Docker 构建

# Build Docker image
docker build -t mcp/codebase -f .

# Or with specific tag
docker build -t mcp/codebase:latest -f .

🤝 参与贡献

欢迎贡献！请阅读我们的贡献指南，了解行为准则以及提交拉取请求的流程。