# automateyournetwork/pyats_mcp architecture

> Architecture diagram of the GitHub repository automateyournetwork/pyats_mcp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/automateyournetwork/pyats_mcp
- Repository: https://github.com/automateyournetwork/pyats_mcp

## Overview

pyATS MCP Server lets an MCP client invoke guarded network-automation tools against a configured or dynamically built pyATS testbed. The main workflow is client request → MCP tool execution → device or test-runner operation → structured result and audit entry. Dynamic inventory-to-testbed construction and asynchronous task polling are distinct supporting workflows. The README documents additional tool capabilities beyond the sampled implementation excerpts; those are represented at the server-module level without implying unsampled internal call paths.

Main entry points: [`pyats_mcp_server.py`](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py) (HTTP MCP Server), [`pyats_tasks.py`](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_tasks.py) (Task Extension), [`pyats_testbed_builder.py`](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py) (Testbed Builder)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["MCP Access"]
  node_server["HTTP MCP Server"]
end

subgraph group_testbeds["Testbed Management"]
  node_testbed_builder["Testbed Builder"]
  node_testbed_registry["Testbed Registry"]
  node_inventory_sources["Inventory Sources"]
  node_testbed["Active Testbed"]
end

subgraph group_operations["Network Operations"]
  node_device_discovery["Device Discovery"]
  node_show_health["Show And Health"]
  node_config_learn["Config And Learn"]
  node_fleet_commands["Fleet Commands"]
  node_tests_clean["Tests And Clean"]
  node_device_api["REST Device API"]
  node_xpresso["XPresso Requests"]
end

subgraph group_async["Task Management"]
  node_task_extension["Task Extension<br/>[pyats_tasks.py]"]
  node_task_store[("SQLite Task Store<br/>[pyats_tasks.py]")]
end

node_agent(("MCP Client"))
node_network_devices(("Network Devices"))
node_external_services(("Inventory And APIs"))

node_agent -->|"sends MCP requests"| node_server
node_server -->|"supports task polling"| node_task_extension
node_task_extension -->|"invokes tools"| node_server
node_task_extension -->|"persists task state"| node_task_store
node_server -->|"uses builder"| node_testbed_builder
node_testbed_builder -->|"fetches source records"| node_inventory_sources
node_server -->|"manages dynamic testbeds"| node_testbed_registry
node_server -->|"uses active testbed"| node_testbed
node_server -->|"offers discovery tools"| node_device_discovery
node_server -->|"offers show and health tools"| node_show_health
node_server -->|"offers config and learn tools"| node_config_learn
node_server -->|"offers fleet commands"| node_fleet_commands
node_server -->|"offers test and clean tools"| node_tests_clean
node_server -->|"offers REST requests"| node_device_api
node_server -->|"offers XPresso requests"| node_xpresso
node_device_discovery -->|"queries devices"| node_network_devices
node_show_health -->|"runs device commands"| node_network_devices
node_config_learn -->|"changes and learns state"| node_network_devices
node_fleet_commands -->|"fans out commands"| node_network_devices
node_tests_clean -->|"runs device tests"| node_network_devices
node_device_api -->|"calls device API"| node_network_devices
node_inventory_sources -->|"fetches inventory"| node_external_services
node_xpresso -->|"calls XPresso"| node_external_services

click node_server "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_task_extension "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_tasks.py"
click node_task_store "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_tasks.py"
click node_testbed_builder "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py"
click node_testbed_registry "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py"
click node_inventory_sources "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py"
click node_testbed "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_device_discovery "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_show_health "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_config_learn "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_fleet_commands "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_tests_clean "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_device_api "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"
click node_xpresso "https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_server,node_agent toneBlue
class node_testbed_builder,node_testbed_registry,node_inventory_sources,node_testbed toneAmber
class node_device_discovery,node_show_health,node_config_learn,node_fleet_commands,node_tests_clean,node_device_api,node_xpresso,node_external_services toneMint
class node_task_extension,node_task_store toneRose
class node_network_devices toneIndigo
```

## Components

### MCP Access

- [HTTP MCP Server](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`

### Testbed Management

- [Testbed Builder](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py): `pyats_testbed_builder.py`
- [Testbed Registry](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py): `pyats_testbed_builder.py`
- [Inventory Sources](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_testbed_builder.py): `pyats_testbed_builder.py`
- [Active Testbed](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`

### Network Operations

- [Device Discovery](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`
- [Show And Health](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`
- [Config And Learn](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`
- [Fleet Commands](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`
- [Tests And Clean](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`
- [REST Device API](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`
- [XPresso Requests](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_mcp_server.py): `pyats_mcp_server.py`

### Task Management

- [Task Extension](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_tasks.py): `pyats_tasks.py`
- [SQLite Task Store](https://github.com/automateyournetwork/pyats_mcp/blob/main/pyats_tasks.py): `pyats_tasks.py`

### Other components

- **MCP Client**
- **Network Devices**
- **Inventory And APIs**

## Connections

- MCP Client → HTTP MCP Server: sends MCP requests (evidence: `README.md`)
- HTTP MCP Server → Task Extension: supports task polling (evidence: `pyats_mcp_server.py`)
- Task Extension → HTTP MCP Server: invokes tools (evidence: `pyats_tasks.py`)
- Task Extension → SQLite Task Store: persists task state (evidence: `pyats_tasks.py`)
- HTTP MCP Server → Testbed Builder: uses builder (evidence: `pyats_mcp_server.py`)
- Testbed Builder → Inventory Sources: fetches source records (evidence: `README.md`)
- HTTP MCP Server → Testbed Registry: manages dynamic testbeds (evidence: `README.md`)
- HTTP MCP Server → Active Testbed: uses active testbed (evidence: `README.md`)
- HTTP MCP Server → Device Discovery: offers discovery tools (evidence: `README.md`)
- HTTP MCP Server → Show And Health: offers show and health tools (evidence: `README.md`)
- HTTP MCP Server → Config And Learn: offers config and learn tools (evidence: `README.md`)
- HTTP MCP Server → Fleet Commands: offers fleet commands (evidence: `README.md`)
- HTTP MCP Server → Tests And Clean: offers test and clean tools (evidence: `README.md`)
- HTTP MCP Server → REST Device API: offers REST requests (evidence: `README.md`)
- HTTP MCP Server → XPresso Requests: offers XPresso requests (evidence: `README.md`)
- Device Discovery → Network Devices: queries devices (evidence: `README.md`)
- Show And Health → Network Devices: runs device commands (evidence: `README.md`)
- Config And Learn → Network Devices: changes and learns state (evidence: `README.md`)
- Fleet Commands → Network Devices: fans out commands (evidence: `README.md`)
- Tests And Clean → Network Devices: runs device tests (evidence: `README.md`)
- REST Device API → Network Devices: calls device API (evidence: `README.md`)
- Inventory Sources → Inventory And APIs: fetches inventory (evidence: `README.md`)
- XPresso Requests → Inventory And APIs: calls XPresso (evidence: `README.md`)
