벨로그 글 목록

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

Beyond the readOnlyHint and openWorldHint annotations, the description adds that results are in newest-first order, username defaulting behavior, and authentication requirement for drafts_only. This is valuable behavioral context that the annotations alone do not provide.

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 sentences with no wasted words. The first sentence states the primary action and ordering; the second adds key usage details. Information is front-loaded and efficient.

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?

For a list tool with 5 parameters, an output schema, and good annotations, the description covers essential points: purpose, ordering, default username, drafts authentication. No critical gaps identified.

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?

The input schema covers all 5 parameters with descriptions (100% coverage). The description adds extra meaning: username default uses an environment variable, and drafts_only requires authentication. These details enhance understanding beyond the schema.

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 it fetches a list of Velog posts in newest order. It distinguishes itself from sibling tools (e.g., velog_get_post for single post, velog_list_series for series) by focusing on '글 목록' and using the verb '가져옵니다'.

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?

The description provides specific usage context: username defaults to VELOG_USERNAME if omitted, and drafts_only requires authentication. It does not explicitly mention when not to use or compare with alternatives, but the distinct purpose makes it clear when to select this tool.

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