Skip to main content
Glama

explain_effect_row

Explain a function's effect row by returning its canonical form and a human-readable description of each effect, clarifying what side effects the function performs.

Instructions

Explain a function's effect row: the canonical row plus a human-readable explanation of each effect.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYesPath to a .hird source file.
fn_nameYesThe function's name.
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses the output shape and 'explain' implies a read-only operation, but it does not mention whether there are additional constraints, failure modes, or formatting behaviors.

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

Conciseness5/5

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

The description is one tight sentence that front-loads the purpose and then states the expected output. There is no wasted text and it does not repeat schema content.

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?

For a two-parameter read-style tool, the output is described, but the terms 'effect row' and 'canonical row' are used without any definition. Since there is no output schema, a little more context about what an effect row contains would reduce ambiguity for an agent.

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 the schema already documents the file and fn_name parameters. The description adds no extra parameter-level guidance, which is acceptable given full 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 clearly identifies the target resource, 'a function's effect row', and states that it produces both the canonical row and a human-readable explanation of each effect. It is specific about the artifact and output, but it does not explicitly distinguish itself from sibling explain/render tools.

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?

No guidance is given about when this tool should be used versus alternatives such as explain_actor_protocol or render_ir_fragment. The intended usage is only implied by the word 'explain'.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/no-materials/hird'

If you have feedback or need assistance with the MCP directory API, please join our Discord server