Skip to content

Commit 19c85ee

Browse files
committed
docs: update codeboarding documentation and generate architecture
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service and automatically generated architecture documentation. ### 📊 Summary - Documentation files created/updated: 4 - JSON files created/updated: 5 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .mdx - Repository analyzed: https://github.com/mcp-use/mcp-use - Architecture documentation: docs/development/architecture.mdx (auto-generated) The generated .mdx files have been automatically appended to the development documentation, and the architecture.mdx file has been generated from the CodeBoarding analysis files. 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent f3c8a6a commit 19c85ee

File tree

6 files changed

+2
-288
lines changed

6 files changed

+2
-288
lines changed

.codeboarding/External_Integration_Layer.json

Lines changed: 0 additions & 140 deletions
This file was deleted.

.codeboarding/External_Integration_Layer.mdx

Lines changed: 0 additions & 71 deletions
This file was deleted.

.codeboarding/analysis.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
"reference_end_line": 1
118118
}
119119
],
120-
"can_expand": true
120+
"can_expand": false
121121
}
122122
],
123123
"components_relations": [
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "0cc2b40a441e9e576638fd155f03e3d250e01d0f",
2+
"commit_hash": "f3c8a6aed22679ad4ed431ccfdd0aab693c451ce",
33
"code_boarding_version": "0.1.0"
44
}

.codeboarding/on_boarding.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ graph LR
1818
click Agent_Core href "/codeboarding/Agent_Core.md" "Details"
1919
click Client_Server_Connectivity href "/codeboarding/Client_Server_Connectivity.md" "Details"
2020
click Tool_Abstraction_Management href "/codeboarding/Tool_Abstraction_Management.md" "Details"
21-
click External_Integration_Layer href "/codeboarding/External_Integration_Layer.md" "Details"
2221
```
2322

2423
<Info>

docs/development/architecture.mdx

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ graph LR
1818
click Agent_Core href "/codeboarding/Agent_Core.md" "Details"
1919
click Client_Server_Connectivity href "/codeboarding/Client_Server_Connectivity.md" "Details"
2020
click Tool_Abstraction_Management href "/codeboarding/Tool_Abstraction_Management.md" "Details"
21-
click External_Integration_Layer href "/codeboarding/External_Integration_Layer.md" "Details"
2221
```
2322

2423
<Info>
@@ -247,79 +246,6 @@ Defines the abstract interface for all agent types within the MCP system. It pro
247246
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/agents/base.py" target="_blank" rel="noopener noreferrer">`mcp_use.agents.base.BaseAgent`</a>
248247

249248

250-
# External Integration Layer
251-
```mermaid
252-
graph LR
253-
External_Integration_Layer["External Integration Layer"]
254-
Base_Adapter["Base Adapter"]
255-
LangChain_Adapter["LangChain Adapter"]
256-
Connector_Management_Logic["Connector Management Logic"]
257-
Tool_Resource_Prompt_Conversion_Helpers["Tool/Resource/Prompt Conversion Helpers"]
258-
External_Integration_Layer -- "contains" --> Base_Adapter
259-
External_Integration_Layer -- "contains" --> LangChain_Adapter
260-
Base_Adapter -- "defines the interface for" --> LangChain_Adapter
261-
Base_Adapter -- "orchestrates" --> Connector_Management_Logic
262-
LangChain_Adapter -- "leverages" --> Tool_Resource_Prompt_Conversion_Helpers
263-
click External_Integration_Layer href "/codeboarding/External_Integration_Layer.md" "Details"
264-
```
265-
266-
### Details
267-
268-
Abstract Components Overview
269-
270-
### External Integration Layer
271-
The overarching component responsible for abstracting and managing interactions with external AI frameworks and systems. It acts as the primary interface for `mcp-use` to leverage external functionalities, ensuring loose coupling and adaptability.
272-
273-
274-
**Related Classes/Methods**:
275-
276-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/base.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.base.BaseAdapter`</a>
277-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/langchain_adapter.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.langchain_adapter.LangChainAdapter`</a>
278-
279-
280-
### Base Adapter
281-
Defines the abstract interface and contract for all external integrations. It establishes the common methods and properties that any concrete adapter must implement, ensuring a consistent approach to integrating diverse external systems. It also orchestrates the lifecycle of connectors.
282-
283-
284-
**Related Classes/Methods**:
285-
286-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/base.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.base.BaseAdapter`</a>
287-
288-
289-
### LangChain Adapter
290-
A concrete implementation of the `BaseAdapter` specifically tailored for integrating with the LangChain framework. It translates `mcp-use`'s internal requests and data structures into LangChain-compatible formats and vice-versa, enabling the use of LangChain's agents, tools, and chains.
291-
292-
293-
**Related Classes/Methods**:
294-
295-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/langchain_adapter.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.langchain_adapter.LangChainAdapter`</a>
296-
297-
298-
### Connector Management Logic
299-
An internal helper component responsible for the initialization, configuration, and lifecycle management of connectors to external systems. It ensures that the necessary connections are established and maintained for adapters to function correctly.
300-
301-
302-
**Related Classes/Methods**:
303-
304-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/connectors/base.py" target="_blank" rel="noopener noreferrer">`mcp_use.connectors.base.BaseConnector`</a>
305-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/connectors/http.py" target="_blank" rel="noopener noreferrer">`mcp_use.connectors.http.HttpConnector`</a>
306-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/connectors/sandbox.py" target="_blank" rel="noopener noreferrer">`mcp_use.connectors.sandbox.SandboxConnector`</a>
307-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/connectors/stdio.py" target="_blank" rel="noopener noreferrer">`mcp_use.connectors.stdio.StdioConnector`</a>
308-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/connectors/websocket.py" target="_blank" rel="noopener noreferrer">`mcp_use.connectors.websocket.WebSocketConnector`</a>
309-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/session.py" target="_blank" rel="noopener noreferrer">`mcp_use.session.MCPSession`</a>
310-
311-
312-
### Tool/Resource/Prompt Conversion Helpers
313-
An internal helper component that performs specific data transformations, such as converting `mcp-use`'s internal tool definitions, resources, or prompt templates into formats compatible with external frameworks (e.g., LangChain's tool schema or prompt templates), and vice-versa.
314-
315-
316-
**Related Classes/Methods**:
317-
318-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/langchain_adapter.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.langchain_adapter.LangChainAdapter._convert_prompt`</a>
319-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/langchain_adapter.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.langchain_adapter.LangChainAdapter._convert_resource`</a>
320-
- <a href="https://github.com/mcp-use/mcp-use/blob/main/mcp_use/adapters/langchain_adapter.py" target="_blank" rel="noopener noreferrer">`mcp_use.adapters.langchain_adapter.LangChainAdapter._convert_tool`</a>
321-
322-
323249
# Tool Abstraction Management
324250
```mermaid
325251
graph LR

0 commit comments

Comments
 (0)