MCP Summarization Functions

🚀 Summary Functions

An intelligent text summarizer crafted for the model context protocol

Features • AI Agent Integration • Installation • Usage

✨ Features

This summarizer is designed to handle complex technical documents and code repositories, supporting multiple input formats and output styles. Its core features include:

• Multilingual Support: Enables intelligent summarization of both Chinese and English texts.
• Context Awareness: Understands content priorities based on context.
• Customizable Focus: Offers professional summarization modes such as security analysis, API surface, error handling, etc.
• Efficient Caching Mechanism: Supports quick retrieval and reuse of generated summaries.

📦 Installation

1. Clone the repository

git clone https://github.com/your-repository.git
cd summarization-functions

2. Install dependencies

npm install

3. Start the service

node build/index.js

💻 Usage Examples

Integrate the summarizer into your MCP configuration file:

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

💻 Usage Examples

Basic Usage

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

Advanced Usage

Here is a more detailed configuration example for specific scenarios:

{
    "mcpServers": {
        "MUST_USE_summarization": {
            "command": "node",
            "args": ["path/to/summarization-functions/build/index.js"],
            "env": {
                "PROVIDER": "ANTHROPIC",
                "API_KEY": "your-api-key",
                "MODEL_ID": "claude-3-5-sonnet-20241022",
                "MCP_WORKING_DIR": "default_working_directory",
                "ADDITIONAL_CONFIG": "custom_value"
            }
        }
    }
}

Provided Functions

summarize_command

Execute and summarize command output.

{
  // Required
  command: string,    // The command to execute
  cwd: string,       // The working directory for command execution
  
  // 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 file contents.

{
  // Required
  paths: string[],    // 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

Retrieve the full content of a given summary ID.

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

📄 License

MIT