The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Alephant MCP listing page.
Model Context Protocol server for Alephant BYO-KEY: FinOps metrics, virtual keys, and workspace analytics from Cursor, Claude Desktop, or any MCP host.
| Mode | Environment | Tools |
|---|---|---|
| VK | ALEPHANT_VIRTUAL_KEY | Cockpit-scoped usage + 3 VK tools (8 tools total incl. shared) |
| Manager | ALEPHANT_PAT + ALEPHANT_WORKSPACE_ID | Workspace-wide management (27 tools total incl. shared) |
PAT takes precedence when ALEPHANT_PAT is non-empty. If neither VK nor PAT is set, the process exits with an error (no mock data).
Required (both modes): ALEPHANT_API_BASE_URL
Optional: ALEPHANT_RATE_LIMIT_RPM (default 60, use 0 to disable client-side throttling)
npx troubleshootingFrom this repo’s root (alephant-mcp/): do not use npx -y @alephantai/mcp to “smoke test” the published package. npm treats the current directory as the local @alephantai/mcp project and does not link the root package’s bin into node_modules/.bin, so Windows then fails with 'alephant-mcp' is not recognized (or the Chinese CMD equivalent).
Use one of these instead while developing in the clone:
To verify npx the same way end users do, run it from any other directory (e.g. the parent folder):
From a normal project folder (after npm install @alephantai/mcp), you can also run:
If npx -y @alephantai/mcp still fails outside the clone, try:
Published packages 0.0.2+ include the bin/alephant-mcp.js shim for reliable npm bin resolution when installed from the registry.
Alephant MCP is a local stdio server. Use one server entry per credential scope. For multiple workspaces, create multiple entries with different names and environment variables.
Virtual Key (read-only / scoped cockpit):
Personal Access Token (manager):
Use separate mcpServers entries per workspace when you have multiple PATs.
Add a stdio MCP server in ~/.codex/config.toml:
For Manager mode, replace the VK env with:
Verify with:
Add a local MCP server under mcp in your OpenCode config, for example opencode.json:
For Manager mode, use ALEPHANT_PAT and ALEPHANT_WORKSPACE_ID in environment instead of ALEPHANT_VIRTUAL_KEY.
Use the CLI to add Alephant as a local stdio server:
For a shared project config, create .mcp.json in the project root:
For Manager mode, replace the VK env with ALEPHANT_PAT and ALEPHANT_WORKSPACE_ID.
scope + usage-summary (billing cycle).GET /api/v1/analytics/overview.Shared (both modes): check_alephant_connection, get_usage_summary, get_daily_costs, get_cost_by_model, list_available_models
VK only: get_my_scope, get_my_budget, get_my_recent_requests
Manager only: get_workspace_overview, get_workspace_budget_status, list_virtual_keys, create_virtual_key, update_key_budget, revoke_virtual_key, list_agents, get_agent_analytics, list_members, get_member_analytics, list_departments, get_department_analytics, get_subscription_info, set_budget_policy, get_live_24h, get_usage_timeseries, get_sparklines, diagnose_cost_anomaly, get_executive_dashboard, drill_down_spend, find_idle_resources, compare_entity_periods
get_request_logs is not included (JWT-only backend route).
/alephant-… 快捷模板、工具对照表docs/marketplace-submission.md for official MCP Registry, Smithery, and Glama submission notes.Published as @alephantai/mcp (alephant-mcp binary).