fluent_sdk_query

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

Beyond annotations (readOnlyHint, openWorldHint), the description adds that it's executed via the SDK CLI, is new in version 4.8, and is browser-free. It also confirms read-only behavior. This provides additional context for agent decision-making.

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?

The description is two sentences plus an example. It is front-loaded with the core action, followed by contextual use cases and a concrete example. Every element earns its place without superfluous text.

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 description covers purpose, usage context, and an example. It does not explain the return format or prerequisites (e.g., SDK installation), but given the good annotations and schema, it is largely complete. Some details about expected output could be added.

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 coverage is 100%, so the schema already documents parameters. The description adds an example demonstrating usage of all four parameters (table, query, fields, limit), which provides practical context beyond the schema descriptions.

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 runs 'now-sdk query <table>' as a read-only operation via the ServiceNow SDK CLI. It specifies the resource (table) and method (CLI query), with an example that distinguishes it from other query tools like 'fluent_query' or 'query_records'.

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 explicit use cases: 'resolve sys_ids, inspect table schemas, check existing records, read choice values' during Fluent code authoring. It implies a development context but does not explicitly state when not to use it or mention alternatives.

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