MCP Reporter logo

MCP Reporter

by cyanheads

MCP Reporter generates comprehensive reports about Model Context Protocol (MCP) server capabilities, helping developers understand available functionality. It can also be used programmatically to generate reports for documentation or feeding into other tools.

View on GitHub

Last updated: N/A

What is MCP Reporter?

MCP Reporter is a utility for analyzing and documenting MCP servers. It discovers server capabilities and generates Markdown reports.

How to use MCP Reporter?

Install the tool via npm, configure the MCP servers in mcp-servers.json, and run the mcp-reporter command or use it programmatically.

Key features of MCP Reporter

  • Server Discovery

  • Capability Analysis

  • Markdown Report Generation

  • Progress Monitoring

Use cases of MCP Reporter

  • Understanding MCP server capabilities

  • Generating documentation for MCP servers

  • Feeding MCP server data into other tools

  • Automated MCP server analysis

FAQ from MCP Reporter

What is MCP?

MCP stands for Model Context Protocol.

What kind of reports does MCP Reporter generate?

MCP Reporter generates Markdown reports summarizing server metadata, available tools, resources, and resource templates.

How do I configure the MCP servers?

You need to create a mcp-servers.json file based on the provided example, specifying the command and environment variables for each server.

Can I use MCP Reporter programmatically?

Yes, you can import the McpReporter class and use it in your JavaScript/TypeScript code.

Where are the reports saved by default?

Reports are saved to the output/mcp_server_report.md path by default, but this can be configured.