d365fo_get_sync_history

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

No annotations provided, so description must carry full burden. It discloses it returns a dictionary with sync history but lacks detail on read-only nature, authentication requirements, rate limits, or behavior when no sessions exist. Mentions only completed sessions, which is helpful but insufficient.

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?

Extremely concise: one sentence for purpose, clearly labeled Args and Returns. Every sentence is necessary with no fluff. Excellent front-loading of key information.

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 simple tool with 2 parameters and no output schema, description explains parameters and return type but is vague on return content (just 'dictionary with sync history'). Missing details on fields, pagination, or error handling. Adequate but has gaps.

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 0%, so description adds meaning. Explains limit with default and max (100), profile with default and optional. Provides constraints and usage context beyond schema types and defaults.

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 clearly states it gets history of completed sync sessions with status and statistics. The verb 'get' and resource are specific, but does not explicitly differentiate from sibling d365fo_list_sync_sessions, which might be similar.

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?

No explicit guidance on when to use this tool versus alternatives. Does not mention exclusions, prerequisites, or compare to sibling tools like d365fo_get_sync_progress or d365fo_list_sync_sessions.

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