st.chat.metadata.get

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

No annotations are provided, so the description carries the full disclosure burden. 'Read' clearly communicates a non-mutating operation, and 'Requires explicit avatar and fileName' signals strict identifier requirements. However, it does not disclose return behavior, error conditions, or permission requirements.

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

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

Two short sentences with the main purpose front-loaded. The second sentence is partly redundant with the schema's required list but does add the 'explicit' nuance, so it is not entirely wasted. Overall concise and easy to scan.

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

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

The tool has no parameter descriptions, no output schema, and no annotations, making the description the sole source of context. It gives the purpose and required parameters but not the meaning of avatar/fileName, the return shape, or error behaviors. An agent could invoke it but without confidence about expected results.

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

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

Schema description coverage is 0%, so the description must compensate. It only restates that avatar and fileName are required (already shown in the schema) and adds the vague qualifier 'explicit' without explaining what values are acceptable, how they relate to the ST chat file, or how to obtain them.

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

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

The description clearly states the action ('Read'), the resource ('chat_metadata'), and the scope ('from a specific ST chat file'). It is easy to tell apart from st.chat.metadata.patch based on the read/patch contrast, but it does not explicitly distinguish itself from similarly named siblings like st.chat.inspect.

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

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

Usage is implied by the verb 'Read' and the resource name, but no explicit when-to-use or when-not-to-use guidance is given. 'Requires explicit avatar and fileName' hints at prerequisites but does not point to an alternative tool for cases where those are not available.

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