MCP Discovery

🚀 MCP 發現入門指南

本指南將助力您瞭解如何運用 MCP（Model Context Protocol）協議，以及怎樣與該協議的實現進行交互，讓您輕鬆開啟 MCP 發現之旅。

✨ 主要特性

• 信息查詢：獲取服務器的基本信息
• 工具列舉：列出所有可用的工具
• 版本支持：檢查 MCP 協議的兼容性
• 資源管理：處理模型和數據資源

🚀 快速開始

以下是一個簡單示例，展示瞭如何通過命令行與 MCP 服務器進行交互：

# 獲取基本服務信息
mcp-discovery info -- npx -y @modelcontextprotocol/server

# 列出所有可用工具
mcp-discovery tools -- npx -y @modelcontextprotocol/server

# 檢查協議版本兼容性
mcp-discovery version -- npx -y @modelcontextprotocol/server

📚 詳細文檔

詳細命令說明

info 命令

獲取 MCP 服務器的基本信息，包括名稱、版本和描述。

mcp-discovery info [options] <command>

可選參數

• -v, --verbose：啟用詳細輸出模式
• -o, --output <format>：指定輸出格式（支持 json、yaml）

tools 命令

列出服務器上所有可用的工具及其詳細信息。

mcp-discovery tools [options] <command>

可選參數

• --filter <name>：按名稱過濾工具
• --sort <field>：按指定字段排序輸出

version 命令

檢查 MCP 協議的版本信息。

mcp-discovery version [options] <command>

可選參數

• -c, --compatible：顯示兼容性列表
• -d, --details：顯示完整的版本說明

render 命令

將 MCP 服務器的 capabilities 以指定格式渲染到文件中。

mcp-discovery render [options] <command>

可選參數

• -t, --template <name>：指定使用的模板名稱
• -f, --file <path>：指定輸出文件路徑

💻 使用示例

基礎用法

示例 1：獲取基本信息

# 獲取基本服務信息
mcp-discovery info -- npx -y @modelcontextprotocol/server

# 輸出結果：
{
  "name": "MCP Server",
  "version": "1.0.0",
  "description": "A sample MCP server implementation"
}

示例 2：列出工具

# 列出所有可用工具
mcp-discovery tools -- npx -y @modelcontextprotocol/server

# 輸出結果：
[
  {
    "name": "ModelAnalyzer",
    "version": "2.1.0",
    "description": "模型分析工具"
  },
  {
    "name": "DataValidator",
    "version": "1.5.2",
    "description": "數據校驗工具"
  }
]

示例 3：版本檢查

# 檢查協議版本信息
mcp-discovery version -- npx -y @modelcontextprotocol/server

# 輸出結果：
{
  "major": 1,
  "minor": 0,
  "patch": 0,
  "compatibleWith": [">=0.5.0", "<2.0.0"]
}

高級用法

使用模板自定義輸出

MCP 發現支持通過模板來自定義輸出格式。用戶可以創建自己的模板文件，指定如何顯示各個字段。

創建模板

在項目根目錄下創建 templates 文件夾，並添加自定義模板文件：

// templates/my_template.txt
服務器名稱: {{.Name}}
版本號: {{.Version}}
描述: {{.Description}}

可用工具:
{{range .Tools}}
- 名稱: {{.Name}}，版本: {{.Version}}, 描述: {{.Description}}
{{end}}

使用模板

在命令行中指定模板文件：

mcp-discovery render --template my_template.txt -- npx -y @modelcontextprotocol/server > output.txt

🔧 故障排除

常見問題

1. 命令未識別 確保已正確安裝 MCP 發現工具，並將其添加到系統路徑中。
2. 連接超時 檢查目標服務器是否可達，網絡連接是否正常。
3. 輸出不完整 確認目標服務器支持所請求的協議版本和命令。

提交問題

如果您遇到任何問題，請通過 GitHub 提交問題或拉取請求，幫助我們改進工具。

🤝 貢獻指南

歡迎社區貢獻！請參考 CONTRIBUTING.md 瞭解如何參與開發。

📄 許可證

本項目遵循 MIT 許可證。更多信息請查看 LICENSE 文件。

感謝使用 MCP 發現！希望您在使用過程中一切順利，如果需要更多幫助，請隨時查閱文檔或聯繫社區支持。