使用说明
项目简介
Coding Wizard MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务器,旨在为 LLM 客户端提供强大的代码辅助功能。它利用 Qdrant 向量数据库存储和检索代码片段,实现代码的语义搜索、生成和补全,并提供代码分析工具,帮助开发者提升编码效率。
主要功能点
- 代码片段存储与检索: 使用 Qdrant 向量数据库高效存储和检索代码片段,支持语义搜索,快速找到相似代码。
- 代码生成与补全: 具备代码生成和补全能力,辅助开发者编写代码。
- 代码分析: 提供代码分析工具,例如使用 ESLint 进行代码质量检查。
- 可扩展工具: 通过 MCP 协议注册和执行工具,方便扩展服务器功能,例如内置了 Qdrant API 测试工具。
- 结构化日志: 采用结构化日志系统,方便问题追踪和监控。
- 环境配置: 支持基于环境变量的配置,方便部署和管理。
- 输入验证: 使用 Zod 进行输入验证,保证数据安全和可靠性。
- 错误处理: 提供优雅的错误处理机制,提升服务器稳定性。
安装步骤
-
克隆仓库:
git clone https://github.com/MaxParisotto/coding-wizard.git cd coding-wizard -
安装依赖:
npm install -
配置环境变量: 复制 '.env.example' 文件为 '.env',并根据需要修改以下配置:
cp .env.example .env编辑 '.env' 文件,配置 Qdrant 数据库、Embedding 服务等连接信息。
-
启动服务器:
-
开发模式: 方便开发调试,使用热重载。
npm run dev -
生产模式: 用于生产环境部署,性能更优。
npm start
-
服务器配置 (MCP 客户端)
MCP 客户端需要配置以下 JSON 信息才能连接到 Coding Wizard MCP Server。
{ "serverName": "coding-wizard", // MCP 服务器名称,与仓库配置一致 "command": "npm", // 启动服务器的命令,这里使用 npm "args": ["start"] // 启动命令的参数,使用 npm start 启动生产模式服务器 // 如果使用开发模式,args 可以配置为 ["run", "dev"] }
基本使用方法
- 启动 Coding Wizard MCP Server 服务。
- 配置 MCP 客户端,连接到该服务器。
- 通过 MCP 客户端向服务器发送请求,例如:
- 使用 'note://<note_id>' URI 获取指定 ID 的笔记资源。
- 使用 'search://similar?query=<查询语句>' URI 搜索相似笔记。
- 调用 'coding_wizard_store_code_snippet' 工具存储代码片段。
- 调用 'search_code_snippets' 工具进行代码片段的语义搜索。
- 调用 'code_stats' 工具获取代码片段统计信息。
- 调用 'coding_wizard_qdrant_test' 工具测试 Qdrant API 的连通性。
注意: 首次运行前,请确保已安装 Node.js (>= 18) 和 Qdrant Vector DB,并配置好 Embedding 服务。
信息
分类
开发者工具