Skip to main content
Glama

Valuein — SEC EDGAR Fundamentals & Smart-Money Data

Compare Financial Periods

compare_periods
Read-onlyIdempotent

Compare a company's core financial metrics across two fiscal periods side-by-side. Shows absolute and percentage changes with significance classification (minor < 5%, notable 5–15%, significant > 15%). The response includes a material_changes count: this is the number of metrics whose significance ∈ {notable, significant} (i.e. absolute percentage change > 5%). Use it as a quick scalar to triage filings — anything > ~3 typically signals a material event worth deeper review. Use period format: 'FY2024' for annual, 'Q1-2024' for quarterly. Pass period_a as the EARLIER period and period_b as the LATER one — if you invert them the server auto-swaps and sets swapped: true in the response so deltas always carry the correct sign (rather than silently flipping). Point-in-time safe via as_of_date. Available on all plans.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tickerYesStock ticker symbol, e.g. AAPL, MSFT, BRK.B — or a CIK (SEC identifier), e.g. '0000320193'.
period_aYesEarlier fiscal period. Format: 'FY2023' for annual or 'Q1-2023' for quarterly.
period_bYesLater fiscal period. Format: 'FY2024' for annual or 'Q1-2024' for quarterly.
as_of_dateNoPoint-in-time date (YYYY-MM-DD). Only returns facts with accepted_at on or before this date — eliminates look-ahead bias for backtesting.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
_metaYesProvenance envelope — data lineage for every MCP response
tickerYes
changesYesPer-metric deltas: metric, label, period_a, period_b, delta, delta_pct, significance
swappedYesTrue when inputs were reordered so period_b is the more recent period
period_aYesEarlier period descriptor: label, fiscal_year, fiscal_period, period_end, filing_date
period_bYesLater period descriptor, same shape as period_a
as_of_dateNo
company_nameNo
total_metricsYesCount of metrics compared across the two periods
material_changesYesCount of metrics flagged as a material change

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. Changed2 schema fields changed
    • changedInput schema / properties / ticker / description
      Previous value: -"Stock ticker symbol, e.g. AAPL, MSFT, BRK.B"New value: +"Stock ticker symbol, e.g. AAPL, MSFT, BRK.B — or a CIK (SEC identifier), e.g. '0000320193'."
    • changedInput schema / properties / ticker / pattern
      Previous value: -"^[A-Za-z.\\-]+$"New value: +"^[A-Za-z0-9.\\-]+$"
  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. 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"
  6. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "_meta": {
      +      "additionalProperties": false,
      +      "description": "Provenance envelope — data lineage for every MCP response",
      +      "properties": {
      +        "as_of_date": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "data_plan": {
      +          "description": "Access plan: sample | sp500 | pro | full",
      +          "type": "string"
      +        },
      +        "data_quality": {
      +          "additionalProperties": false,
      +          "description": "Server-side invariants run on this response",
      +          "properties": {
      +            "notes": {
      +              "items": {
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            "validation_failed": {
      +              "items": {
      +                "additionalProperties": false,
      +                "properties": {
      +                  "detail": {
      +                    "type": "string"
      +                  },
      +                  "rule": {
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "rule",
      +                  "detail"
      +                ],
      +                "type": "object"
      +              },
      +              "type": "array"
      +            },
      +            "validation_passed": {
      +              "items": {
      +                "type": "string"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "required": [
      +            "validation_passed",
      +            "validation_failed",
      +            "notes"
      +          ],
      +          "type": "object"
      +        },
      +        "last_updated": {
      +          "description": "ISO timestamp when the snapshot was exported",
      +          "type": "string"
      +        },
      +        "limit_warnings": {
      +          "description": "Soft-warning array for partial fulfillment. Each entry carries a stable subcode + remediation.options[]. AI agents pattern-match on subcode.",
      +          "items": {
      +            "additionalProperties": true,
      +            "properties": {
      +              "code": {
      +                "const": "LIMIT_EXCEEDED",
      +                "type": "string"
      +              },
      +              "current_plan": {
      +                "type": "string"
      +              },
      +              "extensions": {
      +                "additionalProperties": {},
      +                "type": "object"
      +              },
      +              "limit_type": {
      +                "type": "string"
      +              },
      +              "limit_value": {},
      +              "remediation": {
      +                "additionalProperties": true,
      +                "properties": {
      +                  "contact_sales": {
      +                    "type": "string"
      +                  },
      +                  "default_action": {
      +                    "type": "string"
      +                  },
      +                  "options": {
      +                    "items": {
      +                      "additionalProperties": {},
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  },
      +                  "pricing_page": {
      +                    "type": "string"
      +                  }
      +                },
      +                "required": [
      +                  "options",
      +                  "default_action",
      +                  "pricing_page",
      +                  "contact_sales"
      +                ],
      +                "type": "object"
      +              },
      +              "requested_value": {},
      +              "returned_value": {},
      +              "subcode": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "code",
      +              "subcode",
      +              "limit_type",
      +              "current_plan",
      +              "remediation"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "payg_override": {
      +          "additionalProperties": false,
      +          "description": "Set when this single response was paid for via the agent-pay PAYG flow — the rate-limit / depth-limit checks were bypassed for this call only.",
      +          "properties": {
      +            "amount_cents": {
      +              "type": "number"
      +            },
      +            "entity_scope_hash": {
      +              "type": "string"
      +            },
      +            "meter": {
      +              "type": "string"
      +            },
      +            "quote_id": {
      +              "type": "string"
      +            },
      +            "retry_token_hash": {
      +              "type": "string"
      +            },
      +            "ticker_count": {
      +              "type": "number"
      +            },
      +            "tool": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "quote_id",
      +            "tool",
      +            "meter",
      +            "amount_cents",
      +            "ticker_count",
      +            "entity_scope_hash",
      +            "retry_token_hash"
      +          ],
      +          "type": "object"
      +        },
      +        "pit_safe": {
      +          "type": "boolean"
      +        },
      +        "rate_limit": {
      +          "additionalProperties": false,
      +          "description": "Caller's remaining budget",
      +          "properties": {
      +            "limit": {
      +              "type": "integer"
      +            },
      +            "remaining": {
      +              "type": "integer"
      +            },
      +            "reset_at": {
      +              "description": "ISO 8601 timestamp when the window resets",
      +              "type": "string"
      +            },
      +            "window": {
      +              "enum": [
      +                "minute",
      +                "hour"
      +              ],
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "limit",
      +            "remaining",
      +            "reset_at",
      +            "window"
      +          ],
      +          "type": "object"
      +        },
      +        "request_id": {
      +          "description": "Per-request correlation id (8-char)",
      +          "type": "string"
      +        },
      +        "result_count": {
      +          "type": "integer"
      +        },
      +        "schema_version": {
      +          "description": "Parquet schema version from manifest.json",
      +          "type": "string"
      +        },
      +        "snapshot": {
      +          "description": "Snapshot directory name (e.g. snapshot_20260420)",
      +          "type": "string"
      +        },
      +        "source": {
      +          "const": "SEC EDGAR",
      +          "type": "string"
      +        },
      +        "ticker": {
      +          "type": "string"
      +        },
      +        "truncation": {
      +          "additionalProperties": false,
      +          "description": "Set when fewer rows were returned than requested — explains why and points to a remedy",
      +          "properties": {
      +            "current_plan": {
      +              "type": "string"
      +            },
      +            "plan_limit": {
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            "reason": {
      +              "enum": [
      +                "PLAN_LIMIT",
      +                "DATA_NOT_AVAILABLE",
      +                "FISCAL_YEAR_BOUNDARY_FILTER",
      +                "OTHER"
      +              ],
      +              "type": "string"
      +            },
      +            "requested": {
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            "returned": {
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            "upgrade_required_for": {
      +              "type": "string"
      +            },
      +            "upgrade_url": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "requested",
      +            "returned",
      +            "reason"
      +          ],
      +          "type": "object"
      +        }
      +      },
      +      "required": [
      +        "data_plan",
      +        "schema_version",
      +        "snapshot",
      +        "last_updated",
      +        "source",
      +        "pit_safe"
      +      ],
      +      "type": "object"
      +    },
      +    "as_of_date": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "changes": {
      +      "description": "Per-metric deltas: metric, label, period_a, period_b, delta, delta_pct, significance",
      +      "items": {
      +        "additionalProperties": true,
      +        "properties": {},
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "company_name": {
      +      "type": "string"
      +    },
      +    "material_changes": {
      +      "description": "Count of metrics flagged as a material change",
      +      "type": "integer"
      +    },
      +    "period_a": {
      +      "additionalProperties": true,
      +      "description": "Earlier period descriptor: label, fiscal_year, fiscal_period, period_end, filing_date",
      +      "properties": {},
      +      "type": "object"
      +    },
      +    "period_b": {
      +      "additionalProperties": true,
      +      "description": "Later period descriptor, same shape as period_a",
      +      "properties": {},
      +      "type": "object"
      +    },
      +    "swapped": {
      +      "description": "True when inputs were reordered so period_b is the more recent period",
      +      "type": "boolean"
      +    },
      +    "ticker": {
      +      "type": "string"
      +    },
      +    "total_metrics": {
      +      "description": "Count of metrics compared across the two periods",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "_meta",
      +    "ticker",
      +    "period_a",
      +    "period_b",
      +    "swapped",
      +    "total_metrics",
      +    "material_changes",
      +    "changes"
      +  ],
      +  "type": "object"
      +}
  7. Changed1 schema field changed
    • changedInput schema / properties / as_of_date / description
      Previous value: -"Point-in-time date (YYYY-MM-DD). Only returns facts with knowledge_at on or before this date — eliminates look-ahead bias for backtesting."New value: +"Point-in-time date (YYYY-MM-DD). Only returns facts with accepted_at on or before this date — eliminates look-ahead bias for backtesting."
  8. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare read-only/idempotent, and the description adds rich behavioral context beyond them: significance thresholds, material_changes definition, server-side auto-swap with swapped flag, and point-in-time semantics via as_of_date. It also notes availability on all plans. No contradictions.

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?

Long but information-dense; every clause adds new behavior (thresholds, swap flag, triage guidance) not present in structured fields. Slightly heavier than necessary, but no fluff.

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?

Complete for a read-only comparison tool: covers purpose, input requirements, ordering, significance interpretation, point-in-time safety, and availability. Output schema is present so return-structure details are delegated appropriately.

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 already documents all four parameters and formats; the description adds crucial ordering semantics (period_a earlier, period_b later, auto-swap), the meaning of as_of_date for eliminating look-ahead bias, and examples of valid period strings. This goes beyond the schema baseline.

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 states a specific verb ('compare') and resource ('core financial metrics across two fiscal periods'), and immediately distinguishes the tool with side-by-side absolute/percentage changes and significance classification. It is clearly differentiated from sibling tools like get_financial_ratios or compute_dcf.

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?

Provides explicit usage context: use as a quick scalar to triage filings, period format requirements, and ordering instructions. It stops short of naming alternatives or exclusion conditions, but the guidance is substantive and unambiguous.

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.