Skip to main content
Glama

Red by Big Red Cloud

Check Company Readiness

brc_company_readiness_check
Read-only

Returns overall company readiness across connection, financial year, reference data, VAT, analysis categories and settings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
companyNameYesCompany context name, for example YOUR-COMPANY-NAME.
connectionRefNoOpaque Red connection reference returned by brc_confirm_company_connection. Pass this exact value on every later tool call when the MCP client rotates session ids (for example Vibe/Mistral). Keep reusing the same connectionRef after successful tool calls — do not start a new connection because a lookup returned empty or partial data. It is not an API key and does not contain credentials.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds useful scope context by listing the specific readiness areas checked, but it does not disclose what 'readiness' means, what the output contains, or any failure behavior. This does not contradict the annotations.

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

Conciseness5/5

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

The description is a single concise sentence with front-loaded verb and resource, followed by a compact list of readiness areas. There is no filler or repeated information from the schema or title.

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

Completeness4/5

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

For a simple read-only tool with well-documented parameters and safety annotations, the description covers the main purpose and scope. However, there is no output schema and the description does not indicate the shape or granularity of the returned readiness result, which would make the tool slightly more complete.

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

Parameters3/5

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

Schema description coverage is 100%, and the schema already documents both companyName and connectionRef, including the important connectionRef reuse guidance. The description adds no additional parameter semantics beyond the schema, so the baseline of 3 is appropriate.

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

Purpose4/5

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

The description clearly states a specific verb ('Returns') and resource ('overall company readiness') and enumerates the readiness domains: connection, financial year, reference data, VAT, analysis categories, and settings. It is distinguishable from most sibling batch/get/create tools, though it does not explicitly distinguish itself from closely related tools like brc_check_transaction_settings or brc_get_company_setup_config.

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?

The description implies this tool is used to check overall readiness, but it gives no explicit guidance on when to prefer it over alternatives or when not to use it. There are many sibling tools covering settings and transaction checks, and the description does not clarify which one an agent should choose based on the situation.

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.