MCP Summarization Functions

🚀 MCPサマリーツール

このプロジェクトは、コマンド、ファイル、ディレクトリの要約やテキスト分析を行うためのMCPサーバーツールです。複数の出力形式（テキスト、JSON、Markdown、アウトラインなど）をサポートし、指定された焦点領域に基づいて詳細なセキュリティ分析、API表面ビュー、エラー処理、依存関係、または型定義情報を生成することができます。

🚀 クイックスタート

このツールを使うことで、コマンド、ファイル、ディレクトリの要約やテキスト分析を簡単に行うことができます。以下のセクションでは、インストール方法、機能、使用例などを詳しく説明します。

✨ 主な機能

• 多様な出力形式：テキスト、JSON、Markdown、アウトラインなど、複数の出力形式をサポート。
• 焦点領域別分析：指定した焦点領域に基づいて詳細な分析情報を生成。
• コマンド、ファイル、ディレクトリの要約：コマンド出力、ファイル内容、ディレクトリ構造の要約が可能。
• 任意のテキスト内容の要約：純粋なテキスト内容の要約もサポート。

📦 インストール

1. npmを通じたインストール

以下のコマンドを使用して、このパッケージをプロジェクトの依存関係として追加します。

npm install mcp-summarization-functions

2. MCP設定ファイルへの統合

サーバーをMCP設定ファイルに追加します。

{
  "mcpServers": {
    "SUMMARY_TOOL": {
      "command": "node",
      "args": ["./node_modules/mcp-summarization-functions/build/index.js"],
      "env": {
        "PROVIDER": "ANTHROPIC", // または他のAIプロバイダー
        "API_KEY": "your-api-key",
        "MODEL_ID": "claude-3-5-sonnet"
      }
    }
  }
}

💻 使用例

基本的な使用法

1. コマンド出力の要約

await mcpClient.executeCommand("npm install", { cwd: "./my-project" }, {
  hint: "安全分析",
  outputFormat: "JSON"
});

2. ファイルの要約取得

const result = await mcpClient.getFileSummary(["./src/**/*"], { cwd: "." }, {
  hint: "依赖项", 
  outputFormat: "Markdown"
});

高度な使用法

このツールは、コマンド、ファイル、ディレクトリの要約やテキスト分析を行うための多様な機能を提供します。以下に、高度な使用例を示します。

1. コマンド出力の要約（高度な設定）

await mcpClient.executeCommand("npm install", { cwd: "./my-project" }, {
  hint: "安全分析",
  outputFormat: "JSON",
  // 追加の設定オプションをここに記述
});

2. ファイルの要約取得（高度な設定）

const result = await mcpClient.getFileSummary(["./src/**/*"], { cwd: "." }, {
  hint: "依赖项", 
  outputFormat: "Markdown",
  // 追加の設定オプションをここに記述
});

📚 ドキュメント

機能詳細

1. コマンド出力の要約

{
  command: string,    // 実行するコマンド
  cwd: string,       // コマンドを実行する作業ディレクトリ
  
  // オプションパラメータ
  hint?: string,      // 分析の焦点: "安全分析" | "API表面" | "错误处理" | "依赖项" | "类型定义"
  outputFormat?: string  // 出力形式: "文本" | "JSON" | "Markdown" | "大纲"(デフォルト: "文本")
}

2. ファイル内容の要約

{
  paths: string[],    // 要約するファイルのパス配列(作業ディレクトリに対する相対パス)
  cwd: string,       // ファイルパスを解決する作業ディレクトリ
  
  // オプションパラメータ
  hint?: string,      // 分析の焦点: "安全分析" | "API表面" | "错误处理" | "依赖项" | "类型定义"
  outputFormat?: string  // 出力形式: "文本" | "JSON" | "Markdown" | "大纲"(デフォルト: "文本")
}

3. ディレクトリ構造の概要取得

{
  path: string,       // 要約するディレクトリのパス(作業ディレクトリに対する相対パス)
  cwd: string,       // ディレクトリパスを解決する作業ディレクトリ
  
  // オプションパラメータ
  recursive?: boolean,  // サブディレクトリを含めるかどうか(深いディレクトリ構造の場合に適用)
  hint?: string,       // 分析の焦点: "安全分析" | "API表面" | "错误处理" | "依赖项" | "类型定义"
  outputFormat?: string   // 出力形式: "文本" | "JSON" | "Markdown" | "大纲"(デフォルト: "文本")
}

4. 任意のテキスト内容の要約

{
  content: string,    // 要約する純粋なテキスト内容
  type: string,       // 内容のタイプ(例: "日志输出", "API响应")
  
  // オプションパラメータ
  hint?: string,      // 分析の焦点: "安全分析" | "API表面" | "错误处理" | "依赖项" | "类型定义"
  outputFormat?: string  // 出力形式: "文本" | "JSON" | "Markdown" | "大纲"(デフォルト: "文本")
}

5. 完全な内容の取得

{
  id: string         // 保存された内容のID
}

環境変数の設定

以下の環境変数を使用して、サーバーの動作をカスタマイズすることができます。

📄 ライセンス

このプロジェクトはMITライセンスに基づいています。詳細については、LICENSEファイルを参照してください。