list-invoices
List invoices for a company with optional status and search filters and page/perPage pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| search | No | ||
| status | No | ||
| perPage | No | ||
| companyId | Yes | Company ID |
List invoices for a company with optional status and search filters and page/perPage pagination.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| search | No | ||
| status | No | ||
| perPage | No | ||
| companyId | Yes | Company ID |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare this a safe, read-only, non-destructive operation, so the safety profile is covered. The description adds that pagination is supported via page/perPage and that filters are optional, which is useful context, but it discloses nothing about return shape, ordering, or defaults beyond what annotations give.
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?
A single front-loaded sentence with no filler, listing purpose, scope, filters, and pagination efficiently. It is appropriately sized, though slightly dense in its clause list.
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 read-only list endpoint whose annotations already carry the safety profile and with no output schema required, the description is adequate but thin. With five parameters and low schema coverage, more detail on filter behavior and pagination would round it out.
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 only 20% (only companyId is documented), so the description must compensate, and it does name the filter and pagination parameters (status, search, page, perPage). However it omits the status enum values, default page size, and the semantics of 'search', so it only partially fills the gap.
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?
States a specific verb and resource ('List invoices') scoped to a company, which is clear and unambiguous. It implicitly distinguishes from siblings like get-overdue-invoices or create-invoice-draft, but never names them, so it falls short of explicit differentiation.
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 guidance on when to use this tool versus alternatives such as get-overdue-invoices, get-invoice-pending-summary, or search-transactions. The existence of filters is mentioned but not when they should be preferred.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.