使用说明

项目简介

Marginalia MCP服务器是一个实现了 Model Context Protocol (MCP) 的应用后端,它将 Marginalia Search 搜索引擎的功能封装成一个工具,供支持 MCP 协议的 LLM 客户端调用。Marginalia Search 专注于发现非商业内容和互联网的隐秘角落,通过此 MCP 服务器,LLM 应用可以便捷地利用 Marginalia Search 的能力进行网络信息检索。

主要功能点

  • 网络搜索工具: 提供 'search-marginalia' 工具,允许 LLM 客户端通过关键词查询 Marginalia 搜索引擎。
  • 可配置搜索参数: 支持配置搜索的索引和返回结果数量。
  • 速率限制保护: 具备速率限制保护机制,并提供友好的错误提示。
  • 基于 MCP SDK 构建: 使用 MCP SDK 开发,确保与 MCP 协议的兼容性和易用性。

安装步骤

  1. 安装依赖: 确保已安装 Node.js 和 npm,然后在项目根目录下运行以下命令安装项目依赖:
    npm install
  2. 构建项目: 运行以下命令构建项目,生成可执行的 JavaScript 文件:
    npm run build

服务器配置

为了让 MCP 客户端(如 Claude 客户端)连接到 Marginalia MCP 服务器,您需要在客户端中配置 MCP 服务器信息。以下是针对 Cline (VSCode 扩展) 和 Claude Desktop 客户端的配置示例。您需要将以下 JSON 配置添加到 MCP 客户端的配置文件中。

{
  "marginalia": {  // 服务器名称,可以自定义,用于在客户端中标识该服务器
    "command": "node", // 启动服务器的命令,这里使用 node
    "args": [          // 启动服务器命令的参数
      "/path/to/marginalia-mcp-server/build/index.js" // Marginalia MCP 服务器构建后的入口文件路径,请替换为实际路径
    ]
  }
}

注意:

  • 请将 '/path/to/marginalia-mcp-server/build/index.js' 替换为您实际的 'marginalia-mcp-server' 项目 'build/index.js' 文件的绝对路径。
  • 您可以通过设置环境变量 'MARGINALIA_API_KEY' 来配置 Marginalia Search API 密钥。如果您没有 API 密钥,服务器将默认使用公共访问模式。如需专用 API 密钥,请联系 [email protected]

基本使用方法

配置完成后,在支持 MCP 协议的 LLM 客户端中,您可以使用 'marginalia' 这个服务器提供的 'search-marginalia' 工具进行网络搜索。

例如,在客户端中,可以使用类似以下的代码调用 'search-marginalia' 工具:

const result = await mcp.useTool("marginalia", "search-marginalia", {
  query: "有趣的非商业网站",
  count: 5
});
console.log(result);

工具 'search-marginalia' 接受以下参数:

  • 'query' (必填): 搜索关键词。
  • 'index' (可选): 搜索索引,对应 Marginalia Search 网页上的下拉菜单选项。
  • 'count' (可选): 返回结果数量,范围 1-100,默认为 10。

搜索结果将以 JSON 格式返回,包含查询关键词、许可信息以及搜索结果列表,每个结果包含 URL、标题和描述信息。

信息

分类

网页与API