Skip to content

docs: add mcp discovery cli #1657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

hashemix
Copy link

@hashemix hashemix commented May 3, 2025

Description

Adding MCP Discovery CLI to the Resources section of the README.

It is a command-line tool written in Rust for discovering and documenting MCP Server capabilities. It supports outputting the results in the terminal or saving them to files in Markdown, HTML, or plain text formats.
It is also available as a GithubAction to automate and maintain up-to-date MCP Server documentation.

Here is a sample output that is generated for @modelcontextprotocol/server-everything server:
server-everything capabilities

Server Details

- Server:
- Changes to:
Not a server, but a CLI utility for discovering and documenting MCP Server capabilities.

Motivation and Context

It is a command-line tool written in Rust for discovering and documenting MCP Server capabilities. It supports outputting the results in the terminal or saving them to files in Markdown, HTML, or plain text formats.

It can be used to inspect capabilities of a MCP Server right from the terminal, can generate html, md, txt files and supports custom templates.

It is also available as a GithubAction to automate and maintain up-to-date MCP Server documentation.

How Has This Been Tested?

First one is generated by CLI and second one is automatically generated with mcp-discovery-action GitHub Action

Breaking Changes

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Protocol Documentation
  • My changes follows MCP security best practices
  • I have updated the server's README accordingly
  • I have tested this with an LLM client
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have documented all environment variables and configuration options

Additional context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant