damien_mcp_server

damien_mcp_server

0
ai_chatbotcommunicationcloud_platforms

The Damien MCP Server facilitates seamless interactions with Gmail for AI assistants via the MCP protocol. It bridges the gap between AI and Gmail management, allowing various functionalities such as email listing, labeling, and rules application. The server supports secure authentication and maintains session context using DynamoDB.

Damien MCP Server

MCP Server for Damien-CLI functionalities. This server enables AI assistants like Claude to interact with Damien's Gmail management capabilities through the MCP protocol.

Overview

The Damien MCP Server acts as a bridge between AI assistants and the Damien-CLI core functionalities. It exposes Damien's Gmail management capabilities as MCP tools that can be used by AI assistants through a standardized API.

Key Features

  • MCP Protocol Support: Implements the Model Context Protocol for seamless integration with AI assistants
  • Gmail Management: Provides tools for listing, trashing, labeling, and managing emails
  • Rule Management: Allows creating, listing, and applying Gmail filtering rules
  • Session Context: Maintains conversation context using DynamoDB for multi-turn interactions
  • Secure Authentication: Uses existing Damien-CLI token-based authentication with Gmail

Architecture

The server follows a clean, layered architecture:

  1. API Layer (FastAPI endpoints): Handles HTTP requests, validation, and response formatting
  2. Adapter Layer (DamienAdapter): Bridges between MCP requests and Damien core_api calls
  3. Core Layer (Damien core_api): Provides the underlying Gmail/Rules functionality
  4. Storage Layer (DynamoDB): Stores session context for multi-turn conversations

Prerequisites

  • Python 3.13+
  • Poetry for dependency management
  • AWS account (for DynamoDB session storage)
  • Damien-CLI with valid Gmail authentication (token.json)

Installation

  1. Clone the repository and navigate to the project directory:

    cd damien_mcp_server

  2. Install dependencies:

    poetry install

Configuration

The server requires several configuration parameters to run correctly. These can be set via environment variables or in a .env file in the project root.

Copy the example configuration file and adjust as needed:

cp .env.example .env
# Edit the .env file with appropriate values

Required environment variables include:

DAMIEN_MCP_SERVER_API_KEY=YOUR_SECURE_API_KEY_HERE
DAMIEN_GMAIL_TOKEN_JSON_PATH=/path/to/your/damien_cli_project/data/token.json
DAMIEN_GMAIL_CREDENTIALS_JSON_PATH=/path/to/your/damien_cli_project/credentials.json
DAMIEN_DYNAMODB_SESSION_TABLE_NAME=DamienMCPSessions
DAMIEN_DYNAMODB_REGION=us-east-1
DAMIEN_DYNAMODB_SESSION_TTL_SECONDS=86400
AWS_REGION=us-east-1
DAMIEN_LOG_LEVEL=INFO
DAMIEN_DEFAULT_USER_ID=damien_user_default

DynamoDB Setup

You need to create a DynamoDB table with the following configuration:

  • Table Name: DamienMCPSessions (or your custom name from env var)
  • Primary Key:
    • Partition key: user_id (String)
    • Sort key: session_id (String)
  • TTL: Enable with attribute name ttl
  • Billing Mode: Pay-per-request (on-demand) is recommended for development

You can create the table using AWS CLI:

aws dynamodb create-table \
  --table-name DamienMCPSessions \
  --attribute-definitions \
    AttributeName=user_id,AttributeType=S \
    AttributeName=session_id,AttributeType=S \
  --key-schema \
    AttributeName=user_id,KeyType=HASH \
    AttributeName=session_id,KeyType=RANGE \
  --billing-mode PAY_PER_REQUEST \
  --region us-east-1

# Enable TTL
aws dynamodb update-time-to-live \
  --table-name DamienMCPSessions \
  --time-to-live-specification "Enabled=true, AttributeName=ttl" \
  --region us-east-1
IAM Permissions

Ensure your AWS user or role has appropriate permissions for DynamoDB operations:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "dynamodb:GetItem",
        "dynamodb:PutItem",
        "dynamodb:UpdateItem",
        "dynamodb:DeleteItem",
        "dynamodb:Query"
      ],
      "Resource": [
        "arn:aws:dynamodb:REGION:ACCOUNT_ID:table/DamienMCPSessions",
        "arn:aws:dynamodb:REGION:ACCOUNT_ID:table/DamienMCPSessions/index/*"
      ]
    }
  ]
}

Gmail Authentication

Make sure Damien CLI is properly authenticated with Gmail:

cd ../damien_cli_project
poetry run damien login

This will create a token.json file that the MCP server will use.

Running the Server

Start the development server:

poetry run uvicorn app.main:app --reload --port 8892

For production:

poetry run uvicorn app.main:app --host 0.0.0.0 --port 8892

Available MCP Tools

The following MCP tools are currently implemented:

  1. damien_list_emails

    • Lists emails from your Gmail account based on query parameters
    • Parameters:
      • query: Optional Gmail query string (e.g., "is:unread", "from:example.com")
      • max_results: Maximum number of emails to retrieve (default: 10)
      • page_token: Optional token for pagination
    • Example request: 
      {
  "tool_name": "damien_list_emails",
  "input": {
    "query": "is:unread",
    "max_results": 5
  },
  "session_id": "conversation_123456789"
}

  2. damien_get_email_details

    • Retrieves detailed information about a specific email
    • Parameters:
      • message_id: ID of the email to retrieve (required)
      • format: Format of the details to retrieve (default: "full")
    • Example request: 
      {
  "tool_name": "damien_get_email_details",
  "input": {
    "message_id": "1234abcd5678",
    "format": "full"
  },
  "session_id": "conversation_123456789"
}

  3. damien_trash_emails

    • Moves specified emails to the trash folder
    • Parameters:
      • message_ids: List of email IDs to trash (required)
    • Example request: 
      {
  "tool_name": "damien_trash_emails",
  "input": {
    "message_ids": ["1234abcd5678", "8765dcba4321"]
  },
  "session_id": "conversation_123456789"
}

  4. damien_label_emails

    • Adds or removes labels from specified emails
    • Parameters:
      • message_ids: List of email IDs to modify (required)
      • add_label_names: List of label names to add
      • remove_label_names: List of label names to remove
    • Example request: 
      {
  "tool_name": "damien_label_emails",
  "input": {
    "message_ids": ["1234abcd5678"],
    "add_label_names": ["Important", "Follow-up"],
    "remove_label_names": ["Pending"]
  },
  "session_id": "conversation_123456789"
}

  5. damien_mark_emails

    • Marks emails as read or unread
    • Parameters:
      • message_ids: List of email IDs to mark (required)
      • mark_as: Either "read" or "unread" (required)
    • Example request: 
      {
  "tool_name": "damien_mark_emails",
  "input": {
    "message_ids": ["1234abcd5678", "8765dcba4321"],
    "mark_as": "read"
  },
  "session_id": "conversation_123456789"
}

  6. damien_apply_rules

    • Applies email filtering rules to your Gmail account
    • Parameters:
      • rule_ids_to_apply: Optional list of specific rule IDs to apply
      • gmail_query_filter: Optional Gmail query to pre-filter emails
      • scan_limit: Maximum number of emails to scan
      • date_after: Only process emails after this date (YYYY/MM/DD)
      • date_before: Only process emails before this date (YYYY/MM/DD)
      • dry_run: If true, simulate without making changes
    • Example request: 
      {
  "tool_name": "damien_apply_rules",
  "input": {
    "gmail_query_filter": "in:inbox",
    "scan_limit": 100,
    "dry_run": true
  },
  "session_id": "conversation_123456789"
}

  7. damien_list_rules

    • Lists all email filtering rules
    • No parameters required
    • Example request: 
      {
  "tool_name": "damien_list_rules",
  "input": {},
  "session_id": "conversation_123456789"
}

  8. damien_add_rule

    • Adds a new email filtering rule
    • Parameters:
      • rule_definition: Rule definition object (required)
    • Example request: 
      {
  "tool_name": "damien_add_rule",
  "input": {
    "rule_definition": {
      "name": "Archive Newsletters",
      "description": "Move newsletter emails to archive",
      "is_enabled": true,
      "conditions": [
        {"field": "subject", "operator": "contains", "value": "Newsletter"}
      ],
      "condition_conjunction": "AND",
      "actions": [
        {"type": "add_label", "label_name": "Newsletter"}
      ]
    }
  },
  "session_id": "conversation_123456789"
}

  9. damien_delete_rule

    • Deletes an existing rule by ID or name
    • Parameters:
      • rule_identifier: ID or name of the rule to delete (required)
    • Example request: 
      {
  "tool_name": "damien_delete_rule",
  "input": {
    "rule_identifier": "Archive Newsletters"
  },
  "session_id": "conversation_123456789"
}

  10. damien_delete_emails_permanently

    • Permanently deletes emails (cannot be recovered)
    • Parameters:
      • message_ids: List of email IDs to delete permanently (required)
    • Example request: 
      {
  "tool_name": "damien_delete_emails_permanently",
  "input": {
    "message_ids": ["1234abcd5678"]
  },
  "session_id": "conversation_123456789"
}

API Endpoints

Authentication

All protected endpoints require the X-API-Key header with your API key.

Health Check

  • GET /health: Check if the server is running (public)

Test Endpoints

  • GET /mcp/protected-test: Test authentication (protected)
  • GET /mcp/gmail-test: Test Gmail connection (protected)

MCP Tool Endpoints

  • GET /mcp/list_tools: Discover available tools and their schemas (protected)
  • POST /mcp/execute_tool: Execute an MCP tool (protected)
    • Request body must conform to the MCPExecuteToolServerRequest schema
    • Returns an MCPExecuteToolServerResponse with the results or error

API Documentation

Once running, access the interactive API documentation:

Configuring Claude to Use This Server

To configure Claude to use the MCP server, you'll need to provide the following information:

  1. Server URL: http://your-server-address:8892 (or your public ngrok URL)
  2. API key: The value from your .env file (DAMIEN_MCP_SERVER_API_KEY)
  3. Tool definitions: Use the JSON schemas from the /mcp/list_tools endpoint

Example tool definition for damien_list_emails:

{
  "name": "damien_list_emails",
  "description": "Lists email messages based on a query, with support for pagination.",
  "input_schema": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string",
        "description": "Gmail search query (e.g., 'is:unread', 'from:example.com')"
      },
      "max_results": {
        "type": "integer",
        "description": "Maximum number of emails to retrieve",
        "default": 10
      },
      "page_token": {
        "type": "string",
        "description": "Token for fetching the next page of results"
      }
    }
  }
}

Development

Running Tests

poetry run pytest

Code Formatting

poetry run black app tests

Linting

poetry run flake8 app tests

Troubleshooting

Common Issues

DynamoDB Connection Issues

If you encounter DynamoDB connection issues:

# Check the table status
aws dynamodb describe-table --table-name DamienMCPSessions --region us-east-1 --query "Table.TableStatus"

# Verify your IAM permissions
aws iam list-attached-user-policies --user-name $(aws iam get-user --query "User.UserName" --output text)

# Test DynamoDB connection
aws dynamodb list-tables --region us-east-1
Gmail Authentication Issues

If you encounter Gmail authentication issues:

  1. Check that token.json exists and is valid:

    cat /path/to/your/damien_cli_project/data/token.json

  2. Re-authenticate with Damien CLI:

    cd ../damien_cli_project
poetry run damien login

  3. Check logs for specific error messages:

    tail -f logs/server.log
API Testing

You can test the server's endpoints using curl:

# Check if the server is running
curl http://localhost:8892/health

# Test authentication
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:8892/mcp/protected-test

# Test Gmail connection
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:8892/mcp/gmail-test

# Get list of available tools
curl -H "X-API-Key: YOUR_API_KEY" http://localhost:8892/mcp/list_tools

# Execute the list_emails tool
curl -X POST \
  http://localhost:8892/mcp/execute_tool \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "tool_name": "damien_list_emails",
    "input": {
      "query": "is:unread",
      "max_results": 5
    },
    "session_id": "test_session_1"
  }'

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.