Developer Research MCP Server

Developer Research MCP 服务

此代码仓库包含一个 Model Context Protocol（MCP）服务，旨在为 AI Agent 或其他开发工具提供结构化研究能力，主要是网络搜索。MCP 可在客户端（例如 AI Agent）与提供专业工具的服务之间实现标准化通信。

此服务最初使用 OpenRouter 提供网络搜索功能，但采用了可扩展架构，便于将来轻松集成其他研究提供方（例如其他搜索引擎、数据库）。

目录

• Developer Research MCP 服务
  • 目录
  • 功能
  • 架构与可扩展性
  • 先决条件
  • 安装
  • 配置
  • 使用
    • 与 Roo Code 搭配使用
  • 可用工具
    • search_web
      • 参数
      • 示例（Roo Code 使用概念示例）
      • 响应格式
  • 许可证

功能

• 通过 OpenRouter 等提供方提供网络搜索能力。
• 针对检索技术和软件开发内容进行了优化。
• 采用可扩展设计，支持多个研究提供方。
• 实现了可靠的错误处理和重试机制。
• 以结构良好、一致的 JSON 格式提供结果，适用于程序化使用。

架构与可扩展性

此服务采用模块化架构。每个研究提供方（例如 OpenRouter）都作为独立模块实现，并遵循通用接口。这种设计使以下操作变得简单：

1. 添加对新搜索引擎或数据源的支持。
2. 根据配置或请求参数切换提供方（未来增强功能）。
3. 独立维护和更新特定于提供方的逻辑。

先决条件

• Node.js v18 或更高版本
• npm（随 Node.js 一同安装）
• 所需研究提供方的 API 密钥（例如 OpenRouter）

安装

1. 克隆代码仓库：

   git clone https://github.com/yourusername/developer-research-server.git # Replace with the actual URL
   cd developer-research-server
   

2. 安装依赖项： 使用 npm 安装项目依赖项。

   npm install
   

3. 构建项目： 将 TypeScript 代码编译为 JavaScript。

   npm run build
   

   编译后的输出位于 build/ 目录中。

配置

此服务使用环境变量进行配置。

1. 创建 .env 文件： 将 mcp-config-sample.json（如果存在，也可以手动创建）复制到项目根目录下的 .env 文件中。

   # Example .env file content:
   OPENROUTER_API_KEY=your_openrouter_api_key_here
   OPENROUTER_API_URL=https://openrouter.ai/api/v1
   

   注意：请确保将 .env 文件添加到 .gitignore，以免提交机密信息。

2. 必需的环境变量：

   • OPENROUTER_API_KEY（OpenRouter 提供方必需）：你的专属 OpenRouter API 密钥。
   • OPENROUTER_API_URL（可选）：OpenRouter API 的基础 URL。默认为 https://openrouter.ai/api/v1。

   未来的提供方可能需要不同的环境变量。

使用

直接运行时，此 MCP 服务通过标准输入/输出（stdio）监听请求。它旨在集成到 Roo Code 等工具中。

与 Roo Code 搭配使用

若要在 Roo Code 中使用此服务，请将以下配置添加到 .roo/mcp.json 文件中。请调整 args 路径，使其指向克隆的代码仓库目录中的已编译 index.js 文件。

{
  "mcpServers": {
    "developer-research": {
      // Changed name to be more generic
      "command": "node",
      "args": ["/full/path/to/your/developer-research-server/build/index.js"], // <-- IMPORTANT: Update this path
      "env": {
        // Environment variables are typically loaded from the .env file
        // Or can be explicitly set here if needed, but .env is recommended for secrets
        // "OPENROUTER_API_KEY": "your-openrouter-api-key", // <-- Replace or load from .env
        // "OPENROUTER_API_URL": "https://openrouter.ai/api/v1"
      },
      "alwaysAllow": ["search_web"], // List tools the agent can always use
      "timeout": 60 // Timeout in seconds
    }
  }
}

重要：

• 将 /full/path/to/your/developer-research-server/build/index.js 替换为系统上的正确绝对路径。
• 请安全地配置 OPENROUTER_API_KEY，最好通过服务进程自身加载的 .env 文件进行配置，而不是将其硬编码到 mcp.json 中。

可用工具

目前，此服务提供以下工具：

search_web

使用已配置的提供商（当前为 OpenRouter）执行网络搜索，并返回相关结果。

参数

• query（字符串，必填）：搜索查询。
• num_results（整数，可选）：期望的搜索结果数量。必须介于 1 和 10 之间。默认为 5。
• focus（字符串，可选）：指定搜索重点领域。支持的值为 "technical"、"development"、"general"。默认为 "technical"。

示例（Roo Code 用法概念示例）

// Within a Roo Code agent or script
const searchResults = await useMcpTool("developer-research", "search_web", {
  query: "advanced typescript patterns",
  num_results: 3,
  focus: "technical",
});

console.log(searchResults);

响应格式

该工具返回一个具有以下结构的 JSON 对象：

{
  "success": true, // Boolean indicating if the search was successful
  "results": [
    // Array of result objects
    {
      "title": "Title of the search result",
      "url": "https://example.com/page",
      "content": "A snippet or summary of the page content...",
      "domain": "example.com"
    }
    // ... more results
  ],
  "total_results": 3 // The actual number of results returned
}

发生错误时，响应可能如下所示：

{
  "success": false,
  "error": "Description of the error that occurred."
}

许可证

MIT