Skip to main content
Glama

TokenBel Financial Data

share_payouts_get

Read-onlyIdempotent

Get dividend/payout history and an aggregate summary for a single share by its TokenBel internal identifier (field name: uuid). Use search_by_ticker to find a share, then call this tool with the returned uuid value. Event period_type is annual/halfyear/quarterly. Event status meanings: declared = payout declared/expected/paid depending on dates, no_dividend = issuer declared no payout, cancelled = revoked. Summary money totals use declared events only. dividend_yield_pct is a nominal-based proxy (latest declared amount / nominal value * 100), not a market-price dividend yield.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesTokenBel internal identifier: opaque hexadecimal string, usually 8 characters such as "78c7e502"; despite uuid field/tool names, it is not an RFC UUID and normally has no hyphens. Share id, usually discovered via search_by_ticker.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
eventsYes
tickerYes
summaryYes
currencyYes
share_uuidYesTokenBel internal identifier: opaque hexadecimal string, usually 8 characters such as "78c7e502"; despite uuid field names, it is not an RFC UUID and normally has no hyphens.
nominal_valueYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed18 schema fields changed
    • removedOutput schema / properties / currency / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / currency / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / nominal_value / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / nominal_value / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / summary / properties / avg_amount_per_share / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / summary / properties / avg_amount_per_share / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / summary / properties / dividend_yield_pct / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / summary / properties / dividend_yield_pct / type
      Added value: +[
      +  "number",
      +  "null"
      +]
    • removedOutput schema / properties / summary / properties / first_payment_date / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / summary / properties / first_payment_date / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / summary / properties / last_payment_date / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / summary / properties / last_payment_date / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / summary / properties / max_amount_per_share / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / summary / properties / max_amount_per_share / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / summary / properties / min_amount_per_share / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / summary / properties / min_amount_per_share / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / ticker / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / ticker / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed2 schema fields changed
    • changedInput schema / properties / uuid / description
      Previous value: -"Share UUID (8-36 hex characters), usually discovered via search_by_ticker"New value: +"TokenBel internal identifier: opaque hexadecimal string, usually 8 characters such as \"78c7e502\"; despite uuid field/tool names, it is not an RFC UUID and normally has no hyphens. Share id, usually discovered via search_by_ticker."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "currency": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "events": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "amount_per_share": {
      +            "type": "string"
      +          },
      +          "decision_date": {
      +            "type": "string"
      +          },
      +          "is_frozen": {
      +            "type": "boolean"
      +          },
      +          "payment_date": {
      +            "type": "string"
      +          },
      +          "period_number": {
      +            "type": "number"
      +          },
      +          "period_type": {
      +            "type": "string"
      +          },
      +          "period_year": {
      +            "type": "number"
      +          },
      +          "record_date": {
      +            "type": "string"
      +          },
      +          "status": {
      +            "type": "string"
      +          },
      +          "value_source": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "period_year",
      +          "period_type",
      +          "period_number",
      +          "amount_per_share",
      +          "decision_date",
      +          "record_date",
      +          "payment_date",
      +          "value_source",
      +          "is_frozen",
      +          "status"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "nominal_value": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "share_uuid": {
      +      "description": "TokenBel internal identifier: opaque hexadecimal string, usually 8 characters such as \"78c7e502\"; despite uuid field names, it is not an RFC UUID and normally has no hyphens.",
      +      "type": "string"
      +    },
      +    "summary": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "avg_amount_per_share": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "cancelled_count": {
      +          "type": "number"
      +        },
      +        "declared_count": {
      +          "type": "number"
      +        },
      +        "dividend_yield_pct": {
      +          "anyOf": [
      +            {
      +              "type": "number"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "first_payment_date": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "last_payment_date": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "max_amount_per_share": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "min_amount_per_share": {
      +          "anyOf": [
      +            {
      +              "type": "string"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "no_dividend_count": {
      +          "type": "number"
      +        },
      +        "total_amount_per_share": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "declared_count",
      +        "no_dividend_count",
      +        "cancelled_count",
      +        "total_amount_per_share",
      +        "max_amount_per_share",
      +        "min_amount_per_share",
      +        "avg_amount_per_share",
      +        "last_payment_date",
      +        "first_payment_date",
      +        "dividend_yield_pct"
      +      ],
      +      "type": "object"
      +    },
      +    "ticker": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    }
      +  },
      +  "required": [
      +    "share_uuid",
      +    "ticker",
      +    "currency",
      +    "nominal_value",
      +    "events",
      +    "summary"
      +  ],
      +  "type": "object"
      +}
  3. Added

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint and idempotentHint, so safety is covered. The description adds substantial domain behavior instead: period_type enumeration, the meaning of each status (declared/no_dividend/cancelled), that summary totals count only declared events, and that dividend_yield_pct is a nominal proxy rather than a market yield. That is meaningful context, though it says nothing about return volume, pagination, or rate limits.

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 followed by prerequisite and then domain semantics; every sentence carries information with no filler. The single long sentence on status meanings is dense but earned.

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 single-parameter read tool with an output schema and full annotations, the definition supplies exactly the missing layer: interpretation of derived fields (summary totals, proxy dividend_yield_pct) and categorical value meanings. Nothing an agent needs to invoke it correctly is absent.

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%, so the schema already documents uuid as an opaque hex share id normally discovered via search_by_ticker. The description reinforces the same point ('field name: uuid') but adds no new syntax or format information, so the baseline of 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?

States a specific verb and resource ('Get dividend/payout history and an aggregate summary for a single share') and pins the identifier to a named field (uuid), which cleanly separates it from share_get_by_uuid and share_list.

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?

Explicitly names the prerequisite/alternative tool and the workflow: 'Use search_by_ticker to find a share, then call this tool with the returned uuid value.' An agent knows exactly how to obtain the required input without inference.

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.

Resources