关键词

代码片段管理代码存储开发者工具知识库效率工具

使用说明

项目简介

Code Snippet Server 是一个实现了 Model Context Protocol (MCP) 的后端服务器，专注于代码片段的管理。它允许用户通过标准化的 MCP 协议，使用客户端工具创建、存储、检索和删除各种编程语言的代码片段。该服务器旨在为 LLM 应用提供代码片段的上下文数据支持。

主要功能点

  • 创建代码片段: 允许用户创建带有标题、编程语言和代码内容的代码片段，并可添加标签进行分类。
  • 列出代码片段: 支持根据编程语言或标签筛选代码片段列表。
  • 删除代码片段: 通过唯一ID删除指定的代码片段。
  • 本地持久化存储: 代码片段数据存储在本地文件中，实现数据持久化。
  • 多语言支持: 支持界面文本的本地化。

安装步骤

  1. 克隆仓库 
    git clone [email protected]:ngeojiajun-deriv/mcp-code-snippets.git
cd mcp-code-snippets
  2. 构建项目 
    npm install
npm run build
  3. 全局链接 (方便在命令行中直接运行) 
    npm link

服务器配置

MCP 客户端需要配置以下信息以连接到 Code Snippet Server：

{
  "serverName": "code-snippet-server",
  "command": "mcp-code-snippets",
  "args": []
}

配置参数说明:

  • 'serverName': 服务器名称，此处为 'code-snippet-server'，用于在客户端标识该服务器。
  • 'command': 启动服务器的命令。由于使用了 'npm link' 进行全局链接，这里假设命令为 'mcp-code-snippets'。 如果 'npm link' 后实际的命令不同，请替换为正确的命令。
  • 'args': 启动命令的参数，本服务器无需额外参数，因此为空数组 '[]'。

注意: 请确保 Node.js 环境已正确安装，并且 'npm link' 命令执行成功，才能通过 'mcp-code-snippets' 命令启动服务器。

基本使用方法

  1. 启动服务器 在终端中运行以下命令启动 Code Snippet Server：

    mcp-code-snippets

    服务器启动后，会在控制台输出 'Started code snippet server' 信息。

  2. 使用 MCP 客户端连接 配置 MCP 客户端，使用上述提供的服务器配置信息连接到 Code Snippet Server。

  3. 调用工具 通过 MCP 客户端，可以调用以下工具与服务器交互：

    • create_snippet: 创建代码片段。需要提供 'title', 'language', 'code' 参数，'tags' 参数可选。
    • list_snippets: 列出代码片段。 可选参数 'language' 和 'tag' 用于筛选。
    • delete_snippet: 删除代码片段。需要提供要删除的片段 'id'。

    具体的工具调用方式和参数格式，请参考 MCP 客户端的使用说明。 服务器会返回 JSON 格式的响应，客户端根据响应内容进行处理。 例如，创建代码片段成功后，服务器会返回包含创建成功的消息和片段 ID 的响应。列出代码片段工具会返回包含 JSON 格式代码片段列表的响应。

信息

分类

开发者工具

访问项目