JinDaGe - wikijs-mcp-server MCP Details

article

README

🚀 📚 WikiJS MCP Server

这个工具可以将Claude连接到你的Wiki.js文档系统！它能让Claude直接读取和更新Wiki.js页面，就像是给Claude开启了访问团队知识库的权限，对于保持文档更新或快速查找信息来说非常实用。

🚀 快速开始

本工具安装完成后，你可以向Claude发出以下指令：

🔍 搜索：在你的Wiki中查找特定主题。
📖 阅读：读取文档页面内容。
✏️ 更新：用新信息更新现有页面。
📝 创建：创建新的文档。
🗂️ 整理：通过移动页面来组织文档结构。
🗑️ 删除：删除过时的页面。

📦 安装指南

前提条件

在开始安装前，请确保你已经具备以下条件：

✅ 已安装 Git（点击此处下载）
✅ 已安装 Python 3.8 或更高版本（点击此处下载）
✅ 已安装 Claude Code（点击此处获取）
✅ 拥有 Wiki.js 网站的访问权限（需要一个API密钥，后续会说明获取方法）

步骤 1：下载代码

打开终端（Windows系统使用命令提示符，Mac系统使用终端），并运行以下命令：

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

💡 使用建议

如果你遇到“command not found”错误，请确保已经安装了Git！

步骤 2：获取Wiki.js API密钥

以管理员身份登录你的Wiki.js网站。
导航到管理页面（通常位于顶部菜单）。
点击左侧侧边栏的API访问选项。
如果API处于禁用状态，请点击开关启用它。
点击**“+ 新API密钥”**。
为其命名，例如“Claude Integration”。
选择以下权限：
- ✅ 读取页面
- ✅ 写入页面
- ✅ 管理页面（如果你希望Claude能够创建/删除页面）
点击创建并复制API密钥，下一步会用到它！

⚠️ 重要提示

请将此密钥妥善保存，因为你无法再次查看它！

步骤 3：配置连接

创建配置文件：

cp .env.example .env

使用任意文本编辑器（如记事本、TextEdit、VS Code等）打开 .env 文件。
将示例值替换为你的实际信息：

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...

步骤 4：安装Python依赖项

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

pip install -e .

💡 使用建议

如果你遇到“pip: command not found”错误，请尝试使用 pip3。

在Mac系统上，你可能需要使用 python3 -m pip install -e .。

步骤 5：测试连接

让我们确保一切正常！运行以下命令：

python -m wikijs_mcp.server

你应该会看到类似以下的输出：

WikiJS MCP Server starting...
Connected to Wiki.js at https://your-wiki-site.com
Ready to accept connections!

按 Ctrl+C 停止服务。

💻 使用示例

与Claude Code配合使用

最棒的是，Claude Code会自动检测到这个MCP服务器！ 该仓库包含一个特殊的 .mcp.json 文件，Claude Code会自动读取它。你只需：

在 wikijs-mcp 文件夹中打开Claude Code。
Claude将自动获得访问你的Wiki.js的权限！

尝试以下命令

连接成功后，你可以向Claude提出以下请求：

"Search my wiki for information about deployment procedures"
"Read the page at /docs/getting-started"
"Update the troubleshooting guide with a new solution for login issues"
"Create a new page at /docs/api/webhooks with webhook documentation"

🔧 手动配置（高级）

如果你使用的是其他MCP客户端或需要自定义设置，可以参考以下配置：

标准安装配置

{
  "mcpServers": {
    "wikijs": {
      "command": "python",
      "args": ["-m", "wikijs_mcp.server"],
      "env": {
        "WIKIJS_URL": "https://your-wiki-site.com",
        "WIKIJS_API_KEY": "your-api-key"
      }
    }
  }
}

Docker用户配置

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

🆘 常见问题及解决方案

“Connection refused” 或 “Cannot connect to Wiki.js”

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

“Authentication failed” 或 “Invalid API key”

✅ 仔细检查你是否完整复制了API密钥。
✅ 确保密钥前后没有多余的空格。
✅ 验证API密钥是否具有正确的权限。

“Module not found” 错误

✅ 确保你在 wikijs-mcp 文件夹中运行了 pip install -e .。
✅ 尝试使用 python3 代替 python。

Claude Code 无法识别Wiki.js工具

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

📚 可用工具参考

Claude连接成功后可以执行以下操作： | 工具 | 功能 | 示例 | |------|--------------|---------| | 🔍 wiki_search | 按标题或内容查找页面 | "Search for 'authentication'" | | 📖 wiki_get_page | 读取特定页面 | "Get page at path '/docs/api'" | | 📋 wiki_list_pages | 查看所有页面 | "List all wiki pages" | | 🌳 wiki_get_tree | 查看Wiki结构 | "Show wiki page tree" | | ✏️ wiki_create_page | 创建新页面 | "Create page at '/guides/setup'" | | 🔄 wiki_update_page | 编辑现有页面 | "Update page ID 123" | | 🚚 wiki_move_page | 移动页面 | "Move page to '/archive/old'" | | 🗑️ wiki_delete_page | 删除页面 | "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！

祝你文档编写愉快！ 🎉

wikijs-mcp-server