Skip to documentation
Browse documentation

Connect through the bounded MCP surface

Hyran Data exposes stateless Streamable HTTP MCP at POST https://api.data.hyran.co/mcp. MCP uses the same tenant credential, scopes, contracts, repositories, rate limit, regional boundary, audit trail, and forced RLS as REST.

Available tools

ToolPurpose
list_entity_typesReturn the allowlisted entity vocabulary
search_entitiesSearch bounded entity pages
get_entityRead one canonical entity
traverse_relationshipsRead bounded relationships for one entity
get_bom_yield_changesCompare completed BOM snapshots
create_exportCreate an asynchronous governed export

The server does not expose SQL, arbitrary tool registration, unrestricted graph traversal, direct database credentials, or caller-supplied tenant selection.

Install the first-party Codex plugin

Hyran Data's versioned Codex plugin configures the production MCP endpoint and provides bounded usage guidance. It contains no token or customer data. An authorized Hyran operator issues a dedicated, expiring API token with mcp:read plus only the required domain scopes. Store the secret in the approved secret manager and expose it to Codex as HYRAN_DATA_API_TOKEN.

Hyran team members can install the plugin from the Hyran repository marketplace:

codex plugin marketplace add /absolute/path/to/hyran-platform
codex plugin add hyran-data@hyran

Start a new Codex task after installation. Customer marketplace packages use the same signed-off plugin contract without granting access to Hyran's private application repository.

Initialize a session

curl --request POST https://api.data.hyran.co/mcp \
  --header "Authorization: Bearer $HYRAN_DATA_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json, text/event-stream" \
  --data '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "initialize",
    "params": {
      "protocolVersion": "2025-06-18",
      "capabilities": {},
      "clientInfo": { "name": "customer-integration", "version": "1.0.0" }
    }
  }'