MCP Summarization Functions

🚀 MCP服務器工具

這個項目是一個強大的MCP服務器工具，可用於執行命令、總結文件和目錄內容，以及進行文本分析。它支持多種輸出格式，如文本、JSON、Markdown和大綱，還能根據指定焦點領域生成詳細的安全分析、API表面視圖、錯誤處理、依賴項或類型定義信息，為開發者提供全面且細緻的項目分析。

🚀 快速開始

本工具能為你的項目執行命令、總結文件和目錄內容，還能進行文本分析，支持多種輸出格式，可按需生成詳細分析信息。

📦 安裝指南

通過npm安裝

使用以下命令將此包作為依賴項添加到項目中：

npm install mcp-summarization-functions

集成到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. 總結命令輸出

{
  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
}

🔧 技術細節

環境變量配置

以下環境變量可以用於自定義服務器行為：

• PROVIDER - 指定AI服務提供商（例如：ANTROPIC、OPENAI）
• API_KEY - 對應的API密鑰
• MODEL_ID - 要使用的模型ID
• MAX_OUTPUT_TOKENS - 設置輸出的最大令牌數（默認值：1024）
• _TEMPERATURE - 設置生成文本的隨機性程度（默認值：0.7）

💻 使用示例

基礎用法

總結命令輸出

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

獲取文件摘要

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

📄 許可證

本項目遵循MIT許可證，詳情請參閱LICENSE文件。