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文件。