ZIM文件读取与搜索服务

一个用于读取和搜索ZIM文件的模型上下文协议服务器,适用于离线存储和检索Wikipedia等参考内容。

  • by zicojiao
  • TypeScript
  • 本地部署
  • 17 星标
  • 更新于
在 GitHub 查看 zicojiao/zim-mcp-server

使用说明

ZIM MCP服务器

⚠️ 实验警告

这是一个实验版本,仅在WSL2上进行了测试。下面的安装和使用说明是专门针对WSL2环境的。

用于读取和搜索ZIM文件的模型上下文协议服务器。ZIM是由开发的一种文件格式 Kiwix 用于离线存储维基百科和其他参考内容。

安装(WSL2)

  1. 安装依赖项:
pnpm install
  1. 构建项目:
pnpm run build
  1. 准备ZIM文件: 从下载ZIM文件 Kiwix图书馆 并将它们放置在目录中。, /path/to/zim

用法

Claude桌面配置

将以下内容添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "zim-mcp-server": {
      "command": "wsl.exe",
      "args": [
        "bash",
        "-c",
        "node /path/to/zim-mcp-server/build/index.js /path/to/zim"
      ]
    }
  }
}

例子:

{
  "mcpServers": {
    "zim-mcp-server": {
      "command": "wsl.exe",
      "args": [
        "bash",
        "-c",
        "node /home/username/Code/zim-mcp-server/build/index.js /home/username/Code/zim"
      ]
    }
  }
}

替换 /path/to/zim-mcp-server 与您的项目路径和 /path/to/zim 使用您的ZIM文件目录路径。

可用工具

  1. list-zim-files:列出允许目录中的所有ZIM文件
  2. search-zim-file:在ZIM文件内容中搜索
    • 必修的: zimFilePath, query
    • 可选: limit (默认值:10), offset (默认值:0)
  3. get-zim-entry:获取特定条目的详细内容
    • 必修的: zimFilePath, entryPath
    • 可选: maxContentLength (默认值:10000)

许可证

麻省理工学院