Skip to content

Concepts & glossary

A quick tour of the vocabulary used across these docs and the admin UI.

The core idea

The bridge keeps a registry of backends and proxies every call through one uniform guard pipeline, addressed by a stable client__tool identity — see Architecture → for the full request path. The glossary below covers the vocabulary that shows up across these docs and the admin UI.

Glossary

TermWhat it means
Client (backend)A registered backend — a REST API (tools discovered from OpenAPI), a GraphQL API (kind: "graphql", tools discovered from the introspected schema), or an MCP upstream (kind: "mcp").
ToolA single callable operation, namespaced as clientName__toolName.
Serving modeHow a client reaches backend tools: per-client shard (/mcp/:name) or curated bundle (/mcp-custom/:bundle). /mcp itself is the control plane, not a serving mode — see below.
System toolA sys_* tool over the gateway itself (management + data retrieval), served only at the /mcp control-plane root — never a backend tool.
BundleAn admin-curated, cross-client subset of tools (and/or composite macros) behind one endpoint — how you put several backends behind one MCP URL.
GuardA per-tool policy: rate limit, timeout, circuit-breaker override, allowed-key restriction.
GuardrailA per-tool content control: input deny-rules, secret detection, prompt-injection response scanning, field redaction.
Circuit breakerPer-client failure protection (closed → open → half_open) that fails fast while a backend is unhealthy.
Canary / failoverRoute some or all traffic to a validated secondary backend (weighted canary, or failover when the primary breaker opens).
ConsumerA tenant/team/product that groups API keys and carries a monthly quota.
MCP API keyThe credential a tool caller presents; can be scoped (to clients/tools), elevated (for sensitive tools), expiring, revocable. Stored hashed.
Admin user / roleWho administers the bridge, gated by RBAC: admin / operator / auditor / viewer.
TeamA multi-tenancy boundary that scopes clients so tenants see only their own.
RegistryThe live, in-memory view of clients + tools, hydrated from SQLite and health-monitored.
Audit logA tamper-evident, hash-chained record of every admin mutation; optionally streamed to a SIEM.
LeaderThe single instance (elected via a SQLite lease) that runs background loops — alerts, schedules — in a multi-instance deployment.
Composite toolA macro that runs several tool steps as one call, each step through the full guard stack.
search_toolsA synthetic meta-tool that lets a client search its own tool list.

How the pieces fit

  • Connect a backend → its tools enter the registry (Registering backends).
  • Curate what a client sees with serving modes and bundles.
  • Govern each tool with guards, guardrails and access control.
  • Operate with health checks, metrics, alerts, audit — and scale out when you need to.

See the Architecture → for the request path, or the API reference → for the endpoints.

Released under the MIT License · Built with Bun + Vue.