Summarization

🚀 摘要函数

智能文本摘要器专为模型上下文协议而开发，可实现对命令输出、文件内容、目录结构和任意文本的摘要处理，还能根据摘要 ID 获取完整内容。

功能 • AI 代理集成 • 安装 • 使用方法

📦 安装指南

使用 npm 安装

npm install mcp-summarization-functions

💻 使用示例

基础用法

使用步骤

1. 创建 MCP 配置文件： 如果没有 mcp-config.json 文件，请先创建一个。

2. 添加摘要功能到 MCP 配置：

{
  "mcpServers": {
    "SUMMARY_FUNCTION": {
      "command": "node",
      "args": ["path/to/mcp-summarization-functions/index.js"],
      "env": {
        "PROVIDER": "ANTHROPIC", // 可选：ANTHROPIC, OPENAI, AZURE-OPENAI, GOOGLE
        "API_KEY": "your-api-key",
        "MODEL_ID": "claude-3-5-sonnet-20241022",
        "MCP_WORKING_DIR": "default_working_directory"
      }
    }
  }
}

高级用法

可用功能

summarize_command

执行命令并摘要输出。

{
  // 必填项
  command: string,    // 要执行的命令
  cwd: string,       // 命令执行的工作目录
  
  // 可选项
  hint?: string,      // 焦点领域： "安全分析" | "API 表面" | "错误处理" | "依赖项" | "类型定义"
  output_format?: string  // 格式： "文本" | "JSON" | "Markdown" | "大纲"（默认：文本）
}

summarize_files

摘要文件内容。

{
  // 必填项
  paths: string[],    // 要摘要的文件路径数组（相对于 cwd）
  cwd: string,       // 解决文件路径的工作目录
  
  // 可选项
  hint?: string,      // 焦点领域： "安全分析" | "API 表面" | "错误处理" | "依赖项" | "类型定义"
  output_format?: string  // 格式： "文本" | "JSON" | "Markdown" | "大纲"（默认：文本）
}

summarize_directory

获取目录结构概述。

{
  // 必填项
  path: string,       // 要摘要的目录路径（相对于 cwd）
  cwd: string,       // 解决目录路径的工作目录
  
  // 可选项
  recursive?: boolean,  // 是否包含子目录。适用于深层目录
  hint?: string,       // 焦点领域： "安全分析" | "API 表面" | "错误处理" | "依赖项" | "类型定义"
  output_format?: string   // 格式： "文本" | "JSON" | "Markdown" | "大纲"（默认：文本）
}

summarize_text

摘要任意文本内容。

{
  // 必填项
  content: string,    // 要摘要的文本内容
  type: string,       // 内容类型（例如："日志输出"、"API 响应"）
  
  // 可选项
  hint?: string,      // 焦点领域： "安全分析" | "API 表面" | "错误处理" | "依赖项" | "类型定义"
  output_format?: string  // 格式： "文本" | "JSON" | "Markdown" | "大纲"（默认：文本）
}

get_full_content

根据摘要 ID 获取完整内容。

{
  // 必填项
  id: string         // 存储内容的 ID
}

📚 详细文档

配置选项

📄 许可证

本项目采用 MIT 许可证。