Skip to main content
Glama

Tokenbooks - crypto and fiat accounting and payments

Get Report Request Status

get_report_request_status
Read-onlyIdempotent

Check whether report generation is queued, running, failed, or completed using the requestId from request_report_export; use get_request_status for any other background job.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
requestIdYesRequest ID returned by the call that queued the work (e.g. incremental_sync, full_resync, request_report_export)
portfolioRefNoPortfolio exact name or slug
workspaceRefYesWorkspace exact name or slug
transactionIdNoOptional transaction ID that caused the async request, for agent context

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint false, so the safety profile is covered. The description adds the specific status set and report-scope constraint, but does not describe return details or error behavior; with annotations in place, this is acceptable but not exceptional.

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?

A single sentence that front-loads the tool's purpose and statuses, then immediately routes to the right sibling. There is no filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple read-only status-check tool, the description covers what it returns (statuses), where the requestId comes from, and how to route other background-job checks. It does not describe the exact response shape, but there is no output schema and the states are enumerated, making this adequate.

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 every parameter. The description adds a useful hint that requestId comes from request_report_export, but it does not add meaning for the other parameters beyond what the schema provides.

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 states a specific verb and resource: checking whether report generation is queued, running, failed, or completed. It also names the source of the requestId (request_report_export), which clearly distinguishes it from the sibling get_request_status.

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?

It explicitly says to use this tool for report-generation status checks and to use get_request_status for any other background job. This gives the agent a clear decision rule and names the alternative tool directly.

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