WikiJS MCP 服务器

Name: WikiJS MCP 服务器
Author: jaalbin24

作者：jaalbin247 星标更新：2025-06-30

安装使用来源：spider==github.com

项目介绍

📚 WikiJS MCP 服务器

将 Claude 连接到您的 Wiki.js 文档！

此工具允许 Claude 直接读取和更新您的 Wiki.js 页面。可以将其视为给 Claude 提供了访问您团队知识库的权限——非常适合保持文档的最新状态或快速查找信息。

🎯 功能概述

安装后，您可以请求 Claude 执行以下操作：

🔍 搜索您的维基以查找特定主题
📖 阅读文档页面
✏️ 更新现有页面的新信息
📝 创建新的文档
🗂️ 组织页面，通过移动它们来整理
🗑️ 删除过时的页面

🚀 安装指南

先决条件

在开始之前，请确保您已具备：

✅ 已安装 Git (下载地址)
✅ 已安装 Python 3.8 或更高版本 (下载地址)
✅ 已安装 Claude Code (获取地址)
✅ 拥有一个 Wiki.js 站点 的访问权限（带有 API 密钥——我们将向您展示如何获取它）

第一步：下载代码

打开终端（Windows 上的命令提示符，Mac 上的终端）并运行：

git clone https://github.com/your-username/wikijs-mcp.git
cd wikijs-mcp

💡 提示：如果遇到“命令未找到”错误，请确保已安装 Git！

第二步：获取您的 Wiki.js API 密钥

以管理员身份登录您的 Wiki.js 站点
导航到管理（通常位于顶部菜单）
在左侧边栏中点击 API 访问
如果 API 被禁用，请点击切换按钮以启用它
点击 "+ 新建 API 密钥"
给它一个名字，如 "Claude 集成"
选择这些权限：
- ✅ 读取页面
- ✅ 写入页面
- ✅ 管理页面（如果您希望 Claude 创建或删除页面）
点击创建并 复制 API 密钥 ——接下来会用到它！

⚠️ 重要：将此密钥保存在一个安全的地方——您将无法再次看到它！

第三步：配置连接

创建配置文件：
```
cp .env.example .env
```
在任何文本编辑器中打开 .env 文件（如 Notepad、TextEdit、VS Code 等）

替换示例值为您的实际信息：

WIKIJS_URL=https://your-wiki-site.com
WIKIJS_API_KEY=paste-your-api-key-here

📌 示例：

WIKIJS_URL=https://docs.mycompany.com
WIKIJS_API_KEY=ey1234567890abcdef...

第四步：安装 Python 依赖项

运行以下命令以安装工具所需的依赖项：

pip install -e .

💡 故障排除：

如果遇到“pip: 命令未找到”，尝试使用 pip3
在 Mac 上，可能需要使用 python3 -m pip install -e .

第五步：测试连接

让我们确保一切正常工作！运行：

python -m wikijs_mcp.server

您应该看到类似以下内容：

WikiJS MCP 服务器启动中...
已连接到 https://your-wiki-site.com
准备好接受连接！

按 Ctrl+C 停止它。

🎉 使用 Claude Code

最好的部分是——Claude Code 将自动检测此 MCP 服务器！

该仓库包含一个特殊的 .mcp.json 文件，Claude Code 会自动读取。只需：

在 wikijs-mcp 文件夹中 打开 Claude Code
Claude 将自动拥有对您的 Wiki.js 的访问权限！

尝试这些命令

一旦连接，您可以请求 Claude 如下事项：

"在我的维基中搜索有关部署程序的信息"

"阅读位于 /docs/getting-started 的页面"

"更新故障排除指南，添加一个新的登录问题解决方案"

"在 /docs/api/webhooks 创建一个新页面，包含 webhook 文档"

🔧 手动配置（高级）

如果您使用的是不同的 MCP 客户端或需要自定义设置，请参考以下配置：

标准安装

{
  "mcpServers": {
    "wikijs": {
      "command": "python",
      "args": ["-m", "wikijs_mcp.server"],
      "env": {
        "WIKIJS_URL": "https://your-wiki-site.com",
        你的 API 密钥
      }
    }
  }
}

Docker 用户

{
  "mcpServers": {
    "wikijs": {
      "command": "docker",
      "args": ["compose", "run", "--rm", "-T", "wikijs-mcp-server", "python3", "-m", "wikijs_mcp.server"],
      "cwd": "/path/to/wikijs-mcp"
    }
  }
}

🆘 常见问题及解决方法

“连接被拒绝”或“无法连接到 Wiki.js”

✅ 检查您的 WIKIJS_URL 是否没有尾随斜杠
✅ 确保您的 Wiki.js 站点可以从您的计算机访问
✅ 验证 Wiki.js 管理面板中的 API 是否已启用

“认证失败”或“无效的 API 密钥”

✅ 再次检查您是否复制了整个 API 密钥
✅ 确保密钥前后没有多余的空格
✅ 验证 API 密钥具有正确的权限

“模块未找到”错误

✅ 确保您已在 wikijs-mcp 文件夹中运行 pip install -e .
✅ 尝试使用 python3 而不是 python

Claude Code 无法看到 Wiki.js 工具

✅ 确保您是从 wikijs-mcp 文件夹运行 Claude Code
✅ 检查 .mcp.json 文件是否存在
✅ 尝试重新启动 Claude Code

📚 可用工具参考

以下是 Claude 连接后可以执行的操作：

工具	功能	示例
🔍 wiki_search	通过标题或内容查找页面	"搜索 '认证'"
📖 wiki_get_page	读取特定页面	"获取位于 '/docs/api' 的页面"
📋 wiki_list_pages	查看所有页面	"列出所有维基页面"
🌳 wiki_get_tree	查看维基结构	"显示维基页面树"
✏️ wiki_create_page	创建新页面	"在 '/guides/setup' 创建页面"
🔄 wiki_update_page	编辑现有页面	"更新页面 ID 123"
🚚 wiki_move_page	移动页面	"将页面移动到 '/archive/old'"
🗑️ wiki_delete_page	删除页面	"删除页面 ID 456"

🛠️ 开发者指南

运行测试

# 安装开发依赖项
pip install -e ".[dev]"

# 运行所有测试
pytest

# 使用覆盖率运行
pytest --cov=wikijs_mcp

代码质量

# 格式化代码
black wikijs_mcp/ tests/

# 类型检查
mypy wikijs_mcp/

📄 许可证

MIT 许可证——随意使用和修改！

💬 需要帮助？

查看上面的常见问题部分
查看 Wiki.js 文档
如果卡住了，请在 GitHub 上打开一个 Issue！

祝您文档编写愉快！ 🎉