Astro Docs

🚀 Astro 文檔 MCP 服務器

這是一個專為 AI 代理打造的 MCP 服務器，其核心功能是讓 AI 代理能夠便捷地訪問 Astro 文檔。藉助該服務器，AI 助手可以精準查找並參考 Astro 相關文檔，從而高效協助用戶完成各類與 Astro 相關的任務。

🚀 快速開始

此 MCP 服務器基於 TypeScript 構建，實現了一套用於檢索 Astro 文檔的系統。它通過以下方式充分展示了核心 MCP 概念：

• 運用 astro-docs:// URI 和元數據來表示 Astro 文檔的各個部分。
• 提供強大的工具用於搜索 Astro 文檔。
• 針對常見的 Astro 問題和任務給出實用提示。

✨ 主要特性

資源

• 可清晰列出並輕鬆訪問 Astro 文檔中的各個部分。
• 每個文檔部分均包含標題、內容和類別。
• 採用純文本 MIME 類型，實現簡單的內容訪問。

工具

• search_docs - 用於搜索 Astro 文檔。
  • 需將搜索查詢作為必填參數傳入。
  • 會返回匹配的文檔部分。

提示語

• explain_astro_islands - 可獲取 Astro 島嶼架構的詳細解釋。
• astro_project_setup - 提供新建 Astro 項目的指南。
• astro_vs_other_frameworks - 能比較 Astro 和其他 Web 框架。

📦 安裝指南

配置要求

• 需要 Node.js v16 或更高版本。
• 推薦使用 Node.js v20+ 以獲得最佳兼容性。
• 服務器使用 ES 模塊語法。
• 配置文件示例：config.json

安裝步驟

1. 克隆此倉庫到本地：

   git clone https://github.com/yourusername/astro-docs-mcp.git
   cd astro-docs-mcp
   

2. 安裝依賴項：

   pnpm install
   

3. 啟動服務器：

   npm start
   

配置示例

{
  "mcp_server": {
    "port": 3000,
    "documentation_path": "./docs",
    "logging": {
      "level": "info",
      "enabled": true
    }
  }
}

💻 使用示例

基本命令

1. 列出可用文檔部分：

   npm run list
   

2. 搜索文檔內容：

   npm run search <查詢>
   

3. 查看特定文檔：

   npm run read astro-docs:///<id>
   

📚 詳細文檔

項目結構

• src/ - 服務器源代碼
  • index.ts - 主 MCP 服務器實現
  • scripts/ - 輔助構建和測試的腳本
    • build.js - 構建腳本，用於轉譯 TypeScript 並生成啟動腳本
    • test-client.js - 測試客戶端，用於驗證服務器功能
• bin/ - 生成的可執行腳本
  • astro-docs-mcp - 主啟動腳本
• build/ - 編譯後的 JavaScript 文件（自動生成）

故障排除

1. 端口衝突：如果默認端口 3000 被佔用，嘗試在其他端口運行：

   npm start -- --port=3001
   

2. 依賴問題：確保所有依賴項已正確安裝：

   pnpm install
   

3. 日誌輸出：檢查 config.json 中的日誌設置是否啟用：

   "logging": {
     "level": "debug",
     "enabled": true
   }
   

🔮 未來改進

• 實現從 Astro 官網即時獲取文檔。
• 增加更多詳細的文檔部分。
• 支持文檔版本控制。
• 添加常見 Astro 模式的代碼示例和片段。