Aurea Docs
API Reference

REST Endpoints

Non-GraphQL HTTP endpoints exposed by apps/api — health check and MCP transport.

Base URL

http://localhost:4000

Endpoints

GET /health

Liveness probe — returns 200 OK with a plain-text body when the server is up.

curl http://localhost:4000/health
# → OK

Used by Docker health checks and load-balancer probes in production.

POST /mcp

The Model Context Protocol endpoint. Accepts and responds with MCP-formatted JSON over the Streamable HTTP transport.

This endpoint is intended for MCP clients (AI agents), not for direct human consumption. See MCP Server for tool documentation and client connection instructions.

# Example: initialise an MCP session (the SDK handles this automatically)
curl -X POST http://localhost:4000/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"curl-test","version":"0.0.1"}}}'

In practice you will not call /mcp with curl. Use an MCP-compatible client such as Claude Desktop, the MCP Inspector, or any SDK-based agent.

On this page