Skip to main content
Glama

Valuein — SEC EDGAR Fundamentals & Smart-Money Data

Save Figure Review

save_figure_review
Idempotent

Record (or update) the review state of ONE figure inside a report — the durable answer to 'has a human traced this number back to its filing?' Upsert keyed on (report_id, figure_key): re-reviewing a figure REPLACES its prior mark, it never appends, so this is always the figure's current state, never a history. figure_key is an opaque id you mint yourself for one figure — for a dataset-backed figure use fact:{fact_id}#{figure}, where {figure} is the number as the report writes it, lowercased and whitespace-collapsed (e.g. fact:f_rev#$402.83b). The value matters: one fact can back two numbers in one sentence, and a key carrying only the fact_id makes one verdict cover both. Reuse the exact same key to update that figure's review later. state: verified (traced and correct) | corrected (wrong — supply corrected_value) | external (legitimately not from Valuein data) | rejected (unsupported, should be removed). corrected_value is REQUIRED when state='corrected' and must be omitted otherwise. Owner-scoped — your reviews never leak to or from another user. Tier: sp500+ (sample rejected).

Input Schema

NameRequiredDescriptionDefault
noteNoOptional free-text reviewer note (e.g. what was checked, or why it was rejected).
stateYesverified = traced to its filing and correct. corrected = wrong (supply corrected_value). external = legitimately not from Valuein data (analyst's own source). rejected = unsupported, should be removed from the report.
report_idYesIdentifier of the report the figure belongs to, as returned by create_report / list_my_reports / save_freeform_report.
figure_keyYesOpaque id you mint for one figure inside the report. Never parsed or validated beyond length — use the exact same key to update this figure's review later. Shape for a dataset-backed figure: 'fact:{fact_id}#{figure}', the figure lowercased and whitespace-collapsed as the report writes it ('fact:f_rev#$402.83b'); the Workspace mints 'raw:{hash}' for a figure with no fact, which only it can compute.
corrected_valueNoThe correct value. REQUIRED when state='corrected'; must be omitted for every other state (a corrected_value on a non-corrected review is rejected).

Output Schema

NameRequiredDescriptionDefault
okYes
_metaYesProvenance envelope — data lineage for every MCP response
reviewYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / _meta / properties / cost_usd / properties / basis / description
      Previous value: -"payg_charge = real charge (agent-pay or your balance). payg_rate_card = indicative price, not billed."New value: +"payg_charge = real pay-per-call charge (a card or MPP payment through agent-pay). payg_rate_card = indicative price, not billed."
  2. Changed2 schema fields changed
    • changedOutput schema / properties / _meta / properties / cost_usd / properties / basis / description
      Previous value: -"payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed."New value: +"payg_charge = real charge (agent-pay or your balance). payg_rate_card = indicative price, not billed."
    • changedOutput schema / properties / _meta / properties / cost_usd / properties / billed / description
      Previous value: -"true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free."New value: +"true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value only: no charge was made for this call (it was within your plan)."
  3. Added
  4. Removed
  5. Changed1 schema field changed
    • changedOutput schema / properties / _meta / properties / fundamentals_as_of / description
      Previous value: -"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt. Use THIS — not `last_updated` — when telling a user how current the fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to."New value: +"ISO timestamp when the FINANCIAL STATEMENTS were last rebuilt in bulk. Use THIS — not `last_updated` — when telling a user how current the cross-sectional fundamentals are. The snapshot is republished on every weekday price refresh while the statements are carried forward unchanged, so `last_updated` can be far more recent than the numbers it sits next to. It is a floor for a single filer, not a ceiling: a filer with a live partition receives its filing, facts and ratios intraday (minutes after EDGAR dissemination), so an entity-scoped read may carry a filing newer than this; cross-sectional ranks (factor scores, earnings signals) refresh with the weekly bulk export."
  6. Changed1 schema field changed
    • changedInput schema / properties / figure_key / description
      Previous value: -"Opaque id you mint for one figure inside the report. Never parsed or validated beyond length — use the exact same key to update this figure's review later. Common shapes: 'fact:{fact_id}' for a dataset-backed figure, 'raw:{hash}' for free-text prose."New value: +"Opaque id you mint for one figure inside the report. Never parsed or validated beyond length — use the exact same key to update this figure's review later. Shape for a dataset-backed figure: 'fact:{fact_id}#{figure}', the figure lowercased and whitespace-collapsed as the report writes it ('fact:f_rev#$402.83b'); the Workspace mints 'raw:{hash}' for a figure with no fact, which only it can compute."
  7. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses that the write REPLACES prior state and never appends (no history is kept), that reviews are owner-scoped and never leak across users, that the tool is tier-gated (sp500+), and that corrected_value on a non-corrected review is rejected. These are real behavioral constraints an agent could not infer from readOnlyHint/idempotentHint alone.

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?

Front-loaded with purpose and upsert semantics, then key-minting, then state values, then constraints — a sensible order. It is dense but somewhat long, and the state definitions duplicate the enum descriptions already present in the schema.

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

Completeness5/5

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

For a 5-parameter mutation tool it covers everything an agent needs: key construction, update-vs-create semantics, state meanings, the conditional corrected_value rule, ownership scoping, and the tier gate. Return values need not be explained since an output schema exists.

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?

Schema coverage is 100% so the baseline is 3, but the description adds genuine meaning beyond the schema: the rationale for minting a per-figure key ('one fact can back two numbers in one sentence, and a key carrying only the fact_id makes one verdict cover both'), the lowercase/whitespace-collapsed convention with a worked example, and the state/corrected_value coupling. The state enum is largely restated from the schema, which keeps it from a 5.

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?

States a specific verb+resource ('Record (or update) the review state of ONE figure inside a report') and immediately frames the scope as a single figure, distinguishing it from report-level siblings like verify_report_figures or sign_off_report. The 'durable answer to has a human traced this number' framing makes the intent unambiguous.

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?

Clearly establishes when to call it (recording or updating a per-figure verdict) and the upsert rule that re-reviewing replaces rather than appends. It does not name alternatives (e.g. list_figure_reviews to inspect existing marks, verify_report_figures for bulk verification) or state when not to use it, so it falls short of explicit routing.

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.