Skip to main content
Glama

Get Portfolio Summary

paybond_get_portfolio_summary
Read-only

Retrieves a read-only, tenant-scoped Signal portfolio summary with key metrics like operator count, average score, terminal intents, and receipted volume. Use it for portfolio monitoring and review.

Instructions

Use this when you need a read-only, tenant-scoped Signal portfolio aggregate for the authenticated API key (operator_count, average_score, total_terminal_intents, total_receipted_volume_cents, operators_under_review, and checkpoint_last_ledger_seq). Requires PAYBOND_API_KEY with Signal analytics read access and the private-dashboards feature. Do not use this when you need a portable signed operator list for partner or verifier sharing—call paybond_get_signed_portfolio_artifact instead—or for one operator's signed receipt—call paybond_get_reputation_receipt. Idempotent read with no side effects; auth, RBAC, feature, or gateway failures surface as tool errors.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
score_versionNoOptional Signal score model version to query. Omit to use the gateway default current model (1.0). Example: 1.0.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
tenant_idNoTenant echoed by the gateway for the authenticated API key (example: tenant-a).
average_scoreNoAverage operator score across the tenant portfolio for this score model version.
scoring_modelNoScoring model identifier used by Signal for this summary.
operator_countNoNumber of operators with reputation data for this score model version.
schema_versionNoPortfolio summary schema version (currently 1).
score_model_versionNoScore model version used for the aggregate (echoes the requested score_version or the gateway default 1.0).
operators_under_reviewNoCount of operators currently under Signal review for this score model version.
total_terminal_intentsNoAggregate terminal Harbor intents across operators in the portfolio.
checkpoint_last_ledger_seqNoLast ledger sequence included in the tenant Signal checkpoint.
total_receipted_volume_centsNoAggregate receipted settlement volume in cents across the portfolio.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Addedv0.12.12
  2. Removedv0.12.11
  3. Changed15 schema fields changedv0.1.1
    • addedInput schema / properties / score_version / description
      Added value: +"Optional Signal score model version to query. Omit to use the gateway default current model (1.0). Example: 1.0."
    • addedInput schema / properties / score_version / examples
      Added value: +[
      +  "1.0"
      +]
    • addedOutput schema / properties / average_score
      Added value: +{
      +  "description": "Average operator score across the tenant portfolio for this score model version.",
      +  "type": "number"
      +}
    • addedOutput schema / properties / checkpoint_last_ledger_seq
      Added value: +{
      +  "description": "Last ledger sequence included in the tenant Signal checkpoint.",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / operator_count
      Added value: +{
      +  "description": "Number of operators with reputation data for this score model version.",
      +  "type": "integer"
      +}
    • removedOutput schema / properties / operators
      Removed value: -{
      -  "items": {
      -    "additionalProperties": true,
      -    "type": "object"
      -  },
      -  "type": "array"
      -}
    • addedOutput schema / properties / operators_under_review
      Added value: +{
      +  "description": "Count of operators currently under Signal review for this score model version.",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / schema_version
      Added value: +{
      +  "description": "Portfolio summary schema version (currently 1).",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / score_model_version / description
      Added value: +"Score model version used for the aggregate (echoes the requested score_version or the gateway default 1.0)."
    • addedOutput schema / properties / score_model_version / examples
      Added value: +[
      +  "1.0"
      +]
    • addedOutput schema / properties / scoring_model
      Added value: +{
      +  "description": "Scoring model identifier used by Signal for this summary.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / tenant_id / description
      Added value: +"Tenant echoed by the gateway for the authenticated API key (example: tenant-a)."
    • addedOutput schema / properties / tenant_id / examples
      Added value: +[
      +  "tenant-a"
      +]
    • addedOutput schema / properties / total_receipted_volume_cents
      Added value: +{
      +  "description": "Aggregate receipted settlement volume in cents across the portfolio.",
      +  "type": "integer"
      +}
    • addedOutput schema / properties / total_terminal_intents
      Added value: +{
      +  "description": "Aggregate terminal Harbor intents across operators in the portfolio.",
      +  "type": "integer"
      +}
  4. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true; description adds context: the read is idempotent, has no side effects, and errors (auth, RBAC, feature, gateway) surface as tool errors. This goes beyond the annotation.

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?

The description is concise, front-loading purpose and guidelines. It is a single sentence with some density, but every part is necessary. Could be slightly more structured but still effective.

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?

Despite having an output schema (not shown), the description fully covers purpose, usage, requirements, behavioral traits, and parameter details. Sibling tools are numerous but key differentiators are addressed.

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 a single optional parameter. The description mentions the parameter but does not add significant meaning beyond the schema's examples and description. 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 retrieves a 'tenant-scoped Signal portfolio aggregate' and lists specific fields. It distinguishes from sibling tools by explicitly naming when to use alternative tools (paybond_get_signed_portfolio_artifact, paybond_get_reputation_receipt).

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?

The description provides explicit when-to-use and when-not-to-use guidance, naming specific alternative tools. It also states prerequisite requirements (PAYBOND_API_KEY, Signal analytics read access, private-dashboards feature).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nonameuserd/paybond-kit'

If you have feedback or need assistance with the MCP directory API, please join our Discord server