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. Pass drafts_only: true when editing a private draft; a client may then let the edit run without asking. With drafts_only the call is refused (not_a_draft, nothing written) unless the report is private, never published and not signed off. A saved edit returns undo (call undo_change to restore the prior version as a NEW head version; history is kept; refused if the report changed since).

Input 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.
drafts_onlyNoPass true when editing a private draft: the call is refused with `not_a_draft` (nothing written) unless the report is private, never published and not signed off. Lets a client run the edit without asking, because a draft edit is undoable and reaches no reader.
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

NameRequiredDescriptionDefault
undoYesHow to put the record back as it was before this write: call `undo_change` with these args. Null when nothing changed or the change could not be recorded.
_metaYesProvenance envelope — data lineage for every MCP response
reportYes
versionYes
archivedYes
previous_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / drafts_only
      Added value: +{
      +  "description": "Pass true when editing a private draft: the call is refused with `not_a_draft` (nothing written) unless the report is private, never published and not signed off. Lets a client run the edit without asking, because a draft edit is undoable and reaches no reader.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / undo
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "args": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "change_id": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "change_id"
      +          ],
      +          "type": "object"
      +        },
      +        "tool": {
      +          "const": "undo_change",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "tool",
      +        "args"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "How to put the record back as it was before this write: call `undo_change` with these args. Null when nothing changed or the change could not be recorded."
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "_meta",
      -  "report",
      -  "version",
      -  "previous_version",
      -  "archived"
      -]New value: +[
      +  "_meta",
      +  "report",
      +  "version",
      +  "previous_version",
      +  "archived",
      +  "undo"
      +]
  2. Changed3 schema fields changed
    • addedInput schema / properties / citations / items / properties / inputs
      Added value: +{
      +  "description": "The filed numbers, as the source writes them, that a computed figure was derived from (0-4).",
      +  "items": {
      +    "maxLength": 60,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "maxItems": 4,
      +  "type": "array"
      +}
    • addedInput schema / properties / citations / items / properties / section
      Added value: +{
      +  "description": "Filing section key exactly as list_filing_sections returns it ('7', 'I-2', 'note-5', '4.02', 'ex-99.1'). Required when source is 'text'.",
      +  "maxLength": 40,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / citations / items / properties / source
      Added value: +{
      +  "description": "Where the figure was read: 'fact' (a Valuein fact_id/derived_id), 'text' (quoted from filing text; needs `section`), 'insider' (a Form 3/4/5 row) or 'holdings' (a 13F row, or an issuer aggregate named by `period_end`). `accession_ids[0]` names the filing for text/insider/holdings.",
      +  "enum": [
      +    "fact",
      +    "text",
      +    "insider",
      +    "holdings"
      +  ],
      +  "type": "string"
      +}
  3. 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."
  4. 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)."
  5. Changed2 schema fields changed
    • changedInput schema / properties / citations / items / properties / fact_ids / description
      Previous value: -"Valuein fact_ids backing the claim, as returned by the data tools."New value: +"Valuein fact_ids (or `drv1:` derived ids) backing the claim, exactly as the data tools returned them."
    • changedInput schema / properties / citations / items / properties / fact_ids / items / maxLength
      Previous value: -128New value: +1024
  6. Added
  7. Removed
  8. 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."
  9. 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
  10. 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"
      +}
  11. 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"
      +}
  12. 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"
      +]
  13. 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"
  14. 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."
  15. 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"
      +]
  16. 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: citations are MERGED and never replace existing ones, `version` is bumped, `drafts_only` is refused with `not_a_draft` and nothing written, and a saved edit returns an `undo` handle whose restore creates a new head version and is refused if the report moved. That is exactly the side-effect and failure-mode context the annotations do not carry.

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-loads the core action, then layers warnings in descending order of importance, with every sentence carrying a distinct rule. Slightly overlong because `drafts_only` behavior is explained in the description and again in the schema, but nothing is truly wasted.

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?

With an output schema, full annotation coverage and 100% schema docs, the description fills the remaining gaps: merge semantics, version bump, refusal codes, undo path and the sibling tools that own the adjacent mutations. An agent has everything needed to call this safely.

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 per-parameter docs already explain `drafts_only`, `expected_version`, `remove_section_ids` and citation merging in depth, so the description largely restates them. It adds some cross-parameter framing (why omitting citations preserves lineage, why drafts_only lets a client skip confirmation), but no format or syntax detail the schema lacks. Baseline 3 applies.

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?

Opens with a specific verb+resource+scope: 'Replace one or more sections of an existing report owned by the caller.' It immediately distinguishes itself from `create_report` (drafting), `publish_report` (price/tier/visibility), `delete_report` and `undo_change`, so an agent can route correctly without opening a schema.

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?

Gives explicit when-to-use (refining an agent's first draft before publishing), explicit when-not ('Does NOT change price / tier / visibility — use publish_report'), and conditional guidance for `drafts_only` plus the deletion case that must go through `remove_section_ids` rather than omission. Exclusions and alternatives are both named.

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.