getFGridDetail

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

No annotations provided, so description carries full burden. Clearly states it 'Retrieves comprehensive details' with no side effects, mentions rate limit, and lists return fields including PnL, position, close reason. Lacks explicit clarification on authentication requirements or error behavior, but overall transparent for a read operation.

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?

Description is concise (5-6 sentences) with each sentence adding value (purpose, content list, parameter source, rate limit, agent hint). No redundancy, though could be slightly more compact without losing clarity.

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?

No output schema, so description sufficiently details response contents: configuration, status, PnL metrics, position info, margin balances, timestamps, close reason. Adequate for a single-parameter read tool, but lacks mention of error responses or permission requirements.

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?

Single parameter bot_id is undocumented in schema (0% coverage). Description adds crucial context: it is 'a numeric ID obtained from createFGridBot or bot listing endpoints', directly supporting correct parameter usage and value acquisition.

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?

Description uses specific verb 'Retrieves comprehensive details' and explicitly lists the types of information included (configuration, status, PnL metrics, position info, margin balances, timestamps). It clearly distinguishes this futures grid bot tool from similar sibling tools like getFMartDetail and queryGridDetail by specifying 'futures grid bot' and outlining unique fields.

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?

Provides source of bot_id (from createFGridBot or bot listing endpoints), rate limit (10 req/s per UID), and an explicit hint to use this endpoint for checking status/performance, preferring it over others. Does not explicitly state when not to use or mention alternative tools for other actions, but guidance is clear and practical.

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