d365fo_download_debit_credit_note

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

No annotations are provided, so the description carries full burden. It mentions the tool downloads a PDF and returns a dictionary with saved file path, but does not disclose potential side effects, required permissions, or performance characteristics. Since it's a download tool, the behavioral impact is minimal, but more detail on authentication or file size constraints would improve transparency.

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 well-structured with clear sections, a purpose statement, usage context, a query example, and explicit args. It is front-loaded and every sentence adds value. Despite length, it is not verbose.

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?

Given the complexity of D365 and the presence of an output schema (not shown but indicated), the description covers all essentials: how to find the invoice ID, required parameters, optional parameters, and return value. It is complete for an agent to use correctly.

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 schema has 0% description coverage, but the tool description thoroughly explains all parameters: invoice_id (with examples), legal_entity (with examples), save_path (explains optional auto-generation), and profile (with default). This adds significant meaning beyond the raw 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 downloads a debit/credit note report as PDF from D365 Finance & Operations. It specifies the controller (CustDebitCreditNoteController) and distinguishes from sibling tools like d365fo_download_customer_invoice and d365fo_download_free_text_invoice.

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 explicit guidance on when to use this tool (for debit/credit notes) and instructs the agent to first query the CustInvoiceJourBiEntity using d365fo_query_entities to find available invoices. Includes a concrete example query. Clearly differentiates this from other download tools.

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