Endpoints
| Endpoint | Methods | Purpose |
|---|---|---|
/mcp | GET, POST, DELETE | MCP Streamable HTTP. Handles tools/list, tools/call, and session lifecycle. |
/heartbeat | GET | Returns {"success": true} when the server is accepting connections. |
tools/list
Returns exactly two tools:
search: discovers relevant tools using ranked metadata matching (name, description, statement, and input metadata).execute: executes a selected tool by name with a structured input payload.
Search result limit
search does not accept a caller-provided limit. Result count is controlled by root config:
.hyperterse
10.
tools/call
Typical flow:
- Call
searchwith a natural-language query. - Pick a returned tool name.
- Call
executewithtool+inputs.
search request
search successful response
namerelevance_score(integer1..100, higher = more relevant)descriptionstatementinputs
execute request
execute successful response
content array always contains one text entry with JSON-encoded tool results.
Error response:
Heartbeat
200 OK when the HTTP server is accepting connections, regardless of connector health.
CORS
The runtime applies CORS headers to all responses:- Origins:
*(all) - Methods:
GET,POST,DELETE,OPTIONS - Headers:
Content-Type,Authorization,X-API-Key,Mcp-Session-Id
OPTIONS) requests are handled automatically. For production deployments behind a reverse proxy, configure CORS at the proxy layer and restrict the built-in policy to your domain.
HTTP headers in the execution context
HTTP request headers fromtools/call requests are forwarded into the execution pipeline so auth plugins can evaluate authentication data (X-API-Key, Authorization, and custom headers) when making access decisions.
Session management
The MCP Streamable HTTP transport supports session-based interaction via theMcp-Session-Id header. DELETE /mcp terminates a session.
For stateless tool invocation — the common case — sessions are not required. Each POST /mcp with a tools/call method is independently executed.