docs: Add MCP sharing warnings to shared gns3_copilot modules

This commit is contained in:
YueGuobin 2026-06-11 12:11:13 +08:00
parent b69ff17850
commit f0b0de2a91
No known key found for this signature in database
7 changed files with 32 additions and 0 deletions

View File

@ -29,6 +29,10 @@ GNS3 Connector Factory Module
This module provides factory functions for creating Gns3Connector instances
with JWT token authentication and context-aware configuration management.
WARNING: This module is shared with the MCP (Model Context Protocol) service.
The get_gns3_connector() function is used by both gns3-copilot and MCP.
Modifications must be tested with BOTH.
Features:
- Context variable based request-scoped data management (JWT tokens, LLM
config)

View File

@ -29,6 +29,10 @@ Adapted gns3fy module for GNS3-Copilot
This module is based on the upstream gns3fy project
(https://github.com/davidban77/gns3fy).
WARNING: This module is shared with the MCP (Model Context Protocol) service.
The Gns3Connector class is used by MCP handlers to make HTTP calls.
Modifications to this file must be tested with BOTH gns3-copilot AND MCP.
Modifications made for GNS3-Copilot:
- Adjusted pydantic usages and dataclass configuration to reduce dependency
conflicts with langchain (pydantic version/api differences)

View File

@ -30,6 +30,10 @@ This module provides a LangChain BaseTool to retrieve the topology of a
specific GNS3 project by project ID. Returns nodes, links, and project
metadata.
WARNING: This module is shared with the MCP (Model Context Protocol) service.
GNS3TopologyTool._run() is called by MCP device config handlers.
The jwt_token/url parameters were added for MCP compatibility.
Modifications must be tested with BOTH gns3-copilot AND MCP.
"""
import copy

View File

@ -26,6 +26,11 @@
This module provides a tool to execute configuration commands on multiple
devices in a GNS3 topology using Nornir.
WARNING: This module is shared with the MCP (Model Context Protocol) service.
ExecuteMultipleDeviceConfigCommands._run() is called by the MCP device_config_send handler.
The jwt_token/url parameters were added for MCP compatibility.
Modifications must be tested with BOTH gns3-copilot AND MCP.
"""
import json

View File

@ -26,6 +26,11 @@
This module provides a tool to execute display commands on multiple devices
in a GNS3 topology using Nornir.
WARNING: This module is shared with the MCP (Model Context Protocol) service.
ExecuteMultipleDeviceCommands._run() is called by the MCP device_command_run handler.
The jwt_token/url parameters were added for MCP compatibility.
Modifications must be tested with BOTH gns3-copilot AND MCP.
"""
import json

View File

@ -26,6 +26,11 @@
"""
This module provides a tool to execute commands on VPCS devices
in a GNS3 topology using Nornir with Netmiko.
WARNING: This module is shared with the MCP (Model Context Protocol) service.
VPCSCommands._run() is called by the MCP vpcs_config_set handler.
The jwt_token/url parameters were added for MCP compatibility.
Modifications must be tested with BOTH gns3-copilot AND MCP.
"""
import json

View File

@ -25,6 +25,11 @@
"""
Public module for getting device port information from GNS3 topology
WARNING: This module is shared with the MCP (Model Context Protocol) service.
get_device_ports_from_topology() is called by MCP device config handlers.
The jwt_token/url parameters were added for MCP compatibility.
Modifications must be tested with BOTH gns3-copilot AND MCP.
"""
import logging