train_job_config

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

Explicitly declares read-only nature. Describes data source (ai-toolkit config.yml) and lists key fields returned. Sufficient behavioral transparency for a simple retrieval tool given no annotations.

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?

Efficiently two sentences. First sentence states purpose and lists fields, second clarifies utility and read-only nature. No superfluous content.

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?

Adequately covers what the tool does, what it returns, and read-only nature. Given the simplicity (1 param, no output schema), the description provides sufficient context. Could mention error handling or required permissions, but not essential.

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 already describes 'id' as 'Job id from train_start.' Description repeats similar info but adds no new semantics beyond stating it's from train_start. Given 100% coverage, baseline 3 applies.

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?

Clearly states verb 'Show' and resource 'effective settings a training job ran with'. Lists specific config fields and mentions read-only nature. Distinguishes from sibling training tools by focusing on post-hoc config retrieval.

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?

Implies usage after training job has started (reads config from config.yml). Lacks explicit when/when-not or alternative comparison. Some implied context but not full guidance.

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