diff --git a/.codeboarding/Agent_Core_LLM_Integration.json b/.codeboarding/Agent_Core_LLM_Integration.json index c34e6256b..10ec8a12b 100644 --- a/.codeboarding/Agent_Core_LLM_Integration.json +++ b/.codeboarding/Agent_Core_LLM_Integration.json @@ -138,4 +138,4 @@ "dst_name": "Provider to MCP Converters" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/Agent_Execution_Workflow_Engine.json b/.codeboarding/Agent_Execution_Workflow_Engine.json index 291836fc5..e6e0e5ec9 100644 --- a/.codeboarding/Agent_Execution_Workflow_Engine.json +++ b/.codeboarding/Agent_Execution_Workflow_Engine.json @@ -135,4 +135,4 @@ "dst_name": "Decorator Registry" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/Agent_Workflow_Patterns.json b/.codeboarding/Agent_Workflow_Patterns.json index ef351858f..1125e14a4 100644 --- a/.codeboarding/Agent_Workflow_Patterns.json +++ b/.codeboarding/Agent_Workflow_Patterns.json @@ -224,4 +224,4 @@ "dst_name": "LLM Augmentation Layer" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/Core_Application_Setup.json b/.codeboarding/Core_Application_Setup.json index 0b67cf8ed..2a4dd70bf 100644 --- a/.codeboarding/Core_Application_Setup.json +++ b/.codeboarding/Core_Application_Setup.json @@ -192,4 +192,4 @@ "dst_name": "Configuration Management (Settings)" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/Human_Interaction_Layer.json b/.codeboarding/Human_Interaction_Layer.json index cb676d10e..9692c1813 100644 --- a/.codeboarding/Human_Interaction_Layer.json +++ b/.codeboarding/Human_Interaction_Layer.json @@ -72,4 +72,4 @@ "dst_name": "Console Interface" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/MCP_Service_Integration.json b/.codeboarding/MCP_Service_Integration.json index 41cde3966..d89b20045 100644 --- a/.codeboarding/MCP_Service_Integration.json +++ b/.codeboarding/MCP_Service_Integration.json @@ -99,4 +99,4 @@ "dst_name": "mcp_agent.config" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/analysis.json b/.codeboarding/analysis.json index d9b3d5d06..5a9f636fa 100644 --- a/.codeboarding/analysis.json +++ b/.codeboarding/analysis.json @@ -210,4 +210,4 @@ "dst_name": "Agent Execution & Workflow Engine" } ] -} \ No newline at end of file +} diff --git a/.codeboarding/codeboarding_version.json b/.codeboarding/codeboarding_version.json index b6a90e34c..c6f32a22c 100644 --- a/.codeboarding/codeboarding_version.json +++ b/.codeboarding/codeboarding_version.json @@ -1,4 +1,4 @@ { - "commit_hash": "13c378d8bceee2b4b325ff4a294fba046c835e72", + "commit_hash": "52fd76fe5cb8eb9e89e310bf4a63819a4788f0a6", "code_boarding_version": "0.1.0" -} \ No newline at end of file +} diff --git a/docs/codeboarding/Agent_Core_LLM_Integration.mdx b/docs/codeboarding/Agent_Core_LLM_Integration.mdx index 0bba6fe02..bf46c44e4 100644 --- a/docs/codeboarding/Agent_Core_LLM_Integration.mdx +++ b/docs/codeboarding/Agent_Core_LLM_Integration.mdx @@ -31,7 +31,7 @@ This is the foundational interface for all AI agents within the `mcp-agent` fram **Related Classes/Methods**: -- `mcp_agent.agents.agent.Agent` (56:934) +- `mcp_agent.agents.agent.Agent` (56:934) ### Augmented LLM Interface @@ -40,7 +40,7 @@ This abstract component provides a unified and enhanced interface for interactin **Related Classes/Methods**: -- `mcp_agent.workflows.llm.augmented_llm.AugmentedLLM` (218:668) +- `mcp_agent.workflows.llm.augmented_llm.AugmentedLLM` (218:668) ### LLM Selector @@ -49,7 +49,7 @@ This component is responsible for intelligently selecting the most suitable LLM **Related Classes/Methods**: -- `mcp_agent.workflows.llm.llm_selector.ModelSelector` (96:413) +- `mcp_agent.workflows.llm.llm_selector.ModelSelector` (96:413) ### LLM Provider Implementations @@ -58,12 +58,12 @@ These are concrete implementations of the `Augmented LLM Interface`, providing t **Related Classes/Methods**: -- `mcp_agent.workflows.llm.augmented_llm_anthropic.AnthropicAugmentedLLM` (110:722) -- `mcp_agent.workflows.llm.augmented_llm_azure.AzureAugmentedLLM` (82:491) -- `mcp_agent.workflows.llm.augmented_llm_bedrock.BedrockAugmentedLLM` (48:349) -- `mcp_agent.workflows.llm.augmented_llm_google.GoogleAugmentedLLM` (34:319) -- `mcp_agent.workflows.llm.augmented_llm_ollama.OllamaAugmentedLLM` (16:78) -- `mcp_agent.workflows.llm.augmented_llm_openai.OpenAIAugmentedLLM` (80:845) +- `mcp_agent.workflows.llm.augmented_llm_anthropic.AnthropicAugmentedLLM` (110:722) +- `mcp_agent.workflows.llm.augmented_llm_azure.AzureAugmentedLLM` (82:491) +- `mcp_agent.workflows.llm.augmented_llm_bedrock.BedrockAugmentedLLM` (48:349) +- `mcp_agent.workflows.llm.augmented_llm_google.GoogleAugmentedLLM` (34:319) +- `mcp_agent.workflows.llm.augmented_llm_ollama.OllamaAugmentedLLM` (16:78) +- `mcp_agent.workflows.llm.augmented_llm_openai.OpenAIAugmentedLLM` (80:845) ### Provider to MCP Converters @@ -72,13 +72,13 @@ These utility classes are crucial for ensuring data consistency and interoperabi **Related Classes/Methods**: -- `mcp_agent.workflows.llm.augmented_llm_anthropic.AnthropicMCPTypeConverter` (777:886) -- `mcp_agent.workflows.llm.augmented_llm_azure.MCPAzureTypeConverter` (524:614) -- `mcp_agent.workflows.llm.augmented_llm_bedrock.BedrockMCPTypeConverter` (437:499) -- `mcp_agent.workflows.llm.augmented_llm_google.GoogleMCPTypeConverter` (403:518) -- `mcp_agent.workflows.llm.augmented_llm_openai.MCPOpenAITypeConverter` (949:1055) +- `mcp_agent.workflows.llm.augmented_llm_anthropic.AnthropicMCPTypeConverter` (777:886) +- `mcp_agent.workflows.llm.augmented_llm_azure.MCPAzureTypeConverter` (524:614) +- `mcp_agent.workflows.llm.augmented_llm_bedrock.BedrockMCPTypeConverter` (437:499) +- `mcp_agent.workflows.llm.augmented_llm_google.GoogleMCPTypeConverter` (403:518) +- `mcp_agent.workflows.llm.augmented_llm_openai.MCPOpenAITypeConverter` (949:1055) -### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) \ No newline at end of file +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) diff --git a/docs/codeboarding/Agent_Execution_Workflow_Engine.mdx b/docs/codeboarding/Agent_Execution_Workflow_Engine.mdx index 29a2949b5..1956f281d 100644 --- a/docs/codeboarding/Agent_Execution_Workflow_Engine.mdx +++ b/docs/codeboarding/Agent_Execution_Workflow_Engine.mdx @@ -35,8 +35,8 @@ This is the core component responsible for the actual execution of tasks and act **Related Classes/Methods**: -- `mcp_agent/executor/executor.py` -- `mcp_agent/executor/temporal/TemporalExecutor.py` +- `mcp_agent/executor/executor.py` +- `mcp_agent/executor/temporal/TemporalExecutor.py` ### Workflow Management @@ -45,8 +45,8 @@ This component defines the structure, state, and lifecycle of complex, multi-ste **Related Classes/Methods**: -- `mcp_agent/executor/workflow.py` -- `mcp_agent/executor/temporal/interactive_workflow.py` +- `mcp_agent/executor/workflow.py` +- `mcp_agent/executor/temporal/interactive_workflow.py` ### Task/Activity Registry @@ -55,7 +55,7 @@ A centralized repository that allows for the registration and dynamic retrieval **Related Classes/Methods**: -- `mcp_agent/executor/task_registry.py` +- `mcp_agent/executor/task_registry.py` ### Signal Handling @@ -64,8 +64,8 @@ This component provides a robust mechanism for inter-component communication and **Related Classes/Methods**: -- `mcp_agent/executor/signal_registry.py` -- `mcp_agent/executor/workflow_signal.py` +- `mcp_agent/executor/signal_registry.py` +- `mcp_agent/executor/workflow_signal.py` ### Decorator Registry @@ -74,7 +74,7 @@ This component serves as a dedicated registry for managing decorators that can b **Related Classes/Methods**: -- `mcp_agent/executor/decorator_registry.py` +- `mcp_agent/executor/decorator_registry.py` ### Workflow Registry @@ -83,10 +83,10 @@ This component is responsible for registering and providing access to defined wo **Related Classes/Methods**: -- `mcp_agent/executor/workflow_registry.py` -- `mcp_agent/executor/temporal/workflow_registry.py` +- `mcp_agent/executor/workflow_registry.py` +- `mcp_agent/executor/temporal/workflow_registry.py` -### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) \ No newline at end of file +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) diff --git a/docs/codeboarding/Agent_Workflow_Patterns.mdx b/docs/codeboarding/Agent_Workflow_Patterns.mdx index 9d87cbcce..a99ae198b 100644 --- a/docs/codeboarding/Agent_Workflow_Patterns.mdx +++ b/docs/codeboarding/Agent_Workflow_Patterns.mdx @@ -38,9 +38,9 @@ This foundational component provides a unified and augmented interface for inter **Related Classes/Methods**: -- `mcp_agent.workflows.llm.augmented_llm.AugmentedLLM` (218:668) -- `mcp_agent.workflows.llm.llm_selector.ModelSelector` (96:413) -- `mcp_agent.workflows.llm.augmented_llm_anthropic.AnthropicAugmentedLLM` (110:722) +- `mcp_agent.workflows.llm.augmented_llm.AugmentedLLM` (218:668) +- `mcp_agent.workflows.llm.llm_selector.ModelSelector` (96:413) +- `mcp_agent.workflows.llm.augmented_llm_anthropic.AnthropicAugmentedLLM` (110:722) ### Embedding Models @@ -49,9 +49,9 @@ This component offers a standardized interface for generating and managing text **Related Classes/Methods**: -- `mcp_agent.workflows.embedding.embedding_base.EmbeddingModel` (13:31) -- `mcp_agent.workflows.embedding.embedding_cohere.CohereEmbeddingModel` (18:72) -- `mcp_agent.workflows.embedding.embedding_openai.OpenAIEmbeddingModel` (18:70) +- `mcp_agent.workflows.embedding.embedding_base.EmbeddingModel` (13:31) +- `mcp_agent.workflows.embedding.embedding_cohere.CohereEmbeddingModel` (18:72) +- `mcp_agent.workflows.embedding.embedding_openai.OpenAIEmbeddingModel` (18:70) ### Orchestration Workflow @@ -60,9 +60,9 @@ Responsible for managing complex, multi-step agent behaviors. It defines how age **Related Classes/Methods**: -- `mcp_agent.workflows.orchestrator.orchestrator.Orchestrator` (45:585) -- `mcp_agent.workflows.orchestrator.orchestrator_models.AgentTask` (26:31) -- `mcp_agent.workflows.orchestrator.orchestrator_prompts` +- `mcp_agent.workflows.orchestrator.orchestrator.Orchestrator` (45:585) +- `mcp_agent.workflows.orchestrator.orchestrator_models.AgentTask` (26:31) +- `mcp_agent.workflows.orchestrator.orchestrator_prompts` ### Routing Workflow @@ -71,9 +71,9 @@ Intelligently directs incoming requests or tasks to the most appropriate agent, **Related Classes/Methods**: -- `mcp_agent.workflows.router.router_base.Router` (63:275) -- `mcp_agent.workflows.router.router_llm.LLMRouter` (81:373) -- `mcp_agent.workflows.router.router_embedding.EmbeddingRouter` (28:239) +- `mcp_agent.workflows.router.router_base.Router` (63:275) +- `mcp_agent.workflows.router.router_llm.LLMRouter` (81:373) +- `mcp_agent.workflows.router.router_embedding.EmbeddingRouter` (28:239) ### Intent Classification Workflow @@ -82,9 +82,9 @@ Dedicated to identifying the underlying intent of a user's query or system messa **Related Classes/Methods**: -- `mcp_agent.workflows.intent_classifier.intent_classifier_base.IntentClassifier` (42:85) -- `mcp_agent.workflows.intent_classifier.intent_classifier_llm.LLMIntentClassifier` (63:243) -- `mcp_agent.workflows.intent_classifier.intent_classifier_embedding.EmbeddingIntentClassifier` (32:177) +- `mcp_agent.workflows.intent_classifier.intent_classifier_base.IntentClassifier` (42:85) +- `mcp_agent.workflows.intent_classifier.intent_classifier_llm.LLMIntentClassifier` (63:243) +- `mcp_agent.workflows.intent_classifier.intent_classifier_embedding.EmbeddingIntentClassifier` (32:177) ### Parallel LLM Workflow @@ -93,9 +93,9 @@ Enables the concurrent execution of multiple LLM calls or agent actions. It impl **Related Classes/Methods**: -- `mcp_agent.workflows.parallel.parallel_llm.ParallelLLM` (23:279) -- `mcp_agent.workflows.parallel.fan_in.FanIn` (30:422) -- `mcp_agent.workflows.parallel.fan_out.FanOut` (23:243) +- `mcp_agent.workflows.parallel.parallel_llm.ParallelLLM` (23:279) +- `mcp_agent.workflows.parallel.fan_in.FanIn` (30:422) +- `mcp_agent.workflows.parallel.fan_out.FanOut` (23:243) ### Swarm Workflow @@ -104,9 +104,9 @@ Facilitates collaborative problem-solving among multiple agents. It enables agen **Related Classes/Methods**: -- `mcp_agent.workflows.swarm.swarm.Swarm` (189:310) -- `mcp_agent.workflows.swarm.swarm_anthropic.AnthropicSwarm` (8:41) -- `mcp_agent.workflows.swarm.swarm_openai.OpenAISwarm` (8:40) +- `mcp_agent.workflows.swarm.swarm.Swarm` (189:310) +- `mcp_agent.workflows.swarm.swarm_anthropic.AnthropicSwarm` (8:41) +- `mcp_agent.workflows.swarm.swarm_openai.OpenAISwarm` (8:40) ### Evaluation & Optimization Workflow @@ -115,9 +115,9 @@ Provides mechanisms for evaluating the performance, quality, and effectiveness o **Related Classes/Methods**: -- `mcp_agent.workflows.evaluator_optimizer.evaluator_optimizer.EvaluatorOptimizerLLM` (47:475) +- `mcp_agent.workflows.evaluator_optimizer.evaluator_optimizer.EvaluatorOptimizerLLM` (47:475) -### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) \ No newline at end of file +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) diff --git a/docs/codeboarding/Core_Application_Setup.mdx b/docs/codeboarding/Core_Application_Setup.mdx index 072d28dd0..72bb96d9b 100644 --- a/docs/codeboarding/Core_Application_Setup.mdx +++ b/docs/codeboarding/Core_Application_Setup.mdx @@ -39,7 +39,7 @@ The primary entry point and orchestrator of the `mcp-agent` application. It init **Related Classes/Methods**: -- `mcp_agent.app.MCPApp` (34:508) +- `mcp_agent.app.MCPApp` (34:508) ### Configuration Management (Settings) @@ -48,13 +48,13 @@ Centralized management for all application configurations, including API keys, s **Related Classes/Methods**: -- `mcp_agent.config.Settings` -- `mcp_agent.config.AnthropicSettings` -- `mcp_agent.config.OpenAISettings` -- `mcp_agent.config.TemporalSettings` -- `mcp_agent.config.AzureSettings` -- `mcp_agent.config.BedrockSettings` -- `mcp_agent.config.GoogleSettings` +- `mcp_agent.config.Settings` +- `mcp_agent.config.AnthropicSettings` +- `mcp_agent.config.OpenAISettings` +- `mcp_agent.config.TemporalSettings` +- `mcp_agent.config.AzureSettings` +- `mcp_agent.config.BedrockSettings` +- `mcp_agent.config.GoogleSettings` ### Decorator Registry @@ -63,7 +63,7 @@ A central registry for managing and retrieving decorators, enabling dynamic exte **Related Classes/Methods**: -- `mcp_agent.executor.decorator_registry.DecoratorRegistry` +- `mcp_agent.executor.decorator_registry.DecoratorRegistry` ### Signal Registry @@ -72,7 +72,7 @@ Provides a mechanism for registering and dispatching signals, facilitating event **Related Classes/Methods**: -- `mcp_agent.executor.signal_registry.SignalRegistry` (3:29) +- `mcp_agent.executor.signal_registry.SignalRegistry` (3:29) ### Task Registry (ActivityRegistry) @@ -81,7 +81,7 @@ A registry for managing and retrieving executable tasks or activities, allowing **Related Classes/Methods**: -- `mcp_agent.executor.task_registry.ActivityRegistry` +- `mcp_agent.executor.task_registry.ActivityRegistry` ### MCP Server Management @@ -90,9 +90,9 @@ Manages the lifecycle and connections to various Model Context Protocol (MCP) se **Related Classes/Methods**: -- `mcp_agent.mcp.mcp_connection_manager.MCPConnectionManager` -- `mcp_agent.mcp.mcp_server_registry.ServerRegistry` -- `mcp_agent.mcp.mcp_aggregator.MCPAggregator` (77:1357) +- `mcp_agent.mcp.mcp_connection_manager.MCPConnectionManager` +- `mcp_agent.mcp.mcp_server_registry.ServerRegistry` +- `mcp_agent.mcp.mcp_aggregator.MCPAggregator` (77:1357) ### LLM Selection @@ -101,10 +101,10 @@ Responsible for selecting and managing Large Language Models (LLMs), including t **Related Classes/Methods**: -- `mcp_agent.workflows.llm.llm_selector.ModelSelector` (96:413) -- `mcp_agent.workflows.llm.augmented_llm.AugmentedLLM` (218:668) +- `mcp_agent.workflows.llm.llm_selector.ModelSelector` (96:413) +- `mcp_agent.workflows.llm.augmented_llm.AugmentedLLM` (218:668) -### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) \ No newline at end of file +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) diff --git a/docs/codeboarding/Human_Interaction_Layer.mdx b/docs/codeboarding/Human_Interaction_Layer.mdx index a651fe218..41a1d740b 100644 --- a/docs/codeboarding/Human_Interaction_Layer.mdx +++ b/docs/codeboarding/Human_Interaction_Layer.mdx @@ -30,7 +30,7 @@ This is the central orchestrator for managing human input. It's responsible for **Related Classes/Methods**: -- `Human Input Handler` (1:1) +- `Human Input Handler` (1:1) ### Human Input Data Models @@ -39,7 +39,7 @@ This component defines the standardized data structures (e.g., `HumanInputReques **Related Classes/Methods**: -- `Human Input Data Models` (1:1) +- `Human Input Data Models` (1:1) ### Progress Display @@ -48,7 +48,7 @@ This component, specifically `RichProgressDisplay`, is responsible for providing **Related Classes/Methods**: -- `Progress Display` (1:1) +- `Progress Display` (1:1) ### Console Interface @@ -57,9 +57,9 @@ This foundational component provides the low-level interface for interacting wit **Related Classes/Methods**: -- `Console Interface` (1:1) +- `Console Interface` (1:1) -### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) \ No newline at end of file +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) diff --git a/docs/codeboarding/MCP_Service_Integration.mdx b/docs/codeboarding/MCP_Service_Integration.mdx index a59b7ecc4..e3c102ca9 100644 --- a/docs/codeboarding/MCP_Service_Integration.mdx +++ b/docs/codeboarding/MCP_Service_Integration.mdx @@ -34,7 +34,7 @@ The MCPAggregator serves as the central hub for collecting and consolidating cap **Related Classes/Methods**: -- `mcp_agent.mcp.mcp_aggregator.MCPAggregator` (77:1357) +- `mcp_agent.mcp.mcp_aggregator.MCPAggregator` (77:1357) ### MCPConnectionManager @@ -43,7 +43,7 @@ This component is responsible for the lifecycle management of network connection **Related Classes/Methods**: -- `mcp_agent.mcp.mcp_connection_manager.MCPConnectionManager` +- `mcp_agent.mcp.mcp_connection_manager.MCPConnectionManager` ### ServerRegistry @@ -52,7 +52,7 @@ The ServerRegistry acts as a persistent store for information about known MCP se **Related Classes/Methods**: -- `mcp_agent.mcp.mcp_server_registry.ServerRegistry` +- `mcp_agent.mcp.mcp_server_registry.ServerRegistry` ### MCPClientSession @@ -61,7 +61,7 @@ This component encapsulates the details of an individual client session with a s **Related Classes/Methods**: -- `mcp_agent.mcp.mcp_agent_client_session.MCPClientSession` +- `mcp_agent.mcp.mcp_agent_client_session.MCPClientSession` ### gen_client @@ -70,9 +70,9 @@ This module contains auto-generated client code that provides concrete methods f **Related Classes/Methods**: -- `mcp_agent.mcp.gen_client` (15:40) +- `mcp_agent.mcp.gen_client` (15:40) -### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) \ No newline at end of file +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq) diff --git a/docs/codeboarding/on_boarding.mdx b/docs/codeboarding/on_boarding.mdx new file mode 100644 index 000000000..212e0ddf3 --- /dev/null +++ b/docs/codeboarding/on_boarding.mdx @@ -0,0 +1,111 @@ +--- +title: "Architecture Overview" +description: "Comprehensive architectural overview of the mcp-agent framework" +--- + + +```mermaid +graph LR + Core_Application_Setup["Core Application & Setup"] + Agent_Execution_Workflow_Engine["Agent Execution & Workflow Engine"] + Agent_Core_LLM_Integration["Agent Core & LLM Integration"] + MCP_Service_Integration["MCP Service Integration"] + Agent_Workflow_Patterns["Agent Workflow Patterns"] + Human_Interaction_Layer["Human Interaction Layer"] + Core_Application_Setup -- "Configures" --> Agent_Execution_Workflow_Engine + Core_Application_Setup -- "Configures" --> MCP_Service_Integration + Agent_Execution_Workflow_Engine -- "Manages" --> Agent_Workflow_Patterns + Agent_Execution_Workflow_Engine -- "Requests input from" --> Human_Interaction_Layer + Agent_Core_LLM_Integration -- "Utilizes" --> MCP_Service_Integration + Agent_Core_LLM_Integration -- "Provides capabilities to" --> Agent_Workflow_Patterns + MCP_Service_Integration -- "Provides capabilities to" --> Agent_Core_LLM_Integration + Agent_Workflow_Patterns -- "Orchestrates" --> Agent_Core_LLM_Integration + Agent_Workflow_Patterns -- "Leverages" --> MCP_Service_Integration + Human_Interaction_Layer -- "Provides input to" --> Agent_Execution_Workflow_Engine + click Core_Application_Setup href "/codeboarding/Core_Application_Setup.md" "Details" + click Agent_Execution_Workflow_Engine href "/codeboarding/Agent_Execution_Workflow_Engine.md" "Details" + click Agent_Core_LLM_Integration href "/codeboarding/Agent_Core_LLM_Integration.md" "Details" + click MCP_Service_Integration href "/codeboarding/MCP_Service_Integration.md" "Details" + click Agent_Workflow_Patterns href "/codeboarding/Agent_Workflow_Patterns.md" "Details" + click Human_Interaction_Layer href "/codeboarding/Human_Interaction_Layer.md" "Details" +``` + + +This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework. + + +## Details + +The `mcp-agent` project provides a robust framework for developing AI agents. At its core, the **Core Application & Setup** component initializes the entire system and manages configurations. The **Agent Execution & Workflow Engine** then takes over, orchestrating the execution of various **Agent Workflow Patterns** (like orchestration, routing, or parallel processing) which define the agent's high-level behaviors. These workflows, in turn, leverage the **Agent Core & LLM Integration** component to interact with Large Language Models and perform agent-specific actions. The **MCP Service Integration** component is crucial for discovering and connecting to external Model Context Protocol (MCP) servers, providing the necessary tools and resources to the agents. Finally, the **Human Interaction Layer** enables human-in-the-loop capabilities, allowing agents to request and receive input from users, which is then processed by the Execution Engine. + +### Core Application & Setup [[Expand]](./Core_Application_Setup) +Initializes the entire agent framework, establishes the global application context, and manages the loading, parsing, and provision of application settings and sensitive information. It acts as the central orchestrator for the agent's environment and ensures all components operate with correct parameters. + + +**Related Classes/Methods**: + +- `mcp_agent/app.py` (1:1) +- `mcp_agent/config.py` (1:1) + + +### Agent Execution & Workflow Engine [[Expand]](./Agent_Execution_Workflow_Engine) +Manages the lifecycle and execution of tasks, activities, and complex workflows. It provides mechanisms for registering executable units and handling their state, supporting both immediate asynchronous execution and durable, long-running workflows. + + +**Related Classes/Methods**: + +- `mcp_agent/executor/executor.py` (1:1) +- `mcp_agent/executor/task_registry.py` (1:1) +- `mcp_agent/executor/signal_registry.py` (1:1) +- `mcp_agent/executor/decorator_registry.py` (1:1) +- `mcp_agent/executor/workflow.py` (1:1) + + +### Agent Core & LLM Integration [[Expand]](./Agent_Core_LLM_Integration) +Defines the fundamental interface and capabilities of an AI agent. It encapsulates interactions with Large Language Models (LLMs), external tools, prompts, and resources, providing a consistent and extensible model for agent behavior. It also offers a standardized and augmented interface for interacting with various LLM providers. + + +**Related Classes/Methods**: + +- `mcp_agent/agents/agent.py` (1:1) +- `mcp_agent/workflows/llm/augmented_llm.py` (1:1) +- `mcp_agent/workflows/llm/llm_selector.py` (1:1) + + +### MCP Service Integration [[Expand]](./MCP_Service_Integration) +Serves as a central point for discovering, collecting, and managing capabilities (tools, prompts, resources) exposed by various Model Context Protocol (MCP) servers. It also manages the underlying network connections and communication sessions with these external services. + + +**Related Classes/Methods**: + +- `mcp_agent/mcp/mcp_aggregator.py` (1:1) +- `mcp_agent/mcp/mcp_connection_manager.py` (1:1) +- `mcp_agent/mcp/mcp_server_registry.py` (1:1) + + +### Agent Workflow Patterns [[Expand]](./Agent_Workflow_Patterns) +Implements various complex, multi-step agent behaviors and patterns. This includes orchestrating sequences of actions, routing requests, classifying user intents, parallelizing LLM calls, and facilitating collaborative problem-solving among multiple agents. + + +**Related Classes/Methods**: + +- `mcp_agent/workflows/orchestrator/orchestrator.py` (1:1) +- `mcp_agent/workflows/router/router_base.py` (1:1) +- `mcp_agent/workflows/intent_classifier/intent_classifier_base.py` (1:1) +- `mcp_agent/workflows/parallel/parallel_llm.py` (1:1) +- `mcp_agent/workflows/swarm/swarm.py` (1:1) + + +### Human Interaction Layer [[Expand]](./Human_Interaction_Layer) +Handles all interactions requiring human input or feedback. It provides mechanisms for agents to request information from users and process their responses, enabling human-in-the-loop workflows. + + +**Related Classes/Methods**: + +- `mcp_agent/human_input/handler.py` (1:1) +- `mcp_agent/human_input/types.py` (1:1) + + + + +### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)