使用说明

项目简介

Wikipedia MCP Server 是一个基于 Model Context Protocol (MCP) 的简单服务器实现,旨在为 LLM 应用提供便捷的维基百科信息访问能力。它通过 MCP 协议向客户端暴露工具,允许客户端获取随机维基百科页面或查询特定页面的详细内容。

主要功能点

  • 随机维基百科页面获取: 提供 'random_wikipedia_page' 工具,一键获取随机维基百科页面的标题、摘要和 URL,帮助用户发现新的知识领域。
  • 指定维基百科页面内容检索: 提供 'wikipedia_page_details' 工具,根据用户提供的页面标题或 URL,返回该页面的详细内容,并允许用户自定义内容长度,满足不同场景的需求。
  • 易于集成: 遵循 MCP 协议标准,可以与任何兼容 MCP 协议的客户端轻松集成,为 LLM 应用快速添加维基百科知识库访问能力。
  • 零依赖: 除了 MCP SDK 之外,没有额外的依赖,安装和部署非常简便。

安装步骤

本仓库提供了多种安装和运行方式:

  1. 直接运行 (无需安装): 如果您只是想快速体验或临时使用,可以使用 'npx' 命令直接从 GitHub 运行,无需本地安装任何内容。

    npx github:cccntu/wikimcp
  2. 本地开发: 如果您希望修改代码或进行本地开发,可以将仓库克隆到本地,并安装依赖后运行。

    git clone https://github.com/cccntu/wikimcp.git
    cd wikimcp
    npm install
    npm start
  3. 全局安装: 如果您希望将 'wikimcp' 命令添加到全局环境,可以进行全局安装。

    npm install -g github:cccntu/wikimcp
    wikimcp

服务器配置

MCP 客户端需要配置服务器的启动命令才能连接到 Wikipedia MCP Server。以下是不同运行方式对应的客户端配置示例 (JSON 格式):

{
  "serverName": "wikimcp",
  "command": "npx",
  "args": ["github:cccntu/wikimcp"]
  // 使用 npx 直接从 GitHub 运行,无需本地安装

  // 或者,如果使用全局安装,配置如下:
  // {
  //   "serverName": "wikimcp",
  //   "command": "wikimcp", // 假设全局安装后命令为 wikimcp
  //   "args": []
  // }

  // 或者,如果本地开发环境运行,配置如下:
  // {
  //   "serverName": "wikimcp",
  //   "command": "node",
  //   "args": ["src/server.js"] // 指向服务器入口文件
  // }
}

配置参数说明:

  • 'serverName': 服务器名称,可以自定义,用于客户端标识。
  • 'command': 启动服务器的命令。根据不同的安装方式选择 'npx', 'wikimcp' 或 'node'。
  • 'args': 命令参数,以数组形式提供。例如 'npx' 需要指定 GitHub 仓库地址作为参数,'node' 需要指定服务器入口文件路径。

基本使用方法

  1. 启动服务器: 根据您的安装方式,在终端运行相应的命令启动 Wikipedia MCP Server。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置上述提供的服务器连接信息。
  3. 连接服务器: 使用 MCP 客户端连接到 Wikipedia MCP Server。
  4. 调用工具: 连接成功后,您可以使用客户端提供的 API 调用服务器暴露的工具,例如:
    • 调用 'random_wikipedia_page' 工具获取随机页面信息。
    • 调用 'wikipedia_page_details' 工具并传入页面标题或 URL,获取指定页面的详细内容。

具体工具的调用方法和参数请参考客户端 SDK 的文档和服务器提供的工具描述信息。

信息

分类

网页与API