MCP Discovery

🚀 MCP Discovery Getting Started Guide

This guide is designed to help you understand how to use the Model Context Protocol (MCP) Discovery and interact with its implementation.

✨ Features

• Information Query: Retrieve basic information about the server.
• Tool Listing: List all available tools.
• Version Support: Check the compatibility of the MCP protocol.
• Resource Management: Handle model and data resources.

🚀 Quick Start

Here is a simple example demonstrating how to interact with the MCP server via the command line:

# Get basic service information
mcp-discovery info -- npx -y @modelcontextprotocol/server

# List all available tools
mcp-discovery tools -- npx -y @modelcontextprotocol/server

# Check protocol version compatibility
mcp-discovery version -- npx -y @modelcontextprotocol/server

📚 Documentation

info Command

Retrieve basic information about the MCP server, including its name, version, and description.

mcp-discovery info [options] <command>

Optional Parameters

• -v, --verbose: Enable verbose output mode.
• -o, --output <format>: Specify the output format (supports json, yaml).

tools Command

List all available tools on the server and their detailed information.

mcp-discovery tools [options] <command>

Optional Parameters

• --filter <name>: Filter tools by name.
• --sort <field>: Sort the output by the specified field.

version Command

Check the version information of the MCP protocol.

mcp-discovery version [options] <command>

Optional Parameters

• -c, --compatible: Display the compatibility list.
• -d, --details: Display the full version description.

render Command

Render the capabilities of the MCP server in a specified format to a file.

mcp-discovery render [options] <command>

Optional Parameters

• -t, --template <name>: Specify the template name to use.
• -f, --file <path>: Specify the output file path.

💻 Usage Examples

Example 1: Get Basic Information

# Get basic service information
mcp-discovery info -- npx -y @modelcontextprotocol/server

# Output result:
{
  "name": "MCP Server",
  "version": "1.0.0",
  "description": "A sample MCP server implementation"
}

Example 2: List Tools

# List all available tools
mcp-discovery tools -- npx -y @modelcontextprotocol/server

# Output result:
[
  {
    "name": "ModelAnalyzer",
    "version": "2.1.0",
    "description": "Model analysis tool"
  },
  {
    "name": "DataValidator",
    "version": "1.5.2",
    "description": "Data validation tool"
  }
]

Example 3: Version Check

# Check protocol version information
mcp-discovery version -- npx -y @modelcontextprotocol/server

# Output result:
{
  "major": 1,
  "minor": 0,
  "patch": 0,
  "compatibleWith": [">=0.5.0", "<2.0.0"]
}

Customize Output with Templates

MCP Discovery supports customizing the output format through templates. Users can create their own template files to specify how each field should be displayed.

Create a Template

Create a templates folder in the project root directory and add a custom template file:

// templates/my_template.txt
Server Name: {{.Name}}
Version: {{.Version}}
Description: {{.Description}}

Available Tools:
{{range .Tools}}
- Name: {{.Name}}, Version: {{.Version}}, Description: {{.Description}}
{{end}}

Use a Template

Specify the template file in the command line:

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

Troubleshooting

Common Issues

1. Command not recognized Ensure that the MCP Discovery tool is installed correctly and added to the system path.
2. Connection timeout Check if the target server is reachable and the network connection is normal.
3. Incomplete output Confirm that the target server supports the requested protocol version and command.

Submit an Issue

If you encounter any problems, please submit an issue or a pull request on GitHub to help us improve the tool.

🤝 Contribution Guidelines

Community contributions are welcome! Please refer to CONTRIBUTING.md to learn how to participate in the development.

📄 License

This project is licensed under the MIT License. For more information, please refer to the LICENSE file.

Thank you for using MCP Discovery! We hope you have a smooth experience. If you need more help, please refer to the documentation or contact the community support.