List shipping methods
brightpearl_list_shipping_methodsThe shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
brightpearl_list_shipping_methodsThe shipping methods (id, name, code, carrier, price breaks, countries). GET /warehouse-service/shipping-method.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds the returned field set and the underlying endpoint but says nothing about pagination, result size, or whether all methods are returned in one call — gaps that matter for an open-world list endpoint.
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 compact sentence with no waste, and the field list is front-loaded. The trailing raw endpoint path is slightly cryptic but harmless and adds traceability.
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 zero-parameter, read-only list tool with no output schema, the description supplies exactly what is missing: the shape of the returned records. With annotations covering safety, nothing an agent needs to call this correctly is absent.
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 tool takes zero parameters, so the baseline is 4. The description's field list is about outputs, not inputs, and there are no inputs to explain.
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 identifies the specific resource (shipping methods) and enumerates the fields returned, so an agent knows exactly what data it gets back. It doesn't explicitly say 'list/retrieve' or contrast with siblings like list_payment_methods or list_warehouses, but the resource is unambiguous, so 4 rather than 5.
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?
There is no statement of when to use this tool, no prerequisites, and no named alternative. The only implied guidance is that the tool returns all shipping methods with no filtering, which the agent must infer from the empty schema.
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.