@augustdigital/mcp

中文文档
0.9.16发布于 2026/10/28MITTypeScriptCommonJS近 30 天下载 2834

Local stdio MCP server exposing the August Digital SDK as Model Context Protocol tools.

原始使用文档
文档目录10 节
  1. Tools
  2. Install
  3. Claude Desktop
  4. Claude Code
  5. Auth
  6. Integrations
  7. Telemetry
  8. Programmatic use
  9. Transports
  10. Resources & prompts

@augustdigital/mcp

Local stdio Model Context Protocol server exposing the August Digital SDK's read surface as MCP tools, plus documentation, GitHub, and Jira helpers for triage. Shares its config under ~/.augustdigital/ with @augustdigital/cli, and returns the same JSON envelope — tool results are diff-clean against the matching august … --json output.

No chain writes: nothing here signs or broadcasts a transaction. The one tool that creates anything is jira_create_ticket, which opens a Jira issue when Jira credentials are configured (see Integrations).

Tools

70 tools in 19 groups.

GroupTools
Metawhoami, chain_list, rpc_test
Discoveryvault_list, vault_search
Vaultvault_get, vault_apy, vault_tvl, vault_positions, vault_loans, vault_allocations, vault_redemptions, vault_history, vault_summary
Useruser_points, user_positions, user_pnl
Datapoints_leaderboard, vault_pending_redemptions, vault_pnl_history, pnl_latest
Activityvault_activity, activity_ranking, user_activity, user_transfers
Readstotal_deposited, token_price, vault_withdrawals, vault_pnl, vault_annualized_apy, withdrawal_requests_status
Subaccountssubaccount_list, subaccount_summary, subaccount_health_factor, subaccount_loans, subaccount_cefi_positions, subaccount_otc_positions, subaccount_transactions, subaccount_loan_by_address, subaccount_debank
Riskdashboard_loans, risk_discount_factors, risk_collateral_excess, risk_collateral_simulate
Triagetx_revert_reason
Decodedecode_revert_data, simulate_call, read_token_state
OTCotc_positions_list, otc_margin_requirements
Curatorcurator_vault_subaccounts, curator_vault_whitelist
Governancetimelock_requests_list, vault_performance_fees, vault_oracle_classification
Opsops_health, ops_redemptions
LayerZerolayerzero_deposits, layerzero_redeems
Docsdocs_search, docs_fetch, docs_list
GitHubgithub_list_repos, github_get_file, github_search_code, github_list_prs, github_get_pr, github_list_issues
Jirajira_create_ticket, jira_list_projects

Activity answers flow questions — vault_activity returns a vault's deposit/withdrawal feed plus a computed summary (counts, volumes, net flow), and activity_ranking ranks vaults by activity over a window ("which vaults had the most deposits last week"). Most vault/user tools mirror an august … CLI command; subaccount_* and layerzero_* read the institutional and cross-chain surfaces respectively.

Triage / Decode work from an error rather than an address — tx_revert_reason traces a mined transaction hash; decode_revert_data decodes a raw revert blob or a whole ethers error string when no hash exists (estimateGas / eth_call failures); simulate_call replays a call to recover truncated revert data; read_token_state reads an ERC-20 holder's balance, allowance, and issuer compliance flags to separate user error from a freeze.

Docs / GitHub / Jira support the same triage loop: search and fetch the August and Upshift documentation, read source and pull requests from the August GitHub organizations, and file the result as a Jira issue.

Every tool result:

{
  "schemaVersion": 1,
  "command": "vault.apy",
  "ok": true,
  "data": { "address": "0x…", "chainId": 8453, "currentApy": 0.1234 },
  "meta": { "chainId": 8453, "durationMs": 312, "generatedAt": "2026-05-17T…" }
}

Install

npm install -g @augustdigital/mcp

Or invoke without installing:

npx -y @augustdigital/mcp

Claude Desktop

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "august": {
      "command": "npx",
      "args": ["-y", "@augustdigital/mcp"],
      "env": {
        "AUGUST_PASSPHRASE": "${env:AUGUST_PASSPHRASE}",
        "AUGUST_CONFIG_DIR": "${env:HOME}/.augustdigital"
      }
    }
  }
}

Claude Code

claude mcp add august npx -y @augustdigital/mcp

Auth

API key resolution (first hit wins):

  1. AUGUST_API_KEY
  2. Active session — created by august login or auto-unlocked from AUGUST_PASSPHRASE at server startup.

When neither is present — or the backend rejects the key — authenticated tools return code: "API_KEY_MISSING" with a remediation hint. Public read methods still work.

Integrations

The GitHub and Jira groups talk to external services and are inert until their credentials are present in the environment:

GroupEnvironmentWithout it
GitHubAUGUST_GITHUB_TOKEN — a token with read access to the August organizationsTools return an error envelope naming the variable
JiraJIRA_BASE_URL, JIRA_USER_EMAIL, JIRA_API_TOKEN, JIRA_PROJECT_KEY; plus an active August session for jira_create_ticketTools return an error envelope naming the variables

Telemetry

The server reuses the SDK's Sentry telemetry and follows the shared telemetry setting in ~/.augustdigital/config.json — off by default, on after august init (when you accept the prompt) or august config set telemetry true. When on, SDK errors and tool failures other than configuration problems are reported tagged sdk.surface: mcp and app.name: august-mcp, and every backend request carries x-august-app: august-mcp. AUGUST_SDK_DISABLE_ANALYTICS=1 forces it off regardless of config.

Programmatic use

import { buildServer, bootstrap } from '@augustdigital/mcp';

await bootstrap();
const server = buildServer();
// attach your own transport (e.g. an in-memory pair for testing)

Transports

Stdio is the default (shown in the quickstart). For a shared instance, run streamable HTTP:

AUGUST_MCP_TOKEN=<team-token> august-mcp --http --port 8787
  • Endpoint: POST/GET http://<host>:8787/mcp
  • Every request must send Authorization: Bearer <team-token>; anything else gets a 401.
  • The server binds 127.0.0.1 unless AUGUST_MCP_HOST says otherwise.
  • Stateless mode: no session affinity needed behind a load balancer.
  • The surface is identical to stdio (same tools, resources, prompts, and JSON envelopes). No keystore is read in HTTP mode — provide AUGUST_API_KEY via the environment if authenticated tools are needed.

Claude Code connection:

claude mcp add --transport http august http://<host>:8787/mcp \
  --header "Authorization: Bearer <team-token>"

Resources & prompts

  • Resources: august://chains, august://errors, august://vaults/{chainId} (use 0 for all chains).
  • Prompts: analyze-vault-health, compare-vaults, explain-user-position.

版本与发布记录

@augustdigital/mcp 共发布 55 个版本,首次发布于 2026/05/22;过去 12 个月发布了 55 个版本。

版本发布日期距今
0.9.16latest2026/10/2810 天前
0.9.152026/10/2711 天前
0.9.142026/10/2415 天前
0.9.132026/10/1523 天前
0.9.122026/10/1524 天前
0.9.112026/10/1425 天前

关于 @augustdigital/mcp 的常见问题

@augustdigital/mcp 是什么?

Local stdio MCP server exposing the August Digital SDK as Model Context Protocol tools.

如何安装 @augustdigital/mcp?

在项目目录运行 npm install @augustdigital/mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 august-mcp,可以用 npx august-mcp 直接运行。

@augustdigital/mcp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@augustdigital/mcp 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@augustdigital/mcp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.23.4 <23.0.0 || >=24.22.1 <25.0.0 || >=26.12.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@augustdigital/mcp 可以商用吗?

@augustdigital/mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@augustdigital/mcp 的下载量有多少?

根据 npm 官方下载统计,@augustdigital/mcp 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,834 次,日均约 94 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@augustdigital/mcp 还在维护吗?

最新版本 0.9.16 发布于 2026/10/28(10 天前);至今共发布 55 个版本,其中过去 12 个月发布了 55 个;首次发布于 2026/05/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。