Skip to main content
Glama

satledger timestamp receipt

Describe an agent

describe_agent

Current state: root id, state hash, event count, balance. Free. Authenticate with the workspace key in _meta[satledger/api-key].

Input Schema

NameRequiredDescriptionDefault
api_keyNoYour workspace key, if your client cannot set _meta[satledger/api-key]. Prefer _meta: arguments are logged by most clients.
agent_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and does contribute real behavioral context: it is a read of current state, it is free of charge, and it states the auth mechanism via _meta[satledger/api-key]. It does not state read-only/reversibility, error behavior for unknown agent ids, or rate limits, so the disclosure is partial.

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?

Two terse fragments, front-loaded with the return contents, then cost and auth. Nothing is wasted, though the sentence-fragment style leaves the subject/verb implicit.

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

Completeness3/5

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

With no output schema and no annotations, the description usefully compensates by enumerating the returned fields and noting the tool is free and authenticated. It still omits agent_id semantics and any failure/edge-case behavior, so it is adequate but not complete for a 2-parameter tool.

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 coverage is 50%: api_key is documented in the schema while agent_id is not. The description's auth sentence maps to api_key but largely repeats what the schema already says, and it adds nothing about agent_id's format or role. Baseline 3 is appropriate given partial schema coverage.

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

Purpose4/5

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

The description names the concrete contents of the agent state snapshot (root id, state hash, event count, balance), which together with the name describe_agent makes the operation clear: read the current state of one agent. It does not explicitly differentiate from siblings like list_agents or workspace_balance, but the returned-field list is specific enough to separate it from them.

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

Usage Guidelines2/5

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

'Free' implies a cost-based reason to prefer this over paid siblings (record_action, fund_agent), but there is no explicit when-to-use or when-not guidance and no named alternative. An agent must infer the use case entirely from the tool name.

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.

Resources