do-memory-mcp 0.1.29

Model Context Protocol (MCP) server for AI agents
Documentation
//! Basic tool definitions for the MCP server
//!
//! This module contains the `create_default_tools()` function that defines
//! the core MCP tools for the memory system (querying, patterns, monitoring, embeddings).

use crate::types::Tool;
use serde_json::json;

/// Create the default set of basic tool definitions for the MCP server.
///
/// This function defines core tools including memory queries, pattern analysis,
/// health checks, metrics, embeddings, and pattern search/recommendation.
pub fn create_default_tools() -> Vec<Tool> {
    let mut tools = vec![Tool::new(
        "query_memory".to_string(),
        "Query episodic memory for relevant past experiences and learned patterns".to_string(),
        json!({
            "type": "object",
            "properties": {
                "query": {
                    "type": "string",
                    "description": "Search query describing the task or context"
                },
                "domain": {
                    "type": "string",
                    "description": "Task domain (e.g., 'web-api', 'data-processing')"
                },
                "task_type": {
                    "type": "string",
                    "enum": [
                        "code_generation",
                        "debugging",
                        "refactoring",
                        "testing",
                        "analysis",
                        "documentation"
                    ],
                    "description": "Type of task being performed"
                },
                "limit": {
                    "type": "integer",
                    "default": 10,
                    "description": "Maximum number of episodes to retrieve"
                },
                "sort": {
                    "type": "string",
                    "enum": ["relevance", "newest", "oldest", "duration", "success"],
                    "default": "relevance",
                    "description": "Sort order for results"
                }
            },
            "required": ["query", "domain"]
        }),
    )];

    tools.push(Tool::new(
        "analyze_patterns".to_string(),
        "Analyze patterns from past episodes to identify successful strategies".to_string(),
        json!({
            "type": "object",
            "properties": {
                "task_type": {
                    "type": "string",
                    "description": "Type of task to analyze patterns for"
                },
                "min_success_rate": {
                    "type": "number",
                    "default": 0.7,
                    "description": "Minimum success rate for patterns (0.0-1.0)"
                },
                "limit": {
                    "type": "integer",
                    "default": 20,
                    "description": "Maximum number of patterns to return"
                }
            },
            "required": ["task_type"]
        }),
    ));

    tools.push(Tool::new(
        "health_check".to_string(),
        "Check the health status of the MCP server and its components".to_string(),
        json!({"type": "object", "properties": {}}),
    ));

    tools.push(Tool::new(
        "get_metrics".to_string(),
        "Get comprehensive monitoring metrics and statistics".to_string(),
        json!({
            "type": "object",
            "properties": {
                "metric_type": {
                    "type": "string",
                    "enum": ["all", "performance", "episodes", "system"],
                    "default": "all",
                    "description": "Type of metrics to retrieve"
                }
            }
        }),
    ));

    // Advanced pattern analysis tool
    tools.push(
        crate::mcp::tools::advanced_pattern_analysis::AdvancedPatternAnalysisTool::tool_definition(
        ),
    );

    // Quality metrics tool
    tools.push(crate::mcp::tools::quality_metrics::QualityMetricsTool::tool_definition());

    // Embedding configuration and query tools
    tools.push(crate::mcp::tools::embeddings::configure_embeddings_tool());
    tools.push(crate::mcp::tools::embeddings::query_semantic_memory_tool());
    tools.push(crate::mcp::tools::embeddings::test_embeddings_tool());

    // Pattern search tool
    tools.push(Tool::new(
        "search_patterns".to_string(),
        "Search for patterns semantically similar to a query using multi-signal ranking"
            .to_string(),
        json!({
            "type": "object",
            "properties": {
                "query": {
                    "type": "string",
                    "description": "Natural language query describing what pattern to search for"
                },
                "domain": {
                    "type": "string",
                    "description": "Domain to search in (e.g., 'web-api', 'cli', 'data-processing')"
                },
                "tags": {
                    "type": "array",
                    "items": {"type": "string"},
                    "description": "Optional tags for filtering",
                    "default": []
                },
                "limit": {
                    "type": "integer",
                    "description": "Maximum number of results (default: 5)",
                    "default": 5
                },
                "min_relevance": {
                    "type": "number",
                    "description": "Minimum relevance score 0.0-1.0 (default: 0.3)",
                    "default": 0.3
                },
                "filter_by_domain": {
                    "type": "boolean",
                    "description": "Whether to filter by domain (default: false)",
                    "default": false
                }
            },
            "required": ["query", "domain"]
        }),
    ));

    // Pattern recommendation tool
    tools.push(Tool::new(
        "recommend_patterns".to_string(),
        "Get pattern recommendations for a specific task with high-quality filtering".to_string(),
        json!({
            "type": "object",
            "properties": {
                "task_description": {
                    "type": "string",
                    "description": "Description of the task you're working on"
                },
                "domain": {
                    "type": "string",
                    "description": "Domain of the task (e.g., 'web-api', 'cli')"
                },
                "tags": {
                    "type": "array",
                    "items": {"type": "string"},
                    "description": "Optional context tags",
                    "default": []
                },
                "limit": {
                    "type": "integer",
                    "description": "Maximum number of recommendations (default: 3)",
                    "default": 3
                }
            },
            "required": ["task_description", "domain"]
        }),
    ));

    // Recommendation feedback tools (ADR-044 Feature 2)
    tools.push(Tool::new(
        "record_recommendation_session".to_string(),
        "Record a recommendation session when patterns/playbooks are suggested to an agent"
            .to_string(),
        json!({
            "type": "object",
            "properties": {
                "episode_id": {
                    "type": "string",
                    "description": "Episode ID for which recommendations are made"
                },
                "recommended_pattern_ids": {
                    "type": "array",
                    "items": {"type": "string"},
                    "description": "Pattern IDs that were recommended",
                    "default": []
                },
                "recommended_playbook_ids": {
                    "type": "array",
                    "items": {"type": "string"},
                    "description": "Playbook IDs that were recommended",
                    "default": []
                }
            },
            "required": ["episode_id"]
        }),
    ));

    tools.push(Tool::new(
        "record_recommendation_feedback".to_string(),
        "Record feedback about which recommendations were used and the outcome".to_string(),
        json!({
            "type": "object",
            "properties": {
                "session_id": {
                    "type": "string",
                    "description": "Session ID from the recommendation session"
                },
                "applied_pattern_ids": {
                    "type": "array",
                    "items": {"type": "string"},
                    "description": "Pattern IDs that were actually applied",
                    "default": []
                },
                "consulted_episode_ids": {
                    "type": "array",
                    "items": {"type": "string"},
                    "description": "Episode IDs that were consulted",
                    "default": []
                },
                "outcome": {
                    "type": "object",
                    "description": "Final outcome of the task",
                    "properties": {
                        "type": {
                            "type": "string",
                            "enum": ["success", "partial_success", "failure"]
                        },
                        "verdict": {"type": "string"},
                        "reason": {"type": "string"},
                        "artifacts": {
                            "type": "array",
                            "items": {"type": "string"},
                            "default": []
                        }
                    },
                    "required": ["type"]
                },
                "agent_rating": {
                    "type": "number",
                    "description": "Optional rating of recommendation quality (0.0-1.0)",
                    "minimum": 0.0,
                    "maximum": 1.0
                }
            },
            "required": ["session_id", "outcome"]
        }),
    ));

    tools.push(Tool::new(
        "get_recommendation_stats".to_string(),
        "Get statistics about recommendation effectiveness and adoption rates".to_string(),
        json!({
            "type": "object",
            "properties": {}
        }),
    ));

    tools
}