Cangje Docs MCP

🚀 倉頡語言文檔檢索系統 - Claude Code配置教程

這是一個專為Claude Code設計的倉頡語言文檔檢索MCP服務器，藉助它，你能夠直接在Claude Code中高效查詢倉頡編程語言的所有文檔。

🚀 快速開始

📦 安裝指南

第一步：下載mcp可執行文件

• 下載倉頡文件mcp可執行文件。

第二步：準備文檔目錄

方式一：下載官方文檔

# 克隆官方文檔倉庫
git clone https://gitcode.com/Cangjie/CangjieCorpus.git

方式二：使用現有文檔

將倉頡語言文檔複製到可執行文件所在目錄：

# 確保在項目根目錄下有CangjieCorpus目錄
# 或者使用 -dir 參數指定文檔目錄

第三步：配置Claude Code

1. 打開Claude Code設置。
2. 找到MCP服務器配置。
3. 添加以下配置：

{
  "mcpServers": {
    "cangjie-docs": {
      "command": "/path/to/cangje-docs-mcp",
      "args": ["-dir", "/path/to/CangjieCorpus"]
    }
  }
}

第四步：重啟Claude Code

重啟Claude Code以加載新的MCP服務器。

⚠️ 重要提示

在CLAUDE.md 添加 本倉庫裡的 cj_syntax.md, 相當於在上下文常駐一份倉頡基礎語法（如果針對倉頡微調過的llm就可以不需要這個）

💻 使用示例

基礎用法

在Claude Code中進行基礎查詢：

請幫我查找倉頡語言中函數定義的語法

高級用法

在Claude Code中進行分類搜索：

我想了解倉頡語言的基礎數據類型

還可以進行學習路徑詢問：

我是初學者，請給我推薦倉頡語言的學習順序

提出具體問題：

倉頡語言中如何處理併發編程？

進行API查詢：

倉頡標準庫中有哪些文件操作相關的API？

🎯 常用查詢示例

語法查詢

• "倉頡語言的變量聲明語法"
• "如何定義一個類"
• "倉頡的控制流語句"

概念學習

• "解釋倉頡語言的泛型編程"
• "倉頡的錯誤處理機制"
• "倉頡的包管理系統"

實踐問題

• "如何在倉頡中讀寫文件"
• "倉頡網絡編程的例子"
• "倉頡與JavaScript交互"

API參考

• "倉頡String類的方法"
• "倉頡數組操作API"
• "倉頡HTTP客戶端使用"

🔧 高級功能

指定分類搜索

請在manual分類中搜索關於繼承的內容

獲取相關建議

基於"函數定義"這個主題，推薦相關的學習內容

導航瀏覽

顯示倉頡文檔的完整目錄結構

📋 檢查配置

驗證版本信息

./cangje-docs-mcp -version

應該顯示：

倉頡語言文檔檢索系統 v1.0.0
基於MCP協議的本地文檔檢索服務器
文檔版本: v1.0.0 (發佈日期: 2025-07-01)

查看幫助

./cangje-docs-mcp -help

🛠️ 故障排除

常見問題

Q: Claude Code找不到MCP服務器 A: 檢查配置文件中的路徑是否正確，確保可執行文件有執行權限。

Q: 搜索結果為空 A: 確認文檔目錄存在且包含倉頡文檔，檢查文檔目錄權限。

Q: 啟動時提示文檔目錄不存在 A: 使用 -dir 參數指定正確的文檔目錄路徑。

Q: MCP服務器啟動失敗 A: 檢查配置格式是否正確，確保使用了正確的參數格式。

正確的MCP配置格式

{
  "mcpServers": {
    "cangje-docs": {
      "type": "stdio",
      "command": "/path/to/cangje-docs-mcp",
      "args": ["-dir", "/path/to/CangjieCorpus"],
      "env": {}
    }
  }
}

⚠️ 重要提示

確保包含 "type": "stdio" 和 "env": {} 字段。

調試模式

# 直接運行MCP服務器查看啟動日誌
./cangje-docs-mcp -dir /path/to/CangjieCorpus

# 檢查版本信息
./cangje-docs-mcp -version

# 查看幫助信息
./cangje-docs-mcp -help

📖 文檔目錄結構

確保你的文檔目錄結構如下：

CangjieCorpus/
├── README.md
├── manual/              # 基礎手冊
│   ├── first_understanding/
│   ├── basic_data_type/
│   ├── function/
│   └── ...
├── libs/                # 標準庫API
│   └── std/
├── tools/               # 開發工具
└── extra/               # 額外內容

🎉 配置完成後，你就可以在Claude Code中自然地查詢倉頡語言的所有文檔內容了！系統會自動理解你的問題並提供相關的文檔內容和建議。