MCP Reporter

🚀 MCP 報告工具

MCP 報告工具是一款實用工具，可生成關於模型上下文協議（MCP）服務器功能的全面報告。它能幫助開發者瞭解其 MCP 服務器生態系統的可用功能，還能程序化地用於為文檔生成報告，或集成到其他工具中。

🚀 快速開始

MCP 報告工具藉助命令行選項，可輕鬆實現報告生成。你可以通過指定配置文件路徑，快速啟動報告生成流程。

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

program
  .version('1.0.1')
  .description('MCP Reporter CLI工具')
  .option('--config <類型>', '指定配置文件路徑', parseConfig)
  .action((options: IOptions) => {
    // 處理邏輯
  });

program.parse(process.argv);

✨ 主要特性

• 服務器發現：自動連接到所有啟用的 MCP 服務器
• 功能分析：提取工具、資源和資源模板
• Markdown 報告生成：生成結構清晰的文檔
• 進度監控：提供即時執行反饋

生成報告示例圖（部分）

📦 安裝指南

先決條件

• Node.js 16.x 或更高版本
• npm 或 yarn

從源代碼安裝

# 克隆倉庫
git clone https://github.com/cyanheads/mcp-reporter.git
cd mcp-reporter

# 安裝依賴項
npm install

# 構建項目
npm run build

# 創建符號鏈接（可選）
npm link

💻 使用示例

命令行選項

以下是 MCP 報告工具支持的主要命令行選項：

基礎用法

命令行界面（CLI）

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

program
  .version('1.0.1')
  .description('MCP Reporter CLI工具')
  .option('--config <類型>', '指定配置文件路徑', parseConfig)
  .action((options: IOptions) => {
    // 處理邏輯
  });

program.parse(process.argv);

高級用法

主程序

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

export class Reporter {
  private config: IReporterConfig;

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

  public generateReport(): void {
    // 生成報告的邏輯
  }
}

📚 詳細文檔

報告結構

// 示例報告結構
interface ReportStructure {
  servers: ServerInfo[];
  summary?: Summary;
}

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

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

項目結構

mcp-reporter/
├── src/               # 源代碼
│   ├── cli.ts         # 命令行接口
│   ├── index.ts       # 主程序代碼
│   ├── types/         # TypeScript 類型定義
│   └── utils/         # 工具函數
├── scripts/           # 構建和維護腳本
├── docs/              # 文檔
├── output/            # 默認報告輸出目錄
└── mcp-servers.json   # 服務器配置文件（從示例創建）

開發

# 清理構建 artifacts
npm run clean

# 重建項目
npm run rebuild

# 生成項目結構可視化
npm run tree

📄 許可證

本項目在 Apache 2.0 許可證下發布 - 有關詳細信息，請參閱 LICENSE 文件。

作者

Casey Hand (@cyanheads)