Skip to main content
Glama

Get Portfolio Summary

paybond_get_portfolio_summary
Read-only

Retrieve a read-only aggregate of your Signal portfolio, including operator count, average score, total terminal intents, total receipted volume, operators under review, and latest ledger sequence.

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.
Behavior5/5

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

Annotations already declare readOnlyHint=true; description adds that it is idempotent, has no side effects, and can surface auth, RBAC, feature, or gateway failures as tool errors.

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?

Single paragraph with front-loaded purpose, concrete field list, explicit usage guidance, and every sentence adds value. No unnecessary repetition.

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?

Given output schema exists, description fully covers purpose, usage, behavior, authentication, and error conditions. No gaps.

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 provides 100% coverage for the single optional parameter. Description does not add extra parameter semantics beyond what schema states, baseline score of 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 read-only, tenant-scoped Signal portfolio aggregate for the authenticated API key, listing specific fields returned. It distinguishes from siblings like paybond_get_signed_portfolio_artifact and 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?

Explicitly states when to use (need portfolio aggregate) and when not to (for signed operator list or one operator's receipt), with named alternatives. Also specifies requirements like PAYBOND_API_KEY and private-dashboards feature.

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

Install Server

Other Tools

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-python'

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