MCP Reporter

by cyanheads

12 399 downloads Not rated yet Apache-2.0

About

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.

Details

License
Apache-2.0

Explore

- Server Discovery: Automatically connects to all enabled MCP servers
- Capability Analysis: Extracts tools, resources, and resource templates
- Markdown Report Generation: Produces well-organized documentation
- Progress Monitoring: Provides real-time feedback during execution

- Node.js 16.x or higher
- npm or yarn


npm install

cp mcp-servers.json.example mcp-servers.json

Example configuration:

{
  "mcpServers": {
    "atlas-mcp-server": {
      "command": "/path/to/node",
      "args": ["/path/to/atlas-mcp-server/dist/index.js"],
      "env": {
        "NEO4J_URI": "bolt://localhost:7687",
        "NEO4J_USER": "neo4j",
        "NEO4J_PASSWORD": "your-password-here"
      }
    },
    "another-server": {
      "command": "/path/to/node",
      "args": ["/path/to/another-server.js"],
      "env": {}
    }
  }
}
import { McpReporter } from "mcp-reporter";

async function generateReport() {
const reporter = new McpReporter("./my-config.json", {
outputPath: "./reports/mcp-report.md",
includeInputSchemas: true,
includeServerMetadata: true,
});

await reporter.run();
}

generateReport().catch(console.error);

TypeScript
Model Context Protocol
[Version]()
License
[Status]()
GitHub

MCP Reporter is a utility for generating comprehensive reports about Model Context Protocol (MCP) server capabilities, helping developers understand what functionality is available across their MCP server ecosystem. Can also be used programmatically to generate reports for documentation or for feeding into other tools.

Table of Contents

- Features
- Installation
- Configuration
- Usage
- Report Structure
- Project Structure
- Example Report
- Development
- License
- Author

Features

- Server Discovery: Automatically connects to all enabled MCP servers
- Capability Analysis: Extracts tools, resources, and resource templates
- Markdown Report Generation: Produces well-organized documentation
- Progress Monitoring: Provides real-time feedback during execution

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.