MCP Reporter

🚀 MCP Reporter Tool

The MCP Reporter Tool is a practical utility for generating comprehensive reports on the capabilities of Model Context Protocol (MCP) servers. It helps developers understand the available features in their MCP server ecosystem. You can also use it programmatically to generate reports for documentation or integrate it into other tools.

🚀 Quick Start

The MCP Reporter Tool is a handy utility that generates detailed reports about the capabilities of Model Context Protocol (MCP) servers. It enables developers to gain insights into the available features within their MCP server ecosystem. Moreover, it can be used programmatically to generate reports for documentation or integrated into other tools.

✨ Features

• Server Discovery: Automatically connect to all enabled MCP servers.
• Feature Analysis: Extract tools, resources, and resource templates.
• Markdown Report Generation: Produce well - structured documentation.
• Progress Monitoring: Provide real - time execution feedback.

Screenshot of a Generated Report (Partial)

📦 Installation

Prerequisites

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

Installation from Source Code

# Clone the repository
git clone https://github.com/cyanheads/mcp-reporter.git
cd mcp-reporter

# Install dependencies
npm install

# Build the project
npm run build

# Create a symbolic link (optional)
npm link

📚 Documentation

Configuration

The MCP Reporter Tool requires a configuration file that defines the MCP servers to be analyzed:

# Create a configuration file from the example
cp mcp-servers.json.example mcp-servers.json

Usage

Command - Line Options

The following are the main command - line options supported by the MCP Reporter Tool:

💻 Usage Examples

Basic Usage

// cli.ts
import { program } from 'commander';

program
  .version('1.0.1')
  .description('MCP Reporter CLI tool')
  .option('--config <type>', 'Specify the configuration file path', parseConfig)
  .action((options: IOptions) => {
    // Processing logic
  });

program.parse(process.argv);

Advanced Usage

// index.ts
export interface IReporterConfig {
  servers: string[];
  output?: string;
}

export class Reporter {
  private config: IReporterConfig;

  constructor(config: IReporterConfig) {
    this.config = config;
  }

  public generateReport(): void {
    // Logic for generating the report
  }
}

Report Structure

// Example report structure
interface ReportStructure {
  servers: ServerInfo[];
  summary?: Summary;
}

interface ServerInfo {
  name: string;
  version: string;
  features: Feature[];
}

enum Feature {
  ContextService = 'context_service',
  ModelManager = 'model_manager'
}

Project Structure

mcp-reporter/
├── src/               # Source code
│   ├── cli.ts         # Command - line interface
│   ├── index.ts       # Main program code
│   ├── types/         # TypeScript type definitions
│   └── utils/         # Utility functions
├── scripts/           # Build and maintenance scripts
├── docs/              # Documentation
├── output/            # Default report output directory
└── mcp-servers.json   # Server configuration file (created from example)

Development

# Clean build artifacts
npm run clean

# Rebuild the project
npm run rebuild

# Generate project structure visualization
npm run tree

📄 License

This project is licensed under the Apache 2.0 license - see the LICENSE file for details.

Author

Casey Hand (@cyanheads)