For the complete documentation index, see llms.txt. This page is also available as Markdown.

MCP Server (august-mcp)

Read-only Model Context Protocol server exposing August Digital data as tools, resources, and prompts for AI agents.

Quickstart (Claude Code)

claude mcp add august -- npx -y @augustdigital/mcp

Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "august": { "command": "npx", "args": ["-y", "@augustdigital/mcp"] }
  }
}

Then ask the agent to start from discovery: vault_list / vault_search resolve vault addresses, after which the per-vault tools (vault_summary, vault_apy, vault_pending_redemptions, vault_pnl_history, …) apply.

Surface

  • 21 read-only tools β€” vault metadata/APY/TVL/positions/loans/redemptions, discovery, points leaderboard, unrealized-PnL series, RPC diagnostics.

  • Resources β€” august://chains, august://errors, august://vaults/{chainId}.

  • Prompts β€” analyze-vault-health, compare-vaults, explain-user-position.

Every tool returns the same JSON envelope as august … --json (schemaVersion: 1, typed error.code + remediation on failure).

Shared HTTP instance

Connect with Authorization: Bearer <team-token>. The surface is identical to stdio; no keystore is read in HTTP mode (AUGUST_API_KEY via env when authenticated tools are needed).

Config

Shares ~/.augustdigital/ with the CLI (AUGUST_CONFIG_DIR to override). RPCs come from AUGUST_RPC_<chainId> env vars or the config file; set AUGUST_PASSPHRASE to auto-unlock the keystore on startup.

Last updated