Summarization

🚀 Summarization Functions

The intelligent text summarizer is developed for the model context protocol, offering efficient text summarization capabilities.

Features • AI Agent Integration • Installation • Usage

🚀 Quick Start

This summarization function provides a convenient way to summarize various types of content. Below are the installation and usage steps.

📦 Installation

Install using npm

npm install mcp-summarization-functions

💻 Usage Examples

Basic Usage

1. Create an MCP configuration file: If you don't have an mcp-config.json file, create one first.
2. Add the summarization function to the MCP configuration:

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

Advanced Usage

Available Functions

summarize_command

Execute a command and summarize the output.

{
  // Required
  command: string,    // The command to execute
  cwd: string,       // The working directory where the command is executed
  
  // Optional
  hint?: string,      // Focus area: "Security Analysis" | "API Surface" | "Error Handling" | "Dependencies" | "Type Definitions"
  output_format?: string  // Format: "Text" | "JSON" | "Markdown" | "Outline" (Default: Text)
}

summarize_files

Summarize the content of files.

{
  // Required
  paths: string[],    // An array of file paths to summarize (relative to cwd)
  cwd: string,       // The working directory to resolve file paths
  
  // Optional
  hint?: string,      // Focus area: "Security Analysis" | "API Surface" | "Error Handling" | "Dependencies" | "Type Definitions"
  output_format?: string  // Format: "Text" | "JSON" | "Markdown" | "Outline" (Default: Text)
}

summarize_directory

Get an overview of the directory structure.

{
  // Required
  path: string,       // The directory path to summarize (relative to cwd)
  cwd: string,       // The working directory to resolve the directory path
  
  // Optional
  recursive?: boolean,  // Whether to include subdirectories. Suitable for deep directories
  hint?: string,       // Focus area: "Security Analysis" | "API Surface" | "Error Handling" | "Dependencies" | "Type Definitions"
  output_format?: string   // Format: "Text" | "JSON" | "Markdown" | "Outline" (Default: Text)
}

summarize_text

Summarize any text content.

{
  // Required
  content: string,    // The text content to summarize
  type: string,       // Content type (e.g., "Log Output", "API Response")
  
  // Optional
  hint?: string,      // Focus area: "Security Analysis" | "API Surface" | "Error Handling" | "Dependencies" | "Type Definitions"
  output_format?: string  // Format: "Text" | "JSON" | "Markdown" | "Outline" (Default: Text)
}

get_full_content

Get the full content based on the summary ID.

{
  // Required
  id: string         // The ID of the stored content
}

📚 Documentation

Configuration Options

📄 License

This project is licensed under the MIT license.