关键词

代码组件本地仓库LLM工具开发辅助代码搜索

项目简介

这是一个基于 Model Context Protocol (MCP) 的服务器实现，专注于访问和管理您本地文件系统中的代码组件信息。它使大型语言模型 (LLM) 或其他 MCP 客户端能够通过标准接口与您的代码库交互，查询组件列表并获取其源代码，从而辅助代码理解和开发工作。

主要功能点

  • 搜索代码组件: 能够根据名称搜索本地指定目录下的代码组件文件，并返回匹配组件的名称和文件相对路径列表。
  • 获取组件源代码: 根据提供的文件路径，读取并返回指定代码组件的完整源代码内容。
  • 支持通过标准输入输出 (Stdio) 作为通信协议，方便集成到支持MCP的开发环境中。

安装步骤

  1. 确保您的系统已安装 Node.js 和 npm。
  2. 通过 Git 克隆该项目的代码到您的本地机器。
  3. 打开终端，导航到项目所在的目录。
  4. 运行 'npm install' 命令安装所有必需的项目依赖。
  5. 在项目根目录下创建一个名为 '.env' 的文件。在此文件中，您需要指定包含您的代码组件的目录的绝对路径，例如： 
    COMPONENTS_PATH=/path/to/your/front/repository/components
    请将 '/path/to/your/front/repository/components' 替换为您实际的代码组件目录路径。

服务器配置

要让您的 MCP 客户端（例如支持 MCP 的代码编辑器插件）能够连接并使用此服务器，您需要在客户端的相应配置中添加服务器信息。配置通常是一个 JSON 结构，用于指示客户端如何启动和连接到服务器进程。关键配置项通常包括：

  • 一个用于在客户端界面中标识此服务器的唯一名称（例如，'component-mcp-server'）。
  • 'command': 指定用于启动服务器进程的可执行命令，例如 '"node"'。
  • 'args': 一个字符串列表，包含传递给启动命令的参数。对于此服务器，这通常是 '["./build/index.js"]'，指向构建后的服务器入口文件。
  • 'env': 一个键值对对象，用于设置服务器进程所需的任何环境变量。您需要在此处设置 'COMPONENTS_PATH' 变量及其对应的值，指定您的代码组件目录路径，例如 '{ "COMPONENTS_PATH": "/path/to/your/front/repository/components" }'。

请根据您的 MCP 客户端的具体配置界面和要求，输入上述信息。

基本使用方法

完成安装和配置后，构建并启动 MCP 服务器。通常，构建命令是 'npm run build'，然后客户端会在连接时自动启动服务器进程。一旦连接建立，您的 MCP 客户端将会发现并显示此服务器提供的功能，即“搜索代码组件”和“获取组件源代码”。您可以通过客户端的交互界面调用这些功能。例如，您可以输入想要查找的组件名称进行搜索，或者选择一个已知的组件路径来获取其源代码，以便 LLM 或其他客户端应用进行进一步处理或分析。

信息

分类

开发者工具

访问项目