MCP Reporter

🚀 MCP 报告工具

MCP 報告ツールは、モデルコンテキストプロトコル（MCP）サーバーの機能に関する包括的なレポートを生成するための便利なツールです。開発者が自分の MCP サーバーエコシステムの利用可能な機能を把握するのに役立ちます。また、プログラムで使用してドキュメント用のレポートを生成したり、他のツールに統合することもできます。

🚀 クイックスタート

MCP 報告ツールは、モデルコンテキストプロトコル（MCP）サーバーの機能を分析し、包括的なレポートを生成することができます。以下のセクションでは、このツールの機能、インストール方法、使用方法などについて詳しく説明します。

✨ 主な機能

• サーバー発見：すべての有効化された 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 報告ツールには、分析対象の MCP サーバーを定義する設定ファイルが必要です。

# サンプルから設定ファイルを作成する
cp mcp-servers.json.example mcp-servers.json

使用方法

コマンドラインオプション

以下は、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   # サーバー設定ファイル（サンプルから作成）

開発

# ビルドアーティファクトをクリーンアップする
npm run clean

# プロジェクトを再構築する
npm run rebuild

# プロジェクト構造のビジュアライズを生成する
npm run tree

📄 ライセンス

このプロジェクトは、Apache 2.0 ライセンスの下で公開されています。詳細については、LICENSE ファイルを参照してください。

作者

Casey Hand (@cyanheads)