Directories
¶
| Path | Synopsis |
|---|---|
|
Package audit builds and writes the Spec 107 audit trail: one JSON line per pre-dispatch authorization decision (authz), one per completed tool dispatch (tool_call), and one per terminal login/logout attempt (auth_event).
|
Package audit builds and writes the Spec 107 audit trail: one JSON line per pre-dispatch authorization decision (authz), one per completed tool dispatch (tool_call), and one per terminal login/logout attempt (auth_event). |
|
Package auth provides agent token authentication for MCPProxy.
|
Package auth provides agent token authentication for MCPProxy. |
|
Package branding holds the canonical, user-facing project identifiers and URLs (homepage, repo, docs, issues) so every surface that points a user back to the project — CLI --version/--help, the MCP serverInfo instructions, docs links in errors — uses one source of truth.
|
Package branding holds the canonical, user-facing project identifiers and URLs (homepage, repo, docs, issues) so every surface that points a user back to the project — CLI --version/--help, the MCP serverInfo instructions, docs links in errors — uses one source of truth. |
|
Package callerr classifies the outcome of one upstream tool call into the call-error taxonomy of Spec 113-c: an error_class (what failed), a fault_domain (whose fault it is) and, when known, the upstream HTTP status.
|
Package callerr classifies the outcome of one upstream tool call into the call-error taxonomy of Spec 113-c: an error_class (what failed), a fault_domain (whose fault it is) and, when known, the upstream HTTP status. |
|
cli
|
|
|
output
Package output provides unified output formatting for CLI commands.
|
Package output provides unified output formatting for CLI commands. |
|
Package clientidentity derives the safe, stable identity used for untrusted MCP clientInfo names across persisted presence and session rows.
|
Package clientidentity derives the safe, stable identity used for untrusted MCP clientInfo names across persisted presence and session rows. |
|
Package codescripts resolves and lists server-side stored scripts for the code_execution tool (Spec 097).
|
Package codescripts resolves and lists server-side stored scripts for the code_execution tool (Spec 097). |
|
Package commitview holds the value types that describe one committed view of a server (Spec 116).
|
Package commitview holds the value types that describe one committed view of a server (Spec 116). |
|
Package config provides configuration types and merge utilities for MCPProxy.
|
Package config provides configuration types and merge utilities for MCPProxy. |
|
Package configimport provides functionality to import MCP server configurations from external tools like Claude Desktop, Claude Code, Cursor IDE, Codex CLI, and Gemini CLI.
|
Package configimport provides functionality to import MCP server configurations from external tools like Claude Desktop, Claude Code, Cursor IDE, Codex CLI, and Gemini CLI. |
|
Package connect provides functionality to register MCPProxy as an MCP server in various client configuration files (Claude Code, Cursor, VS Code, Windsurf, Codex, Gemini, ZCode).
|
Package connect provides functionality to register MCPProxy as an MCP server in various client configuration files (Claude Code, Cursor, VS Code, Windsurf, Codex, Gemini, ZCode). |
|
Package contracts defines typed data transfer objects for API communication
|
Package contracts defines typed data transfer objects for API communication |
|
Package diagnostics implements the stable error-code catalog used by mcpproxy to surface human-readable, fixable failure states to the user.
|
Package diagnostics implements the stable error-code catalog used by mcpproxy to surface human-readable, fixable failure states to the user. |
|
hints
Package hints builds diagnostics.ClassifierHints from configuration.
|
Package hints builds diagnostics.ClassifierHints from configuration. |
|
Package dockernaming centralises the rule for turning an MCPProxy server name into the sanitized token used inside a Docker container name (mcpproxy-<sanitized>-<suffix>).
|
Package dockernaming centralises the rule for turning an MCPProxy server name into the sanitized token used inside a Docker container name (mcpproxy-<sanitized>-<suffix>). |
|
Package gatereport defines the release-qa-gate report schema (Spec 081 FR-004/FR-010) and the merger that combines per-check JSON fragments into the single gate-report.json verdict artifact plus a human-readable summary.
|
Package gatereport defines the release-qa-gate report schema (Spec 081 FR-004/FR-010) and the merger that combines per-check JSON fragments into the single gate-report.json verdict artifact plus a human-readable summary. |
|
Package headerfwd implements Spec 112 client header forwarding: capturing an allowlisted subset of the inbound MCP client HTTP headers into an immutable, value-redacting Snapshot, filtering it per upstream server, and exposing the result to the streamable-HTTP transport header func.
|
Package headerfwd implements Spec 112 client header forwarding: capturing an allowlisted subset of the inbound MCP client HTTP headers into an immutable, value-redacting Snapshot, filtering it per upstream server, and exposing the result to the streamable-HTTP transport header func. |
|
Package health provides unified health status calculation for upstream MCP servers.
|
Package health provides unified health status calculation for upstream MCP servers. |
|
Package httpapi — diagnostics fix endpoint (spec 044).
|
Package httpapi — diagnostics fix endpoint (spec 044). |
|
Package httpx holds HTTP primitives shared by the MCP surface (internal/server) and the REST/SSE surface (internal/httpapi).
|
Package httpx holds HTTP primitives shared by the MCP surface (internal/server) and the REST/SSE surface (internal/httpapi). |
|
Package launch exposes the core process's durable launch provenance: which component started this mcpproxy core (Spec 092 FR-001a).
|
Package launch exposes the core process's durable launch provenance: which component started this mcpproxy core (Spec 092 FR-001a). |
|
Package management provides unified server lifecycle and diagnostic operations.
|
Package management provides unified server lifecycle and diagnostic operations. |
|
Package oauth provides OAuth 2.1 authentication support for MCP servers.
|
Package oauth provides OAuth 2.1 authentication support for MCP servers. |
|
Package observability provides health checks, metrics, and tracing capabilities
|
Package observability provides health checks, metrics, and tracing capabilities |
|
Package outputvalidation provides a pure, self-contained validator that checks a tool's structured output against its declared JSON Schema (draft 2020-12).
|
Package outputvalidation provides a pure, self-contained validator that checks a tool's structured output against its declared JSON Schema (draft 2020-12). |
|
Package preflight is the shared eligibility evaluator behind the required-tools preflight (Spec 098): given a caller-supplied tool ID and a caller context, it answers `ready` or exactly one failure reason from a closed 15-code enum, by a fixed precedence chain.
|
Package preflight is the shared eligibility evaluator behind the required-tools preflight (Spec 098): given a caller-supplied tool ID and a caller context, it answers `ready` or exactly one failure reason from a closed 15-code enum, by a fixed precedence chain. |
|
Package profile carries request-scoped in-proxy profile filtering (Spec 057).
|
Package profile carries request-scoped in-proxy profile filtering (Spec 057). |
|
Package qahooks holds live-QA park points (Spec 116 PR3, quickstart L3).
|
Package qahooks holds live-QA park points (Spec 116 PR3, quickstart L3). |
|
Package qapilot is the independent reference model for MCPProxy's quarantine and approval policy (the quarantine/approval testing pilot).
|
Package qapilot is the independent reference model for MCPProxy's quarantine and approval policy (the quarantine/approval testing pilot). |
|
Catalog (Spec 109 FR-060-067, data-model §9): a source-agnostic, ranked view over every enabled registry ("catalog source"), fanned out in parallel and merged into one ordered list.
|
Catalog (Spec 109 FR-060-067, data-model §9): a source-agnostic, ranked view over every enabled registry ("catalog source"), fanned out in parallel and merged into one ordered list. |
|
Package sandbox is a spike (MCP-3232) proving an *unprivileged*, non-Docker confinement primitive for stdio MCP servers on hosts where Docker is unavailable or broken — notably Ubuntu 24.04 with snap-installed Docker under AppArmor, where the deb's systemd hardening fights snap-confine (see internal repo issue #457 / cmd/mcpproxy/doctor_env_snapdocker.go).
|
Package sandbox is a spike (MCP-3232) proving an *unprivileged*, non-Docker confinement primitive for stdio MCP servers on hosts where Docker is unavailable or broken — notably Ubuntu 24.04 with snap-installed Docker under AppArmor, where the deb's systemd hardening fights snap-confine (see internal repo issue #457 / cmd/mcpproxy/doctor_env_snapdocker.go). |
|
Package secretlike implements the one shared "does this field name look like a credential?" rule (Spec 109 research D13), used to default the Value/Secret toggle to Secret in Paste, Manual and Catalog-with-inputs surfaces (FR-065), and to compute CatalogResult.RequiredInputs[].secret_like when a registry omits or falsifies its own isSecret flag (FR-061).
|
Package secretlike implements the one shared "does this field name look like a credential?" rule (Spec 109 research D13), used to default the Value/Secret toggle to Secret in Paste, Manual and Catalog-with-inputs surfaces (FR-065), and to compute CatalogResult.RequiredInputs[].secret_like when a registry omits or falsifies its own isSecret flag (FR-061). |
|
Package security provides sensitive data detection for MCP tool calls.
|
Package security provides sensitive data detection for MCP tool calls. |
|
bundlesig
Package bundlesig implements the detached-signature sidecar format and the Ed25519 verification rules of Spec 101 (contracts/sidecar-format.md).
|
Package bundlesig implements the detached-signature sidecar format and the Ed25519 verification rules of Spec 101 (contracts/sidecar-format.md). |
|
detect
Package detect implements the deterministic, offline MCP tool-scanner v2 (Spec 076).
|
Package detect implements the deterministic, offline MCP tool-scanner v2 (Spec 076). |
|
patterns
Package patterns provides sensitive data detection patterns for various credential types.
|
Package patterns provides sensitive data detection patterns for various credential types. |
|
Spec 085 US3 — pre-dispatch argument validation (FR-013) and the self-healing invalid_params error renderer shared by Path A (pre-dispatch) and Path B (best-effort upstream classification).
|
Spec 085 US3 — pre-dispatch argument validation (FR-013) and the self-healing invalid_params error renderer shared by Path A (pre-dispatch) and Path B (best-effort upstream classification). |
|
Package shellwords implements a small, dependency-free, quote-aware tokenizer for a single command line, shared by the Paste-source command detector (internal/configimport, FR-064) and the catalog install-command splitter (internal/registries, data-model §9 CatalogInstall).
|
Package shellwords implements a small, dependency-free, quote-aware tokenizer for a single command line, shared by the Paste-source command detector (internal/configimport, FR-064) and the catalog install-command splitter (internal/registries, data-model §9 CatalogInstall). |
|
Package shellwrap provides platform-level helpers for wrapping commands in the user's login shell and for resolving tool binaries (e.g.
|
Package shellwrap provides platform-level helpers for wrapping commands in the user's login shell and for resolving tool binaries (e.g. |
|
purgetest
Package purgetest seeds and inspects the Spec 116 removal purge set (data-model.md §PurgeSet) for tests.
|
Package purgetest seeds and inspects the Spec 116 removal purge set (data-model.md §PurgeSet) for tests. |
|
Package stringutil provides common string utility functions.
|
Package stringutil provides common string utility functions. |
|
Package toolannotations is the single source of truth for MCP tool-annotation filter semantics (Spec 035 F4, Spec 094 FR-004).
|
Package toolannotations is the single source of truth for MCP tool-annotation filter semantics (Spec 035 F4, Spec 094 FR-004). |
|
Package toolreview holds the value types shared by the tool-review layers (storage, runtime and the security scanner) for Spec 117.
|
Package toolreview holds the value types shared by the tool-review layers (storage, runtime and the security scanner) for Spec 117. |
|
Package toolsig compiles deterministic compact tool signatures (Spec 085, Compact Router) from a tool's JSON Schema (ToolMetadata.ParamsJSON) and its description.
|
Package toolsig compiles deterministic compact tool signatures (Spec 085, Compact Router) from a tool's JSON Schema (ToolMetadata.ParamsJSON) and its description. |
|
Package toonenc implements the adaptive TOON encoder for tool-call result text blocks (spec 084).
|
Package toonenc implements the adaptive TOON encoder for tool-call result text blocks (spec 084). |
|
Package updatecheck provides centralized version checking against GitHub releases.
|
Package updatecheck provides centralized version checking against GitHub releases. |
|
callstats
Package callstats keeps a rolling, in-memory record of per-server tool-call outcomes so the health calculator can report a server whose calls mostly fail as degraded even though its connection looks fine (Spec 113-d).
|
Package callstats keeps a rolling, in-memory record of per-server tool-call outcomes so the health calculator can report a server whose calls mostly fail as degraded even though its connection looks fine (Spec 113-d). |
|
dialgate
Package dialgate is the per-instance retirement barrier of Spec 116 PR4 (#1564, FR-022..FR-026).
|
Package dialgate is the per-instance retirement barrier of Spec 116 PR4 (#1564, FR-022..FR-026). |
|
launcher
Package launcher manages locally-spawned upstream processes that expose their MCP endpoint over HTTP / SSE / streamable-HTTP transports.
|
Package launcher manages locally-spawned upstream processes that expose their MCP endpoint over HTTP / SSE / streamable-HTTP transports. |
|
limiter
Package limiter implements the bounded-concurrency admission control used by the upstream tool-call choke point (spec 093, GH #955).
|
Package limiter implements the bounded-concurrency admission control used by the upstream tool-call choke point (spec 093, GH #955). |
|
Package winjob provides Windows Job Object based process-tree cleanup.
|
Package winjob provides Windows Job Object based process-tree cleanup. |
Click to show internal directories.
Click to hide internal directories.