Skip to main content
Glama

Codat MCP by usefulapi

Get balance sheet

codat_get_balance_sheet
Read-only

Get a company's balance sheet, broken into periods. periodLength (months per period) and periodsToCompare are BOTH required by Codat. Codat API: GET /companies/{companyId}/data/financials/balanceSheet.

Input Schema

NameRequiredDescriptionDefault
companyIdYesThe Codat companyId (UUID).
startMonthNoFirst month of the earliest period (YYYY-MM-DD); defaults to the most recent.
periodLengthYesNumber of months per period (1-12). Required.
periodsToCompareYesHow many periods to return (1-12). Required.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

readOnlyHint=true already covers the safety profile. The description adds a useful behavioral note ('BOTH required by Codat') and the underlying endpoint, but omits data-freshness/sync-state requirements and return-shape hints, which matter for a read-only financials endpoint.

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?

Two tight sentences, with the core purpose front-loaded before the constraint note and API endpoint. The required-parameter sentence partly duplicates the schema's required array, but overall there is little waste.

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?

With no output schema, the description carries the burden of explaining what comes back, and it says only 'broken into periods' without describing the balance-sheet structure or line items. Adequate for invoking the call but thin on result expectations.

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 coverage is 100%, so the schema already documents all four parameters, including ranges and defaults. The description largely restates the required-parameter constraint and periodLength's meaning, adding no syntax or semantics beyond what the schema provides.

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?

States a specific verb and resource ('Get a company's balance sheet') with the added scope qualifier 'broken into periods'. The resource name distinguishes it from financial-statement siblings like get_cash_flow_statement and get_profit_and_loss, though the description does not explicitly name or contrast those alternatives.

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?

No when-to-use guidance and no mention of alternatives or prerequisites such as required company data being synced first. The note that periodLength and periodsToCompare are required hints at invocation needs but is not framed as usage guidance.

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.