For the complete documentation index, see llms.txt.
Skip to main content

reShapr features

Available with limits means that the capability requires configuration or has a narrower scope than its general name might suggest. Links point to the owning reference when implementation details change frequently.

API translation and Context Control​

CapabilityAvailabilityScopeReference
OpenAPI importAvailableOpenAPI 3.x documents are converted into REST-backed MCP Tools. Swagger/OpenAPI 2.x import is not provided.Services and Artifacts
GraphQL importAvailableQueries and mutations become Tools. Service name and version must be supplied when the schema does not provide them.Services and Artifacts
Protobuf/gRPC importAvailableProtobuf 3 services become Tools backed by gRPC. Imports are resolves before compilation.Services and Artifacts
Import by file or URLAvailableBoth paths support service name and version overrides. URL imports can resolve external dependencies that are unavailable to a local file import.CLI commands
Operation selectionAvailableA Configuration Plan can include or exclude API operations; inclusion takes precedence.Configuration Plan and Exposition
reShapr artifactsAvailablePrompts, Resources, Custom Tools, and Tools Output Filters can be attached to a Service and selected per Configuration Plan.Configuration Plan and Exposition
Declarative Custom ToolsAvailableRename, condense, or reshape existing operations without creating a new backend.Custom Tools specification
Scripted Custom ToolsAvailable with limitsJavaScript orchestration can call allowed Tools with bounded execution time and depth. This extension is programmable rather than no-code.Custom Tools specification
Output filtering and TOONAvailableGateway-side rules can retain fields, apply JSON Patch, compact JSON, or encode JSON output as TOON before returning it to the MCP client.Tools Output Filtering

MCP protocol​

CapabilityAvailabilityScopeReference
Protocol versionsAvailable2024-11-05, 2025-03-26, 2025-06-18, 2025-11-25, and the public 2026-07-28 version are negotiated by the Gateway.MCP Support Matrix
Streamable HTTPAvailableExpositions provide MCP endpoints over HTTP; TLS termination depends on the deployment. WebSocket transport is not provided.Configuration Plan and Exposition
Session and stateless modesAvailableVersions before 2026-07-28 use a server-issued session ID. 2026-07-28 uses stateless requests and server/discover.MCP Compatibility
ToolsAvailabletools/list and tools/call dispatch to REST, GraphQL, gRPC, or Custom Tools selected by the Plan.Custom Tools specification
PromptsAvailableprompts/list and prompts/get serve Prompts artifacts selected by the Plan.Prompts specification
ResourcesAvailableStatic and templated Resources support list, template list, and read operations.Resources specification
URL elicitationAvailable with limitsBackend credentials can be requested through legacy session-bound errors or 2026-07-28 stateless elicitation bound to an authenticated user.Backend authentication and elicitation
Client cache hintsAvailable with limitsttlMs and cacheScope are returned only for the 2026-07-28 protocol shape.Configuration Plan and Exposition

Methods such as roots, sampling, and subscriptions are not exposed as server capabilities. The MCP Support Matrix distinguishes implemented, removed, and unimplemented methods.

Security and governance​

CapabilityAvailabilityScopeReference
MCP endpoint API keyAvailableThe proxy validates x-reshapr-key; keys can be renewed and propagated to connected proxies.API key guide
MCP endpoint OAuth 2.0AvailableThe proxy validates signed bearer JWTs against configured issuers, JWKS, Exposition scopes, and dynamic or static audiences, and publishes RFC 9728 metadata.OAuth 2.0 guide
Backend authenticationAvailable with limitsBasic, token/header, certificate, OAuth Client Credentials, and elicited OAuth credentials depend on the backend protocol and Secret configuration.Backend authentication and elicitation
Backend request header policyAvailable with limitsA Configuration Plan can allow, deny, or rename request headers sent to HTTP backends or converted to gRPC call metadata. Response rules are reserved and not enforced in 1.0.0.Configure backend request header policy
Database encryption and key rotationAvailable with limitsThe control plane uses identified AES-256-GCM keys and can re-encrypt stored sensitive values with the active key through an administrator command. Key rollout and invocation remain operator-managed.Upgrade and rotate runtime secrets
Local secret referencesAvailable with limitsHybrid proxies resolve ${env:VARIABLE} references locally on each backend call. env is the provided resolver.Backend authentication and elicitation
Audit eventsAvailable with limitsA proxy emits structured MCP-call and authentication-failure events when audit is enabled on the Configuration Plan.Audit MCP endpoint calls
Multi-tenancyAvailableControl-plane data is isolated by organization through application-level discriminator tenancy.Multi-tenancy and Administrative Governance
Organization quotasAvailable with limitsQuotas limit governance resources such as Expositions and Gateways. They are not request-rate limits.Assign and monitor quotas and governance model
Administrative identitiesAvailableUsers, organizations, memberships, service accounts, and Gateway API tokens are managed through dedicated control-plane surfaces.Manage organizations and memberships and governance model

Product interfaces​

CapabilityAvailabilityScopeReference
Public and administrative APIsAvailableOpenAPI contracts cover product resources, authentication, and administration.reShapr API contracts
CLIAvailableThe CLI covers login, import, Services, artifacts, Secrets, Plans, Expositions, Gateway Groups, tokens, quotas, administrative workflows, and generated shell completion.CLI reference and CI/CD automation
Web UIAvailableThe Web UI covers the main import-to-Exposition workflow and organization administration.Web UI
Live configuration propagationAvailableConfiguration events are streamed to connected proxies without requiring a proxy restart. This is not a general zero-downtime or rollback guarantee.Control Plane to Proxy Synchronization
Proxy observabilityAvailable with limitsThe proxy can export OpenTelemetry traces, metrics, and logs; audit events remain conditional. Equivalent coverage is not provided across every component.Observe the reShapr Proxy

Deployment and Kubernetes​

CapabilityAvailabilityScopeReference
Local runtimeAvailableThe CLI starts and stops a release Docker Compose stack with Docker or Podman and can include the Web UI.reShapr project
Kubernetes APIs and operatorAvailable with limitsSeven v1alpha1 CRDs manage Services, Plans, Expositions, Gateway Groups, Secret sources, Custom Tools, and Resources. Custom Tools and Resources do not currently clean up remote artifacts on deletion.Controller documentation
Sidecar injectionAvailable with limitsThe admission controller injects Gateway sidecars and creates discovery/MCP Services for supported Deployment-owned workloads. It is fail-open by default.Admission controller
Helm packagingAvailableFour OCI charts package the control plane, proxy, Web UI, and controllers.Helm charts
PostgreSQL topologyAvailable with limitsThe control-plane chart supports bundled or external PostgreSQL. The bundled development database is not a high-availability setup.Control-plane chart
Runtime scaling and availabilityAvailable with limitsProduction profiles configure replicas and PDBs for the control plane and Web UI; the proxy adds clustering and HPA. End-to-end availability still depends on PostgreSQL and the target infrastructure.Helm charts
Network and metrics integrationAvailable with limitsThe proxy chart provides optional NetworkPolicy and ServiceMonitor resources. Coverage is not uniform across all four charts.Proxy chart
Installation profiles and signaturesAvailableAll charts provide development and production values; published charts are signed with Cosign.Helm chart verification
UpgradesAvailable with limitsKubernetes rolling updates, startup database migrations, retained clustering secrets, retained CRDs, and administrator-triggered database key rotation support upgrades. Automated rollback and general credential rotation are not provided.Upgrade and rotate runtime secrets
Agent View