Octocode 插件开发指南构建自定义 MCP 工具的完整流程【免费下载链接】octocodeCode research platform for AI agents; find, understand, and prove context across your code and all of GitHub, in a fraction of the tokens. One toolset, MCP or CLI项目地址: https://gitcode.com/gh_mirrors/oc/octocodeOctocode 是一款强大的代码研究平台专为 AI 代理设计能够帮助开发者快速查找、理解和验证代码上下文。本指南将带你逐步完成自定义 MCP 工具的开发流程从环境搭建到工具发布让你轻松扩展 Octocode 的功能。准备工作环境搭建与项目结构在开始开发自定义 MCP 工具之前需要先搭建好开发环境并了解项目结构。首先克隆 Octocode 仓库到本地git clone https://gitcode.com/gh_mirrors/oc/octocodeOctocode 采用 monorepo 结构核心代码位于packages目录下。与 MCP 工具开发相关的主要目录包括packages/octocode-mcpMCP 服务器核心代码packages/octocode-tools-core工具核心实现packages/octocode-engine原生搜索、安全等基础功能Octocode 架构概览展示了 MCP 工具与其他模块的关系第一步了解 MCP 工具基础MCPModular Code Platform工具是 Octocode 的核心组件用于实现各种代码研究功能。在开发自定义工具前建议先熟悉现有工具的实现方式。官方工具文档位于 docs/OCTOCODE_TOOLS.md其中详细介绍了工具的分类、参数和使用方法。Octocode 的 MCP 工具主要分为以下几类GitHub 工具如ghSearchCode、ghGetFileContent等本地代码工具如localSearchCode、localViewStructure等LSP 工具如lspGetSemantics每个工具都有定义好的输入输出 schema位于对应工具的scheme.ts文件中。例如GitHub 搜索工具的 schema 位于 packages/octocode-tools-core/src/tools/github_search_code/scheme.ts。第二步创建工具定义与 Schema开发自定义 MCP 工具的第一步是创建工具定义和 schema。schema 用于验证工具的输入输出确保数据格式正确。在packages/octocode-tools-core/src/tools目录下创建新的工具目录例如my_custom_tool。在该目录下创建scheme.ts文件定义工具的输入输出 schema。schema 定义示例import { z } from zod; export const MyCustomToolInputSchema z.object({ query: z.string().describe(搜索查询字符串), limit: z.number().int().min(1).max(100).default(20).describe(返回结果数量限制) }); export const MyCustomToolOutputSchema z.object({ results: z.array(z.object({ id: z.string(), content: z.string(), score: z.number() })) });创建工具实现文件index.ts实现工具的核心逻辑。第三步实现工具逻辑工具逻辑是自定义 MCP 工具的核心负责处理输入并生成输出。以下是一个简单的工具实现示例import { Tool } from octocodeai/octocode-tools-core; import { MyCustomToolInputSchema, MyCustomToolOutputSchema } from ./scheme; export const myCustomTool: Tool { name: myCustomTool, description: 我的自定义 MCP 工具, inputSchema: MyCustomToolInputSchema, outputSchema: MyCustomToolOutputSchema, async execute(input, context) { // 实现工具逻辑 const results await fetchData(input.query, input.limit); return { results: results.map(item ({ id: item.id, content: item.content, score: item.score })) }; } };在实现工具逻辑时可以利用 Octocode 提供的各种工具和服务例如文件系统操作packages/octocode/src/utils/fs.ts安全相关功能packages/octocode-engine/src/security/日志工具packages/octocode/src/utils/context.ts第四步注册工具与测试完成工具实现后需要将其注册到 Octocode 系统中并进行测试。在packages/octocode-tools-core/src/tools/toolConfig.ts文件中注册新工具import { myCustomTool } from ./my_custom_tool; export const ALL_TOOLS [ // ... 其他工具 myCustomTool ];编写测试用例位于packages/octocode-mcp/tests/tools/目录下。测试示例import { test } from vitest; import { executeTool } from octocodeai/octocode-mcp; test(myCustomTool 应该返回正确结果, async () { const result await executeTool(myCustomTool, { query: test, limit: 10 }); expect(result.results).toBeInstanceOf(Array); expect(result.results.length).toBeLessThanOrEqual(10); });运行测试yarn test packages/octocode-mcp/tests/tools/my-custom-tool.test.ts第五步工具验证与优化为确保工具质量需要进行全面的验证。Octocode 提供了工具验证指南位于 docs/OCTOCODE_TOOLS.md#tool-verification-playbook。主要验证点包括注册验证工具是否正确注册到系统中输入输出验证是否符合 schema 定义错误处理是否能正确处理各种错误情况性能验证工具执行效率是否满足要求Octocode MCP 工具请求流程示意图根据验证结果对工具进行优化例如优化查询逻辑提高执行效率完善错误处理提供更友好的错误提示增加缓存机制减少重复计算发布与分享贡献自定义工具完成自定义工具开发后可以通过以下方式分享你的成果提交 Pull Request 到 Octocode 主仓库在skills/目录下创建工具文档参考现有技能文档格式参与社区讨论获取反馈并持续改进Octocode 社区欢迎各种创新工具你的贡献可能会帮助到许多开发者总结与下一步通过本指南你已经了解了开发 Octocode 自定义 MCP 工具的完整流程。从环境搭建到工具发布每个步骤都至关重要。建议进一步深入学习以下内容MCP 工具质量与代理工作流Octocode 引擎文档LSP 服务器生命周期现在开始动手开发你的第一个自定义 MCP 工具吧如有任何问题欢迎在社区中提问。【免费下载链接】octocodeCode research platform for AI agents; find, understand, and prove context across your code and all of GitHub, in a fraction of the tokens. One toolset, MCP or CLI项目地址: https://gitcode.com/gh_mirrors/oc/octocode创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考