Skip to main content
Glama

Tunnel Manager

CLI or API | MCP | Agent

PyPI - Version MCP Server PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Documentation — Installation, deployment, usage across the API, CLI, and MCP and agent interfaces are maintained in the official documentation.


Related MCP server: mcp-ssh

Overview

Tunnel Manager is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with Create SSH Tunnels to the operator's remote hosts and host as an MCP Server for Agentic AI!.


Key Features

  • Consolidated Action-Routed MCP Tools: Minimizes token overhead and eliminates tool bloat in LLM contexts by grouping methods into optimized, togglable tool modules.

  • Enterprise-Grade Security: Complete support for Eunomia policies, OIDC token delegation, and granular execution context tracking.

  • Integrated Graph Agent: Built-in Pydantic AI agent supporting the Agent Control Protocol (ACP) and standard Web interfaces (AG-UI).

  • Native Telemetry & Tracing: Out-of-the-box OpenTelemetry exports and native Langfuse tracing.


CLI or API

This agent wraps the Create SSH Tunnels to the operator's remote hosts and host as an MCP Server for Agentic AI! API. The operator can interact with it programmatically or via its integrated execution entrypoints.

Detailed instructions on how to use the underlying API wrappers, extended schema bindings, and developer SDK references are maintained in docs/index.md.


MCP

This server use dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.

Available MCP Tools

Auto-generated from the live MCP server — do not edit by hand.

Condensed action-routed tools (MCP_TOOL_MODE=condensed)

MCP Tool

Toggle Env Var

Description

tm_files

FILETOOL

Advanced file operations on remote hosts.

tm_hosts

HOSTTOOL

Manage the local host alias inventory.

tm_inventory

INVENTORYTOOL

Bulk inventory operations against YAML host groups.

tm_operations

OPERATIONSTOOL

Operation lifecycle and session management.

tm_remote

REMOTETOOL

Single-host SSH operations with shared connection params.

tm_security

SECURITYTOOL

Security scanning and compliance.

tm_system

SYSTEMTOOL

Remote system intelligence via SSH.

tunnel_ingest_hosts

INGESTTOOL

List the managed SSH inventory and push it into the medulla KG.

Verbose 1:1 API-mapped tools (MCP_TOOL_MODE=verbose or both)

MCP Tool

Toggle Env Var

Description

tunnel_manager_add_host

HOST_MANAGERTOOL

Invoke the add_host operation.

tunnel_manager_get_host

HOST_MANAGERTOOL

Get a host config by alias, denying an alias the caller isn't entitled to.

tunnel_manager_list_hosts

HOST_MANAGERTOOL

List the host aliases the CALLER is entitled to, secrets redacted.

tunnel_manager_load_inventory

HOST_MANAGERTOOL

Invoke the load_inventory operation.

tunnel_manager_remove_host

HOST_MANAGERTOOL

Invoke the remove_host operation.

tunnel_manager_save_inventory

HOST_MANAGERTOOL

Invoke the save_inventory operation.

8 action-routed tool(s) · 6 verbose 1:1 tool(s). Each is enabled unless its <DOMAIN>TOOL toggle is set false; MCP_TOOL_MODE selects the surface (intent default — the six verb-tools, granular set loaded on demand · condensed action-routed · verbose 1:1 · both). Auto-generated — do not edit.

Detailed tool schemas, parameter shapes, and validation constraints are preserved in docs/usage.md.

Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows the operator to restrict the set of exposed tools to prevent blowing up the LLM's context window.

The operator can configure tool filtering via multiple input channels:

  • CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.

  • Environment Variables: Define standard environment variables:

    • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS

    • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS

  • HTTP SSE Request Headers: Pass custom headers during transport initialization:

    • x-mcp-enabled-tools / x-mcp-disabled-tools

    • x-mcp-enabled-tags / x-mcp-disabled-tags

  • HTTP SSE Request Query Parameters: Append query parameters directly to the operator's transport connection URL:

    • ?tools=tool1,tool2

    • ?tags=tag1

When query strings or parameters are supplied, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.


MCP Configuration Examples

Install the connector-focused [mcp] extra. Examples use tunnel-manager[mcp] to add FastMCP / FastAPI through scion-sdk[mcp]; the required Meristem core still carries medulla[full]. The [agent-runtime] extra additionally enables model orchestration.

stdio Transport (local IDEs — Cursor, Claude Desktop, VS Code)

{
  "mcpServers": {
    "tunnel-manager-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "tunnel-manager[mcp]",
        "tunnel-manager-mcp"
      ],
      "env": {
        "MCP_TOOL_MODE": "intent",
        "FILETOOL": "True",
        "HOSTTOOL": "True",
        "INGESTTOOL": "True",
        "INVENTORYTOOL": "True",
        "OPERATIONSTOOL": "True",
        "REMOTETOOL": "True",
        "SECURITYTOOL": "True",
        "SYSTEMTOOL": "True",
        "TUNNEL_IDENTITY_FILE": "~/.ssh/id_ed25519",
        "TUNNEL_INVENTORY_GROUP": "all",
        "TUNNEL_KG_INGEST": "true",
        "TUNNEL_KNOWN_HOSTS": "~/.ssh/known_hosts",
        "TUNNEL_MANAGER_HEALTH_AGGREGATE_S": "3600",
        "TUNNEL_MANAGER_HEALTH_INGEST": "true",
        "TUNNEL_MANAGER_HOSTS": "node-a,node-b,node-c,node-d",
        "TUNNEL_MAX_THREADS": "6",
        "TUNNEL_PARALLEL": "False",
        "TUNNEL_REMOTE_PORT": "22"
      }
    }
  }
}

Runtime references require an alias-aware launcher such as Arbora. Other launchers must omit those entries and inject the resolved values through their own runtime secret boundary.

Streamable-HTTP Transport (networked / production)

{
  "mcpServers": {
    "tunnel-manager-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "tunnel-manager[mcp]",
        "tunnel-manager-mcp",
        "--transport",
        "streamable-http",
        "--port",
        "8000"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "127.0.0.1",
        "PORT": "8000",
        "MCP_TOOL_MODE": "intent",
        "FILETOOL": "True",
        "HOSTTOOL": "True",
        "INGESTTOOL": "True",
        "INVENTORYTOOL": "True",
        "OPERATIONSTOOL": "True",
        "REMOTETOOL": "True",
        "SECURITYTOOL": "True",
        "SYSTEMTOOL": "True",
        "TUNNEL_IDENTITY_FILE": "~/.ssh/id_ed25519",
        "TUNNEL_INVENTORY_GROUP": "all",
        "TUNNEL_KG_INGEST": "true",
        "TUNNEL_KNOWN_HOSTS": "~/.ssh/known_hosts",
        "TUNNEL_MANAGER_HEALTH_AGGREGATE_S": "3600",
        "TUNNEL_MANAGER_HEALTH_INGEST": "true",
        "TUNNEL_MANAGER_HOSTS": "node-a,node-b,node-c,node-d",
        "TUNNEL_MAX_THREADS": "6",
        "TUNNEL_PARALLEL": "False",
        "TUNNEL_REMOTE_PORT": "22"
      }
    }
  }
}

Alternatively, connect to a pre-deployed Streamable-HTTP instance by url:

{
  "mcpServers": {
    "tunnel-manager-mcp": {
      "url": "http://localhost:8000/tunnel-manager-mcp/mcp"
    }
  }
}

Run a reviewed container image as a least-privilege stdio child (no listener or published port):

docker run -i --rm \
  --read-only \
  --cap-drop=ALL \
  --security-opt=no-new-privileges \
  --pids-limit=256 \
  --tmpfs /tmp:rw,noexec,nosuid,nodev,size=64m \
  -e TRANSPORT=stdio \
  -e MCP_TOOL_MODE=intent \
  -e FILETOOL=True \
  -e HOSTTOOL=True \
  -e INGESTTOOL=True \
  -e INVENTORYTOOL=True \
  -e OPERATIONSTOOL=True \
  -e REMOTETOOL=True \
  -e SECURITYTOOL=True \
  -e SYSTEMTOOL=True \
  -e TUNNEL_IDENTITY_FILE=~/.ssh/id_ed25519 \
  -e TUNNEL_INVENTORY_GROUP=all \
  -e TUNNEL_KG_INGEST=true \
  -e TUNNEL_KNOWN_HOSTS=~/.ssh/known_hosts \
  -e TUNNEL_MANAGER_HEALTH_AGGREGATE_S=3600 \
  -e TUNNEL_MANAGER_HEALTH_INGEST=true \
  -e TUNNEL_MANAGER_HOSTS=node-a,node-b,node-c,node-d \
  -e TUNNEL_MAX_THREADS=6 \
  -e TUNNEL_PARALLEL=False \
  -e TUNNEL_REMOTE_PORT=22 \
  registry.example.invalid/tunnel-manager@sha256:<digest> tunnel-manager-mcp

For containerized network HTTP, supply an authenticated TLS ingress (or direct server TLS), exact MCP_ALLOWED_HOSTS, and an exact trusted-proxy CIDR policy through the operator-owned deployment profile. The generator does not emit an unauthenticated non-loopback listener.

Identity and host entitlements

Over stdio, and over HTTP started with --auth-type none (for example behind arbora), every caller is the trusted local actor and reaches every inventory alias. With auth configured, a caller reaches only the aliases its roles or groups grant (ssh:<alias>, ssh:* or admin). A refusal names its cause: anonymous caller, unauthenticated, no tenant, or not entitled to ssh:<alias>. See scion-sdk's connector servers: caller identity.

Auto-generated from the code-read env surface (MCP_TOOL_MODE + package vars) — do not edit.

Additional Deployment Options

tunnel-manager can run as a local stdio process or container, or behind a remote network boundary. The Deployment guide carries the detailed transport contract.

  • Local container — launch a reviewed immutable image as a least-privilege stdio child with no listener or published port.

  • Remote URL — connect through an operator-supplied authenticated HTTPS ingress. Keep its URL, outbound identity references, trust profile, and exact MCP_ALLOWED_HOSTS in AgentConfig.


Inventory

tunnel-manager works from a single shared YAML inventory that maps short host aliases (e.g. edge-node) to their SSH connection details. Every ecosystem surface reads the same file — the HostManager API, the tunnel-manager CLI, the MCP server, container-manager-mcp (its cm_* host aliases), and the ssh-bootstrap skill — so the operator define the operator's fleet once.

  • Location — ~/.config/scion-sdk/inventory.yml (the only location). Override with TUNNEL_INVENTORY.

  • Manage it with the inventory subcommand:

    tunnel-manager inventory init     # write a commented inventory.yml template (--force to overwrite)
    tunnel-manager inventory doctor   # validate hosts/groups
    tunnel-manager inventory show     # print the resolved path + host/group summary

Full schema, every host field, the copy-paste template, and override options live in the Inventory guide.


Environment Variables

Package environment variables

Variable

Example

Description

HOST

127.0.0.1

PORT

8000

TRANSPORT

stdio

options: stdio, streamable-http, sse

ENABLE_OTEL

True

OTEL_EXPORTER_OTLP_ENDPOINT

http://localhost:8080/api/public/otel

OTEL_EXPORTER_OTLP_PUBLIC_KEY

secret-injected

OTEL_EXPORTER_OTLP_SECRET_KEY

secret-injected

OTEL_EXPORTER_OTLP_PROTOCOL

http/protobuf

EUNOMIA_TYPE

none

options: none, embedded, remote

EUNOMIA_POLICY_FILE

mcp_policies.json

EUNOMIA_REMOTE_URL

http://eunomia-server:8000

TUNNEL_IDENTITY_FILE

~/.ssh/id_ed25519

DEBUG

False

PYTHONUNBUFFERED

1

TUNNEL_REMOTE_HOST

—

default remote host (e.g. 198.51.100.10)

TUNNEL_REMOTE_PORT

22

default SSH port

TUNNEL_USERNAME

—

default SSH username

TUNNEL_PASSWORD_REF

—

env://, vault://, secret://, or sqlite:// reference

TUNNEL_KNOWN_HOSTS

~/.ssh/known_hosts

independently verified server host keys

TUNNEL_CERTIFICATE

—

path to an SSH certificate file

TUNNEL_PROXY_COMMAND

—

SSH ProxyCommand for jump-host/bastion connections

TUNNEL_INVENTORY

—

path to the inventory file (defaults to XDG config path)

TUNNEL_INVENTORY_GROUP

all

inventory host group to target

TUNNEL_PARALLEL

False

run host operations in parallel

TUNNEL_MAX_THREADS

6

max worker threads when TUNNEL_PARALLEL=True

TUNNEL_MAX_COMMAND_CHARS

65536

TUNNEL_MAX_OUTPUT_BYTES

1048576

TUNNEL_MAX_TRANSFER_BYTES

268435456

TUNNEL_MAX_FLEET_HOSTS

1000

TUNNEL_MAX_CONCURRENCY

64

XDG_CONFIG_HOME

—

base config dir (defaults to ~/.config) for inventory resolution

HOSTTOOL

True

Grouped condensed-surface toggles, one per register__tools registrar.

REMOTETOOL

True

INVENTORYTOOL

True

OPERATIONSTOOL

True

SYSTEMTOOL

True

FILETOOL

True

SECURITYTOOL

True

INGESTTOOL

True

KG-ingest tools (list the SSH inventory into medulla)

TUNNEL_KG_INGEST

true

default-on best-effort inventory ingest on list

TUNNEL_MANAGER_HEALTH_INGEST

true

default-on best-effort network-signal trend ingestion

TUNNEL_MANAGER_HEALTH_AGGREGATE_S

3600

window (s) over which samples distill to ONE :HealthTrend node/host/signal

TUNNEL_MANAGER_HOSTS

node-a,node-b,node-c,node-d

comma-separated inventory aliases to probe/derive over (default: full inventory)

TUNNEL_MANAGER_HEALTH_NOTIFY_URL

—

best-effort webhook for network-anomaly notifications

Inherited scion-sdk variables (apply to every connector)

Variable

Example

Description

MCP_TOOL_MODE

intent

Tool surface: intent | condensed | verbose | both

MCP_ENABLED_TOOLS

—

Comma-separated tool allow-list

MCP_DISABLED_TOOLS

—

Comma-separated tool deny-list

MCP_ENABLED_TAGS

—

Comma-separated tag allow-list

MCP_DISABLED_TAGS

—

Comma-separated tag deny-list

MCP_CLIENT_AUTH

—

Outbound MCP child auth: oidc-client-credentials | basic | none

OIDC_CLIENT_ID

—

OIDC client id (service-account auth)

OIDC_CLIENT_SECRET_REF

secret://identity/oidc-client-secret

Runtime secret reference for the OIDC service account

MCP_BASIC_AUTH_USERNAME

—

HTTP Basic username (MCP_CLIENT_AUTH=basic)

MCP_BASIC_AUTH_PASSWORD_REF

secret://identity/mcp-basic-password

Runtime secret reference for HTTP Basic auth (MCP_CLIENT_AUTH=basic)

MCP_URL

http://localhost:8000/mcp

URL of the MCP server the agent connects to

PROVIDER

openai

LLM provider for the agent

MODEL_ID

gpt-4o

Model id for the agent

ENABLE_WEB_UI

True

Serve the AG-UI web interface

44 package + 14 inherited variable(s). Auto-generated from .env.example + the shared scion-sdk set — do not edit.

Every variable the server reads, grouped by purpose. See .env.example for a copy-paste starting point.

SSH connection & credentials

Variable

Description

Default

TUNNEL_IDENTITY_FILE

Path to the SSH private key

~/.ssh/id_ed25519

TUNNEL_USERNAME

SSH username

—

TUNNEL_PASSWORD_REF

env://, vault://, secret://, or sqlite:// SSH password reference

—

TUNNEL_KNOWN_HOSTS

Independently checked SSH server-key trust store

~/.ssh/known_hosts

TUNNEL_CERTIFICATE

Path to an SSH certificate

—

TUNNEL_REMOTE_HOST

Default remote host

—

TUNNEL_REMOTE_PORT

Default remote SSH port

22

TUNNEL_PROXY_COMMAND

SSH ProxyCommand for jump hosts

—

Inventory & parallelism

Variable

Description

Default

TUNNEL_INVENTORY

Path to the shared inventory (.yml preferred, .yaml legacy fallback)

~/.config/scion-sdk/inventory.yml

TUNNEL_INVENTORY_GROUP

Default inventory host group

—

TUNNEL_PARALLEL

Run bulk operations in parallel

—

TUNNEL_MAX_THREADS

Max concurrent SSH worker threads

—

XDG_CONFIG_HOME

Base config dir used to resolve the inventory

~/.config

MCP server / transport

Variable

Description

Default

TRANSPORT

stdio, streamable-http, or sse

stdio

HOST

Bind host (HTTP transports)

127.0.0.1

PORT

Bind port (HTTP transports)

8000

MCP_TOOL_MODE

Tool surface: condensed, verbose, or both

condensed

MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS

Comma-separated tool allow/deny list

—

MCP_ENABLED_TAGS / MCP_DISABLED_TAGS

Comma-separated tag allow/deny list

—

DEBUG

Verbose logging

False

PYTHONUNBUFFERED

Unbuffered stdout (recommended in containers)

1

Tool toggles

Each action-routed tool can be disabled individually via its toggle env var (set to false). The full list is in the Available MCP Tools table above (HOSTTOOL, REMOTETOOL, INVENTORYTOOL, OPERATIONSTOOL, SYSTEMTOOL, FILETOOL, SECURITYTOOL).

Telemetry & governance

Variable

Description

Default

ENABLE_OTEL

Enable OpenTelemetry export

True

OTEL_EXPORTER_OTLP_ENDPOINT

OTLP collector endpoint

—

OTEL_EXPORTER_OTLP_PUBLIC_KEY / OTEL_EXPORTER_OTLP_SECRET_KEY

OTLP auth keys

—

OTEL_EXPORTER_OTLP_PROTOCOL

OTLP protocol (e.g. http/protobuf)

—

EUNOMIA_TYPE

Authorization mode: none, embedded, remote

none

EUNOMIA_POLICY_FILE

Embedded policy file

mcp_policies.json

EUNOMIA_REMOTE_URL

Remote Eunomia server URL

—

Agent runtime (full [agent] runtime only)

Variable

Description

Default

MCP_URL

URL of the MCP server the agent connects to

http://localhost:8000/mcp

PROVIDER

LLM provider (e.g. openai)

openai

MODEL_ID

Model id (e.g. gpt-4o)

gpt-4o

ENABLE_WEB_UI

Serve the AG-UI web interface

True

Agent

This repository features a fully integrated Pydantic AI Graph Agent. It communicates over the Agent Control Protocol (ACP) and interacts smoothly with the Agent Web UI (AG-UI) and Terminal interface.

Running the Agent CLI

To start the interactive command-line agent:

# Set credentials
export TUNNEL_IDENTITY_FILE="your_value"
export DEBUG="your_value"
export PYTHONUNBUFFERED="your_value"

# Run the agent server
tunnel-manager-agent --provider openai --model-id gpt-4o

Docker Compose Orchestration

The following docker/agent.compose.yml configures the Agent, Web UI, and Terminal Interface together:

version: '3.8'

services:
  tunnel-manager-mcp:
    image: example/tunnel-manager:mcp
    container_name: tunnel-manager-mcp
    hostname: tunnel-manager-mcp
    restart: always
    env_file:
      - ../.env
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=streamable-http
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

  tunnel-manager-agent:
    image: example/tunnel-manager@sha256:<digest>
    container_name: tunnel-manager-agent
    hostname: tunnel-manager-agent
    restart: always
    depends_on:
      - tunnel-manager-mcp
    env_file:
      - ../.env
    command: [ "tunnel-manager-agent" ]
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=9002
      - MCP_URL=http://tunnel-manager-mcp:8000/mcp
      - PROVIDER=${PROVIDER:-openai}
      - MODEL_ID=${MODEL_ID:-gpt-4o}
      - ENABLE_WEB_UI=True
      - ENABLE_OTEL=True
    ports:
      - "9002:9002"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:9002/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

Detailed graph node architecture explanations, custom skill configurations, and agentic trace guides are available in docs/deployment.md.


Security & Governance

Built directly upon the enterprise-ready scion-sdk core, standard security parameters are fully supported:

Access Control & Policy Enforcement

  • Eunomia Policies: Fine-grained, policy-driven tool authorization. Supports none, local embedded (mcp_policies.json), or centralized remote modes.

  • OIDC Token Delegation: Compliant with RFC 8693 token exchange for flowing authenticating user credentials from Web UI / ACP → Agent → MCP.

  • Scoped Credentials: Execution context runs restricted to the specific caller identity.

Runtime Security Grid

Feature

Feature

Enablement

Tool Guard

Sensitivity inspection with human-in-the-loop validation

Enabled by default

Prompt Injection Defense

Input scanning, repetition monitoring, and recursive loop blocks

Enabled by default

Context Safety Guard

Stuck-loop detectors and contextual overflow preemptive alerts

Enabled by default


Installation

Pick the extra that matches what the operator want to run:

Extra

Installs

Use when

tunnel-manager[mcp]

Connector-focused MCP server (scion-sdk[mcp] — FastMCP/FastAPI + medulla[full])

The operator only run the MCP server (smallest install / image)

tunnel-manager[agent]

Agent runtime (scion-sdk[agent-runtime,logfire] — model orchestration + medulla[full])

The operator run the integrated agent

tunnel-manager[all]

Everything (mcp + agent + logfire)

Development / both surfaces

# Connector-focused MCP server (includes the shared graph engine)
uv pip install "tunnel-manager[mcp]"

# Agent runtime (adds model orchestration to the shared graph engine)
uv pip install "tunnel-manager[agent]"

# Everything (development)
uv pip install "tunnel-manager[all]"      # or: python -m pip install "tunnel-manager[all]"

Container images (:mcp vs :agent)

One multi-stage docker/Dockerfile builds two right-sized images, selected by --target:

Image tag

Build target

Contents

Entrypoint

example/tunnel-manager:mcp

--target mcp

tunnel-manager[mcp] — connector-focused, includes medulla[full]; no model-orchestration stack

tunnel-manager-mcp

example/tunnel-manager@sha256:<digest>

--target agent (default)

tunnel-manager[agent] — agent runtime, model orchestration + medulla[full]

tunnel-manager-agent

docker build --target mcp   -t example/tunnel-manager:mcp    docker/   # connector-focused MCP server
docker build --target agent -t example/tunnel-manager:agent-local docker/   # agent runtime

docker/mcp.compose.yml runs the connector-focused :mcp server; docker/agent.compose.yml runs the agent (immutable agent digest) with a co-located :mcp sidecar.

Knowledge-graph database (medulla)

Both [mcp] and [agent] carry the medulla engine through the required Meristem core dependency (medulla[full]). The [mcp] extra keeps the server connector-focused; [agent] also enables model orchestration. Local deployments can use the bundled engine. For production or shared state, run medulla as a dedicated database service and configure the runtime to use it. Deployment recipes (single-node + Raft HA), connection configuration, and architecture diagrams are documented in the medulla deployment guide.


Documentation

The complete documentation is published as the official documentation site and is the recommended reference for installation, deployment, and day-to-day operation.

Page

Contents

Installation

pip, source, extras, prebuilt Docker image

Inventory

the shared inventory.yaml — default location, how to create it, formats, overrides

Deployment

run the MCP and agent servers, Compose, Caddy + Technitium, env config

Usage

the MCP tools, the HostManager / Tunnel API, the CLI

Overview

ecosystem role, distributed SSH swarm scaling, MCP configuration

Teleport Architecture

certificate, proxy and cross-OS connection model

Concepts

concept registry (CONCEPT:TUN-*)

AGENTS.md is the canonical contributor/agent guidance.

Maintainers

Maintained by the project contributor team. Package metadata intentionally uses a role address rather than personal identity.


Contribute

Contributions are welcome! Please ensure code quality by running local checks before submitting pull requests:

  • Format code using ruff format .

  • Lint code using ruff check .

  • Validate type-safety with mypy .

  • Run test suites using pytest

Deploy with scion-sdk-deployment

Provision this package with the consolidated scion-sdk-deployment workflow. It selects an installed-package, editable-source, or immutable-container path; records only runtime secret and TLS-profile references in AgentConfig; and runs doctor, registration, policy, observability, and rollback gates. Ask your agent to "deploy tunnel-manager with scion-sdk-deployment".

Install mode

Command

Installed package

uv tool install "tunnel-manager[mcp]", then run tunnel-manager-mcp

Editable source

uv pip install -e ".[agent]", then run tunnel-manager-mcp

Immutable container

deploy registry.example.invalid/tunnel-manager@sha256:<digest> through the operator-selected orchestrator

The repository embeds no deployment profile, credential value, certificate path, or environment-specific endpoint. Supply those at runtime through AgentConfig and the configured secret provider.

Governed capability contract

This package ships a compact canonical skill surface with specialist procedures kept as referenced workflows. The current MCP tools, skill metadata, connector_manifest.yml, ontology, mappings, shapes, fixtures, migrations, tool-schema fingerprints, and certification metadata form one versioned capability contract. Validate them together; do not rely on stale tool names or historical per-task skill wrappers.

Runtime endpoints, credentials, certificate trust, tenant identity, retention, and observability policy are deployment inputs and are never packaged values. See Configuration, trust, and privacy before enabling a network transport, connector ingestion, Arbora delegation, or trace export.

Available Tools

41 tools
tm_file_backupBackupC

Backup (tm_files). Advanced file operations on remote hosts.

Inputs: mode, group, host1, host2, +20 more. Returns: object

tm_file_diff_compareDiff CompareC
Read-onlyIdempotent

Diff compare (tm_files). Advanced file operations on remote hosts.

Inputs: mode, group, host1, host2, +20 more. Returns: object

tm_file_recursive_opsRecursive OpsC

Recursive ops (tm_files). Advanced file operations on remote hosts.

Inputs: mode, group, host1, host2, +20 more. Returns: object

tm_file_watchWatchC

Watch (tm_files). Advanced file operations on remote hosts.

Inputs: mode, group, host1, host2, +20 more. Returns: object

tm_inventory_configure_key_authConfigure Key AuthC

Configure key auth (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_inventory_copy_ssh_configCopy Ssh ConfigC

Copy ssh config (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_inventory_mesh_bootstrapMesh BootstrapC

Mesh bootstrap (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_inventory_receive_fileReceive FileC

Receive file (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_inventory_rotate_keyRotate KeyC
DestructiveIdempotent

Rotate key (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_inventory_run_commandRun CommandC

Run command (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_inventory_send_fileSend FileC

Send file (tm_inventory). Bulk inventory operations against YAML host groups.

Inputs: cfg, cmd, key, host, +12 more. Returns: object

tm_operation_cancelCancelC
DestructiveIdempotent

Cancel (tm_operations). Operation lifecycle and session management.

Inputs: confirm, details, total_steps, operation_id, +1 more. Returns: object

tm_operation_get_metricsGet MetricsC
Read-onlyIdempotent

Get metrics (tm_operations). Operation lifecycle and session management.

Inputs: confirm, details, total_steps, operation_id, +1 more. Returns: object

tm_operation_get_progressGet ProgressC
Read-onlyIdempotent

Get progress (tm_operations). Operation lifecycle and session management.

Inputs: confirm, details, total_steps, operation_id, +1 more. Returns: object

tm_operation_list_sessionsList SessionsC
Read-onlyIdempotent

List sessions (tm_operations). Operation lifecycle and session management.

Inputs: confirm, details, total_steps, operation_id, +1 more. Returns: object

tm_operation_startStartC

Start (tm_operations). Operation lifecycle and session management.

Inputs: confirm, details, total_steps, operation_id, +1 more. Returns: object

tm_remote_check_sshCheck SshC
Read-onlyIdempotent

Check ssh (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_copy_ssh_configCopy Ssh ConfigC

Copy ssh config (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_receive_fileReceive FileC

Receive file (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_remove_host_keyRemove Host KeyC
DestructiveIdempotent

Remove host key (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_rotate_keyRotate KeyC
DestructiveIdempotent

Rotate key (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_run_commandRun CommandC

Run command (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_send_fileSend FileC

Send file (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_setup_passwordlessSetup PasswordlessC

Setup passwordless (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_remote_test_key_authTest Key AuthC
Read-onlyIdempotent

Test key auth (tm_remote). Single-host SSH operations with shared connection params.

Inputs: cfg, cmd, key, host, +15 more. Returns: object

tm_security_access_control_auditAccess Control AuditC
Read-onlyIdempotent

Access control audit (tm_security). Security scanning and compliance.

Inputs: remote_host (required), scope, standard, username, +3 more. Returns: object

tm_security_compliance_checkCompliance CheckC
Read-onlyIdempotent

Compliance check (tm_security). Security scanning and compliance.

Inputs: remote_host (required), scope, standard, username, +3 more. Returns: object

tm_security_security_auditSecurity AuditC
Read-onlyIdempotent

Security audit (tm_security). Security scanning and compliance.

Inputs: remote_host (required), scope, standard, username, +3 more. Returns: object

tm_security_vulnerability_scanVulnerability ScanC
Read-onlyIdempotent

Vulnerability scan (tm_security). Security scanning and compliance.

Inputs: remote_host (required), scope, standard, username, +3 more. Returns: object

tm_system_analyze_logsAnalyze LogsC
Read-onlyIdempotent

Analyze logs (tm_system). Remote system intelligence via SSH.

Inputs: remote_host (required), patterns, username, log_paths, +2 more. Returns: object

tm_system_discover_servicesDiscover ServicesC
Read-onlyIdempotent

Discover services (tm_system). Remote system intelligence via SSH.

Inputs: remote_host (required), patterns, username, log_paths, +2 more. Returns: object

tm_system_get_infoGet InfoC
Read-onlyIdempotent

Get info (tm_system). Remote system intelligence via SSH.

Inputs: remote_host (required), patterns, username, log_paths, +2 more. Returns: object

tm_system_network_topologyNetwork TopologyC

Network topology (tm_system). Remote system intelligence via SSH.

Inputs: remote_host (required), patterns, username, log_paths, +2 more. Returns: object

tunnel_ingest_hostsIngest Hosts to Knowledge GraphB
Read-onlyIdempotent

List the managed SSH inventory and push it into the medulla KG.

Maps each alias → a typed :Host node (+ :HostGroup / :SshKey and their :inGroup / :usesKey links). Best-effort: no-ops cleanly when no KG engine is reachable.

Inputs: group. Returns: object

tunnel_manager_add_hostAdd hostD

Invoke the add_host operation.

Inputs: user (required), alias (required), hostname (required), port, +6 more.

tunnel_manager_get_hostGet hostA
Read-onlyIdempotent

Get a host config by alias, denying an alias the caller isn't entitled to.

Returns None when the alias is simply unknown (unchanged, callers fall back to raw connection params), but raises PermissionError when the alias exists and the caller's identity is not entitled to it.

Inputs: alias (required).

tunnel_manager_list_hostsList hostsA
Read-onlyIdempotent

List the host aliases the CALLER is entitled to, secrets redacted.

Scoped to the caller's Okta/Keycloak identity (CONCEPT:AU-OS.identity.identity-scoped-resource-autoload); an unauthenticated/local caller (SYSTEM_ACTOR) sees all — unchanged from today. Each entry excludes password/password_ref in favor of a password_configured boolean so listing hosts never leaks secrets.

Inputs: no named parameters.

tunnel_manager_load_inventoryLoad inventoryC

Invoke the load_inventory operation.

Inputs: no named parameters.

tunnel_manager_remove_hostRemove hostD
Destructive

Invoke the remove_host operation.

Inputs: alias (required), confirm.

tunnel_manager_save_inventorySave inventoryC

Invoke the save_inventory operation.

Inputs: no named parameters.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.3/5.0

    Scored across 41 tools

    Disambiguation3/5

    The remote vs. inventory families mirror each other almost one-for-one (run_command, send_file, receive_file, copy_ssh_config, rotate_key), so an agent must read the description to know whether it wants single-host or bulk. Host management is also split across tunnel_manager_add_host/get_host/list_hosts/remove_host, tunnel_manager_load_inventory/save_inventory, and tunnel_ingest_hosts, which blur into each other. The namespace prefixes and terse descriptions help somewhat, but boundaries remain fuzzy.

    Naming Consistency3/5

    Most tools follow tm_<domain>_<verb>_<noun> (tm_remote_run_command, tm_file_content_search), which is readable and consistent. However, host CRUD uses a completely different tunnel_manager_* prefix, there is an orphan tunnel_ingest_hosts, and the descriptions for the tunnel_manager_* tools are generic 'Invoke the X operation' stubs. Two parallel naming schemes for overlapping concerns drag this down.

    Tool Count2/5

    41 tools is well past the point where a set stays scannable, and much of the bulk comes from duplicated single-host/bulk-inventory pairs. The domain is broad (SSH, inventory, files, security, system intel) but several tools feel like namespace filler rather than distinct capabilities.

    Completeness3/5

    Coverage is broad — connection checks, key rotation, file transfer, inventory sync, operation lifecycle, security auditing, and system discovery are all present. But there are notable gaps: no update/edit_host despite add/get/list/remove, no session close or per-operation result retrieval beyond progress/metrics, and no key or credential management surface. Agents would hit dead ends on common edit-style workflows.

    Maintenance

    ActivityNo data
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers