代码库管理服务器

一个生产就绪的模型上下文协议(MCP)服务器,使AI助手能够安全高效地读取、理解和修改代码库。

  • by parfaitBashombe
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 parfaitBashombe/mcp-server

使用说明

MCP代码库服务器

一个生产就绪的模型上下文协议(MCP)服务器,使AI助手能够安全有效地读取、理解和修改您的代码库。

特性

  • 文件系统操作:读取、写入、删除、移动文件和创建目录。
  • 代码库分析:生成项目结构、依赖关系和框架的摘要。
  • 智能忽略:尊重 .gitignore 并配置默认忽略模式(node_modules等)以避免处理不必要的文件。
  • 安全:防止路径遍历并强制执行工作区边界,以确保系统安全。
  • 类型安全:使用完整的TypeScript实现构建,以提高可靠性。

先决条件

  • Node.js:版本18或更高版本。
  • pnpm:推荐的包管理器(或npm/yarn)。

安装

  1. 克隆存储库:

    git clone <repository-url>
    cd mcp-server
    
  2. 安装依赖项:

    pnpm install
    
  3. 构建项目:

    pnpm run build
    

配置

可以使用环境变量配置服务器:

  • WORKSPACE_PATH:(可选)您希望AI访问的工作区目录的绝对路径。如果未提供,则默认为启动服务器的当前工作目录。

用法

运行服务器

要通过stdio(标准输入/输出)启动服务器:

node dist/index.js

或者使用特定的工作空间:

WORKSPACE_PATH=/path/to/your/project node dist/index.js

连接到克劳德桌面

要将此服务器与Claude Desktop一起使用,请将以下配置添加到您的 claude_desktop_config.json (通常位于 ~/Library/Application Support/Claude/claude_desktop_config.json 在macOS上):

{
  "mcpServers": {
    "codebase": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-server/dist/index.js"
      ],
      "env": {
        "WORKSPACE_PATH": "/absolute/path/to/target/workspace"
      }
    }
  }
}

替换 /absolute/path/to/mcp-server 了解该项目的实际路径,以及 /absolute/path/to/target/workspace 使用您希望Claude处理的目录。

可用工具

服务器向AI公开以下工具:

  • read_file:读取文件的完整内容。
    • path:文件的相对路径。
  • write_file:创建或覆盖文件。
    • path:文件的相对路径。
    • content:要写的内容。
  • delete_file:删除文件或目录。
    • path:文件/目录的相对路径。
  • list_files:列出目录的文件结构(树状图)。
    • path:目录路径(默认:root)。
  • search_files:搜索与glob模式匹配的文件。
    • pattern:球状图案(例如。, **/*.ts).
  • create_directory:创建新目录(递归)。
    • path:目录路径。
  • move_file:移动或重命名文件。
    • source:当前路径。
    • destination:新路径。
  • get_codebase_summary:分析代码库并返回摘要,包括项目信息、依赖关系和文件结构。

发展

  • 观看模式:根据文件更改进行重建。
    pnpm run watch
    
  • 开发模式:构建并运行服务器。
    pnpm run dev
    

许可证

麻省理工学院