Skip to main content
Glama

TokenBel Financial Data

share_payouts_get

Read-onlyIdempotent

Get a share's dividend events and declared-payout summary. dividend_yield_pct uses nominal value, not market price; no_dividend/cancelled events are excluded from money totals. Example: {"uuid":"a97f1fed"}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidYesTokenBel id (usually 8 hex chars, no hyphens; not an RFC UUID). Share id from 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. Changed1 schema field changed
    • changedInput schema / properties / uuid / description
      Previous 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."New value: +"TokenBel id (usually 8 hex chars, no hyphens; not an RFC UUID). Share id from search_by_ticker."
  2. 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"
      +]
  3. 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"
      +}
  4. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true, so safety is covered. The description goes beyond by revealing that dividend_yield_pct uses nominal value rather than market price and that no_dividend/cancelled events are excluded from money totals. This adds meaningful behavioral context not present in annotations or schema.

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?

Two sentences plus an example achieve maximum clarity with zero fluff. The core purpose is front-loaded, followed by key behavioral nuances, and the example is compact. Every sentence earns its place.

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 simple one-parameter tool with a declared read-only/idempotent profile and an output schema present, the description is complete. It covers what the tool returns (events and summary), key calculation details, and exclusions. Nothing an agent needs to decide whether to call it is missing.

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 coverage is 100% with the uuid parameter fully described. The description adds an example ('a97f1fed') that clarifies the expected format, which is helpful but not essential. It does not introduce new parameter semantics beyond the schema, so baseline 3 is appropriate.

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 clearly states the tool's function: 'Get a share's dividend events and declared-payout summary.' This specifies the verb (get), resource (share's dividend events) and distinguishes it from generic share tools (e.g., share_get_by_uuid) by focusing on payout-related data. The example UUID adds clarity without ambiguity.

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

Usage Guidelines3/5

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

The description implies usage for retrieving dividend/payout information but does not explicitly mention when to prefer this tool over alternatives like share_get_by_uuid or share_list. No exclusion criteria or comparative guidance is provided. While the purpose is clear, the description lacks explicit guidance on scenario-based selection.

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