Skip to main content
Glama

Valuein — SEC EDGAR Fundamentals & Smart-Money Data

Update Report Sections

update_report
Idempotent

Replace one or more sections of an existing report owned by the caller. Useful for authoring workflows where the agent's first draft (create_report) is refined by additional analysis before publishing. Pass citations for figures in the edited prose — they are MERGED into the report's existing set, never replacing it, so omitting them preserves the lineage already recorded. Bumps version. Does NOT change price / tier / visibility — use publish_report for those.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoOptional new title.
abstractNoOptional new abstract.
sectionsYesSections to replace. Sections not listed are preserved — to DELETE one, name it in `remove_section_ids`. Section ids must match the existing payload.
citationsNoLineage for figures in the edited sections. MERGED into the report's existing citations (first claim wins), never replacing them — so an editor autosave that sends none preserves every citation the report already had.
report_idYesIdentifier of the report to update, as returned by create_report or list_my_reports.
expected_versionNoOptimistic concurrency check. If supplied and the current HEAD version is different, the call returns a `version_conflict` error WITHOUT writing. Pass the version you loaded so a concurrent agent edit produces a 'conflict — review' UX instead of silently overwriting (eng review A3A).
remove_section_idsNoSection ids to DELETE outright. Without this, a merge-only update cannot express a deletion: an editor that drops a section simply omits it, the omitted section is preserved, and the caller sees a bumped version with the deleted content still there — a save that reports success and changed nothing. Ids must exist, and the last remaining section cannot be removed (a report with no sections is unreadable); remove the report instead with delete_report.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
_metaYesProvenance envelope — data lineage for every MCP response
reportYes
versionYes
archivedYes
previous_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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."
  2. Changed5 schema fields changed
    • addedInput schema / properties / citations
      Added value: +{
      +  "description": "Lineage for figures in the edited sections. MERGED into the report's existing citations (first claim wins), never replacing them — so an editor autosave that sends none preserves every citation the report already had.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "accession_ids": {
      +        "description": "Optional SEC accession ids backing the claim.",
      +        "items": {
      +          "maxLength": 32,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 50,
      +        "type": "array"
      +      },
      +      "claim": {
      +        "description": "Plain-English claim, quoting the figure as the prose writes it (e.g. 'FY2024 revenue: $391.0B').",
      +        "maxLength": 500,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "evidence": {
      +        "description": "Provenance class. Defaults to 'derived' — the weaker claim.",
      +        "enum": [
      +          "primary",
      +          "derived",
      +          "external"
      +        ],
      +        "type": "string"
      +      },
      +      "fact_ids": {
      +        "description": "Valuein fact_ids backing the claim, as returned by the data tools.",
      +        "items": {
      +          "maxLength": 128,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 50,
      +        "type": "array"
      +      },
      +      "filed_at": {
      +        "description": "SEC acceptance timestamp of the filing (ISO 8601) — when the figure became public.",
      +        "maxLength": 40,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "form_type": {
      +        "description": "SEC form the figure was reported on ('10-K', '10-Q', '20-F'), verbatim from the source.",
      +        "maxLength": 20,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "period_end": {
      +        "description": "Last day of the period the figure COVERS (YYYY-MM-DD). Not the filing date.",
      +        "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      +        "type": "string"
      +      },
      +      "period_label": {
      +        "description": "How the filer names that period: 'FY2025', 'Q3 2025'.",
      +        "maxLength": 40,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "sec_urls": {
      +        "description": "Optional EDGAR URLs, one per accession.",
      +        "items": {
      +          "maxLength": 500,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 50,
      +        "type": "array"
      +      },
      +      "ticker": {
      +        "description": "Ticker the fact belongs to. Lets a figure be verified when the report has no ticker.",
      +        "maxLength": 10,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "claim",
      +      "fact_ids"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 1000,
      +  "type": "array"
      +}
    • addedInput schema / properties / remove_section_ids
      Added value: +{
      +  "description": "Section ids to DELETE outright. Without this, a merge-only update cannot express a deletion: an editor that drops a section simply omits it, the omitted section is preserved, and the caller sees a bumped version with the deleted content still there — a save that reports success and changed nothing. Ids must exist, and the last remaining section cannot be removed (a report with no sections is unreadable); remove the report instead with delete_report.",
      +  "items": {
      +    "maxLength": 128,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 20,
      +  "type": "array"
      +}
    • changedInput schema / properties / sections / description
      Previous value: -"Sections to replace. Sections not listed are preserved. Section ids must match the existing payload."New value: +"Sections to replace. Sections not listed are preserved — to DELETE one, name it in `remove_section_ids`. Section ids must match the existing payload."
    • removedInput schema / properties / sections / items / properties / heading / minLength
      Removed value: -1
    • removedInput schema / properties / sections / items / properties / markdown / minLength
      Removed value: -1
  3. Changed2 schema fields changed
    • addedOutput schema / properties / _meta / properties / fundamentals_as_of
      Added value: +{
      +  "description": "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.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / _meta / properties / price_as_of
      Added value: +{
      +  "description": "ISO timestamp when the price surfaces were last refreshed.",
      +  "type": "string"
      +}
  4. Changed2 schema fields changed
    • addedOutput schema / properties / _meta / properties / cost_usd
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Per-call cost transparency. Omitted for subscription-only tools that have no PAYG-equivalent price.",
      +  "properties": {
      +    "amount_usd": {
      +      "minimum": 0,
      +      "type": "number"
      +    },
      +    "basis": {
      +      "description": "payg_charge = real agent-pay charge. payg_rate_card = indicative price, not billed.",
      +      "enum": [
      +        "payg_charge",
      +        "payg_rate_card"
      +      ],
      +      "type": "string"
      +    },
      +    "billed": {
      +      "description": "true = this amount was actually charged via PAYG for this call. false = indicative PAYG-equivalent value; your plan already covers this call for free.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "amount_usd",
      +    "billed",
      +    "basis"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / _meta / properties / latency_ms
      Added value: +{
      +  "description": "Wall-clock milliseconds this tool call took, measured server-side around the handler.",
      +  "minimum": 0,
      +  "type": "integer"
      +}
  5. Changed2 schema fields changed
    • removedOutput schema / properties / vectorize_reindexed
      Removed value: -{
      -  "type": "boolean"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "_meta",
      -  "report",
      -  "vectorize_reindexed",
      -  "version",
      -  "previous_version",
      -  "archived"
      -]New value: +[
      +  "_meta",
      +  "report",
      +  "version",
      +  "previous_version",
      +  "archived"
      +]
  6. Changed1 schema field changed
    • addedOutput schema / properties / _meta / properties / pit_safe / description
      Added value: +"true iff a zero-look-ahead point-in-time cut was applied to every returned figure"
  7. Changed1 schema field changed
    • addedInput schema / properties / report_id / description
      Added value: +"Identifier of the report to update, as returned by create_report or list_my_reports."
  8. Changed4 schema fields changed
    • addedInput schema / properties / expected_version
      Added value: +{
      +  "description": "Optimistic concurrency check. If supplied and the current HEAD version is different, the call returns a `version_conflict` error WITHOUT writing. Pass the version you loaded so a concurrent agent edit produces a 'conflict — review' UX instead of silently overwriting (eng review A3A).",
      +  "exclusiveMinimum": 0,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / archived
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / previous_version
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "_meta",
      -  "report",
      -  "vectorize_reindexed",
      -  "version"
      -]New value: +[
      +  "_meta",
      +  "report",
      +  "vectorize_reindexed",
      +  "version",
      +  "previous_version",
      +  "archived"
      +]
  9. Added

TDQS

A4.7/5.0
Behavior5/5

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

Despite annotations already covering read-only/destructive/idempotent hints, the description adds meaningful behavioral context: it bumps version, merges citations instead of replacing them, preserves lineage when citations are omitted, and explicitly scopes what it does NOT change. No contradiction with the annotations is evident.

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 dense but efficient: it front-loads the core action, then adds workflow context, citation behavior, version behavior, and an explicit exclusion. No sentence is redundant or filler.

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?

Given the high schema coverage, rich per-parameter descriptions, and an output schema, the main description does not need to explain return values or every edge case. It supplies the missing workflow, ownership, version, and citation-merge context, making the full tool definition 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 every parameter already has a detailed description, so the baseline is 3. The main description echoes the citations merge behavior, but it does not add meaning beyond what the schema already provides for the parameters.

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?

The description uses a specific verb and resource: 'Replace one or more sections of an existing report owned by the caller.' It clearly distinguishes itself from create_report and publish_report by framing it as the refinement step after a draft and explicitly deferring visibility changes to publish_report.

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

Usage Guidelines5/5

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

It states the intended workflow context: an agent's first draft from create_report is refined before publishing. It also gives an explicit when-not-to-use signal: 'Does NOT change price / tier / visibility — use publish_report for those.' This is actionable routing guidance rather than vague context.

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.