Skip to main content
Glama
Octav API MCP Server

Octav API MCP Server

Official
by Octav-Labs

Get Virtual Users Portfolio

octav_get_virtual_users_portfolio
Read-only

Retrieve portfolio data for virtual users via virtual: addresses, optionally aggregated into one combined portfolio.

Instructions

Get portfolios for virtual users, using the virtual: addresses from octav_list_virtual_users. Same shape as octav_get_portfolio; set aggregated for one combined portfolio. Waits for a fresh sync by default. Requires Pro. Costs 1 credit per address.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "addresses": "<addresses>"
    },
    "name": "octav_get_virtual_users_portfolio"
  }
}

Input Schema

NameRequiredDescriptionDefault
addressesYesVirtual user addresses (virtual:<id>). Max 50 addresses.
aggregatedNoReturn one portfolio aggregated across all the virtual users (default: false)
waitForSyncNoWait for a fresh sync when cached data is stale (default: true). Set false to return cached data immediately.
includeExplorerUrlsNoInclude blockchain explorer URLs for assets and transactions (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • changedInput schema / properties / addresses / description
      Previous value: -"Virtual user addresses (virtual:<id>). Max 10 addresses."New value: +"Virtual user addresses (virtual:<id>). Max 50 addresses."
    • changedInput schema / properties / addresses / maxItems
      Previous value: -10New value: +50
  2. Addedv1.2.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already mark this read-only, non-destructive and open-world, so the safety profile is covered. The description adds genuinely non-schema behavior: the Pro entitlement requirement and the per-address credit cost. The sync-wait note is useful but largely duplicates the waitForSync parameter description.

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?

Four compact clauses, front-loaded with the core action, then the address source, then the aggregation behavior, then the cost/eligibility constraints. No filler or redundancy.

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 four-parameter read tool with full schema coverage, annotations, and no output schema, the description covers inputs, cost, eligibility, and return shape (via the octav_get_portfolio reference). Nothing needed to call it correctly 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%, so all four parameters are documented in structured data. The description restates the aggregated and sync defaults rather than adding syntax or constraints; the only marginal addition is the provenance of addresses from octav_list_virtual_users. 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?

States a specific verb and resource ('Get portfolios for virtual users') and immediately distinguishes it from the sibling octav_get_portfolio by noting it returns the 'Same shape'. An agent can tell exactly what it retrieves without opening the schema.

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?

Gives clear preconditions: addresses must be virtual:<id> values obtained from octav_list_virtual_users, Pro is required, and each address costs 1 credit. It also explains the aggregated flag's purpose, though it never states when to prefer octav_get_portfolio over this tool.

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