Skip to main content
Glama

Brightpearl MCP by usefulapi

List tax codes

brightpearl_list_tax_codes
Read-only

The tax codes (id, code, description, rate). GET /accounting-service/tax-code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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 underlying endpoint (GET /accounting-service/tax-code) and enumerates the returned fields, which is useful, but says nothing about ordering, pagination, or result size. With annotations carrying the behavioral burden, a 3 is appropriate.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One short sentence plus an endpoint, with nothing redundant. It is front-loaded and easy to scan, though the fragment style borders on under-specification rather than true conciseness.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-parameter read tool with full annotation coverage, the description is adequate: it names the resource, lists the core fields, and gives the endpoint. However, with no output schema, it does not say whether this returns all tax codes or what the response envelope looks like, leaving a modest gap for an agent assembling a request flow.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so there is nothing to disambiguate; the baseline for a 0-param tool is 4. The description's field list is about output, not input, so no parameter semantics are needed or missing.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description is a noun fragment ('The tax codes (id, code, description, rate)') with no verb; the verb 'List' only appears in the name and title. It does identify the resource and its returned fields, but an agent must infer the operation from the name rather than the description. It is distinguishable from siblings mainly because no other sibling mentions tax codes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus alternatives, no mention of prerequisites, and no note about whether results are filtered, paginated, or complete. The only routing signal is the word 'tax codes' itself.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.