MCP Reporter

Name: MCP Reporter
Author: cyanheads

@cyanheads

About MCP Reporter

mcp-reporter is a streamlined utility that generates comprehensive capability reports for Model Context Protocol servers, empowering developers to easily understand available functionality across their MCP servers ecosystem for both documentation and integration into other tools.

#agent #ai #mcp #api-documentation #developer-tools #llm #llm-agent #model-context-protocol #mcp-reporter

Basic information

Config

No standard config provided

This server doesn't expose a parseable MCP config block in its README. See the repository for install instructions.

Repository

Tools

No tools detected

We auto-extract tools from the README. The maintainer can list them under a ## Tools heading to populate this section.

Overview

What is MCP Reporter?

MCP Reporter is a utility for generating comprehensive markdown reports about Model Context Protocol (MCP) server capabilities. It helps developers understand what tools, resources, and resource templates are available across their MCP server ecosystem. It can also be used programmatically to produce documentation or feed data into other tools.

How to use MCP Reporter?

Install from source with Node.js 16.x or higher, create a configuration file (mcp-servers.json) listing the MCP servers to analyze, then run via the CLI (mcp-reporter) with options for output path and content inclusion, or import the McpReporter class in your own TypeScript/JavaScript code.

Key features of MCP Reporter

Automatically connects to all enabled MCP servers for discovery
Extracts tools, resources, and resource templates from each server
Generates well-organized markdown documentation
Provides real-time progress feedback during execution
Supports CLI and programmatic usage

Use cases of MCP Reporter

Auditing available capabilities across multiple MCP servers
Auto-generating documentation for MCP server ecosystems
Feeding server capability data into downstream tools or pipelines
Understanding what tools and resources are exposed by each server

FAQ from MCP Reporter

What are the runtime requirements?

Node.js 16.x or higher and npm or yarn are required.

How do I configure which servers to analyze?

Create a mcp-servers.json file (based on the provided example) that defines each server’s command, arguments, and environment variables.

Can I use MCP Reporter programmatically in my own code?

Yes, import the McpReporter class and call run() with a config path and options such as outputPath, includeInputSchemas, and includeServerMetadata.

What does the generated report contain?

A summary of all analyzed servers, plus per-server metadata, available tools with descriptions and input schemas, available resources with URIs and descriptions, and resource templates with URI templates.