Wikijs MCP Server

🚀 📚 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密鑰

1. 以管理員身份登錄你的Wiki.js網站。
2. 導航到管理頁面（通常位於頂部菜單）。
3. 點擊左側側邊欄的API訪問選項。
4. 如果API處於禁用狀態，請點擊開關啟用它。
5. 點擊**“+ 新API密鑰”**。
6. 為其命名，例如“Claude Integration”。
7. 選擇以下權限：
   • ✅ 讀取頁面
   • ✅ 寫入頁面
   • ✅ 管理頁面（如果你希望Claude能夠創建/刪除頁面）
8. 點擊創建並複製API密鑰，下一步會用到它！

⚠️ 重要提示

請將此密鑰妥善保存，因為你無法再次查看它！

步驟 3：配置連接

1. 創建配置文件：

cp .env.example .env

2. 使用任意文本編輯器（如記事本、TextEdit、VS Code等）打開 .env 文件。
3. 將示例值替換為你的實際信息：

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會自動讀取它。你只需：

1. 在 wikijs-mcp 文件夾中打開Claude Code。
2. 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連接成功後可以執行以下操作：

🛠️ 開發者指南

運行測試

# 安裝開發依賴項
pip install -e ".[dev]"

# 運行所有測試
pytest

# 運行測試並生成覆蓋率報告
pytest --cov=wikijs_mcp

代碼質量檢查

# 格式化代碼
black wikijs_mcp/ tests/

# 類型檢查
mypy wikijs_mcp/

📄 許可證

本項目採用MIT許可證，你可以自由使用和修改！

💬 需要幫助？

• 查看上述 常見問題及解決方案 部分。
• 參考 Wiki.js文檔。
• 如果你仍然遇到問題，請在GitHub上提交一個issue！

祝你文檔編寫愉快！ 🎉