Skip to content

Components reference

URI schemes for every transport, sink, and processor that's a first-class Helix endpoint. Each scheme has its own page documenting:

  • URI shape (path tokens + query params)
  • Every parameter, its type, default, and whether it's Producer/Consumer/Both
  • Message body and header contracts
  • Examples (validated against helix validate)
  • Deep links: corresponding JSON Schema in helix/schemas/components/

All schemes

The audit (bin/audit-docs --category components) is the source of truth. The list below is regenerated by the docs build.

While the per-scheme pages are being written, the old single-file overview at _legacy-overview.md still applies. Both pass bin/audit-docs is the merge gate.

Category Schemes
Core messaging direct, seda, mock, timer, cron, log
HTTP / RPC http, https, http-server, grpc, ws, ws-server
Files / storage file, ftp, ftps, sftp, s3
Brokers kafka, nats, amqp, rabbitmq, mqtt, sqs, redis
Databases postgres, mongodb, elasticsearch, sql, memx, memvec
Vector stores milvus, pinecone, qdrant
Email / chat smtp, slack
LLM providers openai, anthropic, ollama, vertex, gemini, azure, bedrock, cohere, mistral, huggingface, replicate, fireworks, groq, together, xai, vllm, deepinfra, openai-server
Agentic / interop agent, tool, mcp, mcp-server, a2a, a2a-server, a2ui, agui
Domain edi, pdf, image, browser, chart, template, docker, governance, csv, xlsx
Geospatial geo, geocoder

Total: 71 schemes registered across 64 packages (some packages register more than one scheme).

Source

  • Package directory: pkg/component/<name>/
  • Discovery: bin/audit-docs --category components
  • Schemas: helix/schemas/components/<scheme>.json (where present)