Skip to content

Commit 7127cf0

Browse files
committed
Fixed docs-update script
1 parent 9292b47 commit 7127cf0

File tree

2 files changed

+8
-63
lines changed

2 files changed

+8
-63
lines changed

.github/workflows/docs-update.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,6 @@ jobs:
9999
mkdir -p docs/development
100100
101101
# Initialize the architecture.mdx file
102-
echo "# Architecture Documentation" > docs/development/architecture.mdx
103-
echo "" >> docs/development/architecture.mdx
104-
echo "This document contains the complete architecture documentation generated from CodeBoarding analysis." >> docs/development/architecture.mdx
105102
echo "" >> docs/development/architecture.mdx
106103
107104
# First, add on_boarding.mdx if it exists

docs/development/architecture.mdx

Lines changed: 8 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
# Architecture Documentation
2-
3-
This document contains the complete architecture documentation generated from CodeBoarding analysis.
4-
51
---
62
title: "Architecture Overview"
73
description: "Comprehensive architectural overview of the mcp-agent framework"
4+
icon: "network"
85
---
96

107

@@ -115,10 +112,7 @@ Manages the registration, discovery, and lifecycle of MCP servers and the tools
115112
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
116113

117114

118-
---
119-
title: "Agent Core Orchestration"
120-
description: "Agent Core Orchestration component details"
121-
---
115+
# Agent Core Orchestration
122116

123117

124118
```mermaid
@@ -137,14 +131,6 @@ graph LR
137131
ServerManager -- "uses" --> LangChainAdapter
138132
```
139133

140-
<Info>
141-
This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework.
142-
</Info>
143-
144-
## Details
145-
146-
Abstract Components Overview
147-
148134
### MCPAgent
149135
The primary class for the LLM agent, orchestrating its behavior, managing interactions with LLMs, and utilizing available tools. It is the core of the 'Agent Core & Orchestration' component, responsible for the overall decision-making and execution flow.
150136

@@ -200,10 +186,7 @@ Provides observability into the agent's execution. It tracks key events, perform
200186
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
201187

202188

203-
---
204-
title: "Client Session Management"
205-
description: "Client Session Management component details"
206-
---
189+
# Client Session Management
207190

208191

209192
```mermaid
@@ -216,11 +199,7 @@ graph LR
216199
MCPClient -- "interacts with" --> ServerManager
217200
```
218201

219-
<Info>
220-
This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework.
221-
</Info>
222-
223-
## Details
202+
### Details
224203

225204
This section details the Client & Session Management subsystem, which serves as the primary interface for users to interact with the MCP framework. It is responsible for initiating and managing user sessions, providing the necessary context for agent interactions. These components are fundamental because they establish the entry point for user interaction (MCPClient) and manage the entire lifecycle and context of that interaction (MCPSession). Without them, the MCP framework would lack a structured way for users to engage with the LLM agents and for the agents to maintain conversational state and continuity. They embody the core principles of a client-server architecture and session management, which are critical for any interactive system, especially one involving complex, multi-turn agent interactions.
226205

@@ -247,10 +226,7 @@ The MCPSession manages the state and context of an ongoing MCP interaction or se
247226
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
248227

249228

250-
---
251-
title: "Communication Connectors"
252-
description: "Communication Connectors component details"
253-
---
229+
# Communication Connectors
254230

255231

256232
```mermaid
@@ -277,10 +253,6 @@ graph LR
277253
StreamableHttpConnectionManager -- "utilizes" --> HttpConnector
278254
```
279255

280-
<Info>
281-
This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework.
282-
</Info>
283-
284256
## Details
285257

286258
The `Communication Connectors` component is fundamental to the `LLM Agent Framework/Orchestration Library` because it provides the essential communication layer for the `MCPAgent` to interact with various MCP servers and execute tools. This component embodies the **Adapter Pattern**, abstracting the complexities of different communication protocols (WebSocket, HTTP, Sandbox, Stdio) behind a unified `BaseConnector` interface. This modular design allows for easy integration of new communication methods without altering the core agent logic, which is crucial for the framework's extensibility and adaptability in diverse deployment environments.
@@ -380,11 +352,7 @@ Manages streamable HTTP connections, allowing for efficient handling of large da
380352
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
381353

382354

383-
---
384-
title: "Connection Management"
385-
description: "Connection Management component details"
386-
---
387-
355+
# Connection Management
388356

389357
```mermaid
390358
graph LR
@@ -413,10 +381,6 @@ graph LR
413381
SandboxConnector -- "utilizes" --> SseConnectionManager
414382
```
415383

416-
<Info>
417-
This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework.
418-
</Info>
419-
420384
## Details
421385

422386
Abstract Components Overview
@@ -516,11 +480,7 @@ A concrete implementation of BaseConnector likely designed to handle connections
516480
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
517481

518482

519-
---
520-
title: "LLM Integration Adapters"
521-
description: "LLM Integration Adapters component details"
522-
---
523-
483+
# LLM Integration Adapters
524484

525485
```mermaid
526486
graph LR
@@ -534,10 +494,6 @@ graph LR
534494
MCPAgent -- "uses" --> ServerManager
535495
```
536496

537-
<Info>
538-
This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework.
539-
</Info>
540-
541497
## Details
542498

543499
This component provides a standardized and extensible mechanism for integrating diverse external LLM frameworks, such as LangChain, and their associated components (tools, resources, prompts) into the MCP's internal operational model. It leverages the Adapter Pattern to ensure compatibility and facilitate seamless interaction with various LLM providers, abstracting away framework-specific complexities. This is fundamental for the "LLM Agent Framework/Orchestration Library" as it allows the agent to be agnostic to the underlying LLM framework.
@@ -571,11 +527,7 @@ The central orchestrator of the MCP system. It interacts with and utilizes LLM-b
571527
### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
572528

573529

574-
---
575-
title: "Resource Tool Management"
576-
description: "Resource Tool Management component details"
577-
---
578-
530+
# Resource Tool Management
579531

580532
```mermaid
581533
graph LR
@@ -600,10 +552,6 @@ graph LR
600552
UseToolFromServerTool -- "interacts with" --> ServerManager
601553
```
602554

603-
<Info>
604-
This documentation was generated by [CodeBoarding](https://github.com/CodeBoarding/GeneratedOnBoardings) to provide comprehensive architectural insights into the mcp-agent framework.
605-
</Info>
606-
607555
## Details
608556

609557
Updated analysis of MCP components, correcting source code references for ServerManager and validating ToolSearchEngine interaction.

0 commit comments

Comments
 (0)