ZIM MCP Server

⚠️ 实验警告

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

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

安装（WSL2）

1. 安装依赖项：

pnpm install

2. 构建项目：

pnpm run build

3. 准备ZIM文件： 从Kiwix图书馆下载ZIM文件，并将其放置在一个目录中，例如：/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）

许可证

MIT