Skip to main content
Glama

get_platform_summary

Read-only

Get a one-call account snapshot: quota with end-of-month projection, request health (pending/completed/expired counts + success rate), per-channel completion rates, HITL counts, and active API key count. The same data the dashboard home renders. The hitl_channels sub-object requires the hitl:read scope.

ACCESS: needs a Proof account. Authenticate this client (Claude Code: /mcp → Authenticate), then call this tool again. start_login does NOT open this tool.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_platform_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
profile_idNoScope the metrics and key counts to one sub-account (24 hex characters); the quota stays account-wide
environmentNoScope request/channel/HITL metrics to test or production data (default: production)

Output Schema

NameRequiredDescriptionDefault
as_ofNoWhen the snapshot was computed (ISO 8601)
quotaNo
next_actionNoMost-pressing account action; null when healthy
top_channelsNo
hitl_channelsNoPresent only with hitl:read scope (JWT always)
request_healthNo
active_api_keysNo
cache_age_secondsNoAlways 0 — computed live
channels_with_zero_completionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / profile_id
      Added value: +{
      +  "description": "Scope the metrics and key counts to one sub-account (24 hex characters); the quota stays account-wide",
      +  "pattern": "^[0-9a-fA-F]{24}$",
      +  "type": "string"
      +}
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "active_api_keys": {},
      +    "as_of": {
      +      "description": "When the snapshot was computed (ISO 8601)"
      +    },
      +    "cache_age_seconds": {
      +      "description": "Always 0 — computed live"
      +    },
      +    "channels_with_zero_completions": {},
      +    "hitl_channels": {
      +      "description": "Present only with hitl:read scope (JWT always)"
      +    },
      +    "next_action": {
      +      "description": "Most-pressing account action; null when healthy"
      +    },
      +    "quota": {},
      +    "request_health": {},
      +    "top_channels": {}
      +  },
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

readOnlyHint already covers the safety profile, and the description adds genuinely useful context beyond it: the hitl_channels sub-object silently degrades without the hitl:read scope, and the tool will not unlock via start_login so the client must be authenticated through /mcp first. It does not mention payload size, rate limits, or freshness of the aggregates, which keeps it below 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first sentence front-loads the payload contents and the second anchors it to the dashboard; the access block is short and actionable. Minor slack: the authentication instruction is repeated in emphatic form ('then call this tool again' / 'start_login does NOT open this tool'), which costs a few words but does prevent a real failure mode.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description only needs to explain scope, prerequisites and caveats, and it does: aggregate contents, per-sub-object scope requirement, account/auth prerequisite, and the account-wide quota exception. Complete enough to call correctly; only the absence of freshness/pagination expectations leaves a small gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so both profile_id and environment (including the 'quota stays account-wide' caveat and the production default) are already fully documented in structured fields. The description adds no parameter-level meaning beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb and a clearly bounded resource ('one-call account snapshot') and then enumerates exactly what the snapshot contains: quota + projection, request health, channel completion rates, HITL counts, API key count. The enumeration itself distinguishes it from narrow siblings like get_usage, get_balance and get_api_key_usage, and the 'same data the dashboard home renders' anchor makes the aggregate scope unmistakable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

With 'one-call snapshot' and the dashboard-home analogy, an agent can infer this is the preferred starting point over stitching together get_usage/get_balance/get_api_key_usage. The access paragraph gives concrete when-to-use conditions (must have a Proof account, must authenticate this client, call again afterwards). It still never explicitly names an alternative tool or when NOT to use it, so it stops short of 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.