Managing APIs
Adding a New API
From the Dashboard, click Add API (top right).
Fill in the API form:
Name
A descriptive name for this API (e.g., "Petstore API")
API Type
REST, GraphQL, SOAP, or gRPC
Base URL
The root URL for the API (e.g., https://api.example.com)
Provide the schema using one of three methods:
URL
Enter the URL where the schema is hosted (e.g., an OpenAPI spec URL, a GraphQL introspection endpoint, a WSDL URL, or a .proto file URL)
Paste
Copy/paste the schema content directly into the text area (JSON, YAML, XML, or proto content)
File Upload
Upload schema files from your local machine
Schema support by API type:
REST/OpenAPI
OpenAPI spec URL
JSON or YAML
.json or .yaml file
GraphQL
Introspection endpoint
Introspection JSON
Not supported
SOAP
WSDL URL
WSDL XML
.wsdl or .xml file
gRPC
Server reflection or .proto URL
Proto content
Multiple .proto files
Configure authentication for how MCP Bridge will call this API at runtime:
None
No authentication
Bearer
Token
Basic
Username, Password
API Key
Key name, Key value, Location (header or query)
OAuth2
Token URL, Client ID, Client Secret, Scopes, Grant Type (Client Credentials or ROPC), and optionally Username/Password for ROPC
Cognito SRP
Region, User Pool ID, Client ID, Client Secret (optional), Username, Password
(Optional) Configure reliability settings:
Health Check Endpoint — A path to ping for health status (e.g.,
/health)Rate Limiting — Enable and set requests per second and burst size
Retry Policy — Enable and set max retries, initial backoff, max backoff, and backoff multiplier
Click Test Connection to verify MCP Bridge can reach the API.
Click Save & Import to create the API and parse the schema into tools.
Editing an API
On the Dashboard, click the Edit button on any API card.
Modify the fields as needed.
To re-import the schema (e.g., after the API has changed), provide the schema again via URL, paste, or upload and save.
Deleting an API
On the Dashboard, click the Delete button on an API card.
Confirm the deletion in the dialog. This removes the API and all associated tools.
Filtering and Searching APIs
The Dashboard provides:
A search bar to filter by API name or base URL
Type filter buttons (REST, GraphQL, SOAP, gRPC) to show only APIs of a specific type
Last updated