Skip to main content
Glama

codat

by io.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

TableJSON 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. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true; description adds that data is broken into periods and gives API endpoint. No side effects indicated, which is appropriate for a read-only tool.

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?

Two efficient sentences: first states purpose, second gives critical usage info and API reference. No wasted words.

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 read-only tool with high schema coverage and no output schema, description sufficiently covers purpose, required params, and defaults. Could optionally describe return shape but not essential.

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?

Input schema covers all params with descriptions (100% coverage). Description adds value by noting that startMonth defaults to most recent, which is not in schema. Otherwise mostly restates schema.

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

Purpose5/5

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

Clearly states verb 'Get', resource 'balance sheet', and adds context about periods. Distinct from sibling financial statement tools.

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

Usage Guidelines4/5

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

Explicitly states that periodLength and periodsToCompare are both required by Codat, providing essential usage guidance. Does not mention when not to use this tool, but sibling names imply alternatives.

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

All codat toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4/5.0
Disambiguation5/5

Each tool targets a distinct resource or action (e.g., companies, connections, invoices, financial statements). Even similar-looking tools like the three financial statements are clearly differentiated by their names and descriptions. No overlapping purposes.

Naming Consistency5/5

All tools follow the consistent pattern 'codat_verb_noun' (e.g., codat_create_company, codat_list_invoices, codat_get_balance_sheet). No mixing of styles or irregular naming.

Tool Count5/5

28 tools cover the main read and refresh operations across Codat's domain (companies, connections, accounting data, integrations). The count feels well-scoped for a data aggregation platform, not excessive.

Completeness3/5

The tool set focuses heavily on reading and listing data, with only create for companies/connections and refresh triggers. Missing update/delete for many entities (e.g., invoices, bills). An escape hatch exists but is GET-only. Notable gaps for write workflows.

Resources