MCP 发现入门指南

项目简介

欢迎来到MCP（Model Context Protocol）发现的官方文档！本指南将帮助您了解如何使用该协议以及如何与其实现交互。

主要功能

• 信息查询：获取服务器的基本信息
• 工具列举：列出所有可用的工具
• 版本支持：检查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发现！希望您在使用过程中一切顺利，如果需要更多帮助，请随时查阅文档或联系社区支持。