Skip to main content
Glama

aa_schema

Read-onlyIdempotent

Returns a machine-readable contract for a chosen subject—report, investigation, or commands—so agents can parse and act on workspace outputs.

Instructions

Return a machine-readable contract: report, investigation or commands.

Input Schema

NameRequiredDescriptionDefault
subjectNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds no behavioral context of its own: it doesn't say what the contract contains, what happens when subject is omitted (it is optional), or any rate/output characteristics.

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?

A single front-loaded sentence with no filler. It is tight, though the brevity borders on under-specification rather than true economy.

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

Completeness2/5

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

No output schema exists, so the description should hint at the returned contract's shape, yet it does not. Combined with an optional enumerated parameter whose default is unexplained, the definition leaves an agent short of what it needs to invoke confidently.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry parameter meaning. It merely restates the three enum values without explaining what a 'report', 'investigation' or 'commands' contract is, and critically it says nothing about the default when the optional subject is omitted.

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

Purpose3/5

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

States a verb ('Return') and an object ('machine-readable contract') and names the three subjects, which mirrors the enum. However, 'contract' is never defined, and nothing distinguishes this from siblings like aa_status or aa_inventory, so the agent cannot confidently tell what the tool produces.

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?

There is no statement of when to call this tool, no prerequisites, and no mention of alternatives among the fifteen aa_* siblings. The agent must infer usage entirely from the name.

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