Agent Quickstart (MCP)

This quickstart shows the fastest external path to validate VaultCrux with minimal setup.

Supported modes

1. Hosted (preferred)
2. Local evaluation (optional)

Required environment variables

• VAULTCRUX_API_URL
• VAULTCRUX_API_KEY
• VAULTCRUX_TENANT_ID

Optional for local mode:

• VAULTCRUX_DIR

1) Validate service health

curl -fsS "$VAULTCRUX_API_URL/healthz"
curl -fsS "$VAULTCRUX_API_URL/readyz"

2) Configure MCP client

Use MCP Config Snippets and set:

• API base URL
• tenant ID
• API key

Canonical contract source:

• OpenAPI JSON

3) Run one tool call

Example remote HTTP call for get_credit_balance:

curl -sS "$VAULTCRUX_API_URL/rpc" \
  -H 'content-type: application/json' \
  -H "x-tenant-id: $VAULTCRUX_TENANT_ID" \
  -H "x-api-key: $VAULTCRUX_API_KEY" \
  -d '{"jsonrpc":"2.0","id":"1","method":"get_credit_balance","params":{"agent_id":"agent-1"}}'

Local evaluation mode (optional)

If you run VaultCrux locally, set:

• VAULTCRUX_API_URL=http://localhost:14333
• VAULTCRUX_DIR=<path-to-vaultcrux>

Then reuse the same health checks and MCP call above.