Skip to main content
Glama

Get Request

xbrush_get_request
Read-onlyIdempotent

Retrieve the status and result of an XBrush API request using its request ID to check async operations like image edits or video generation.

Instructions

Get the status and result of an XBrush API request. Use this to check the result of async operations (image edit, video generate, etc.).

Args: request_id (string, required): Request ID starting with 'req'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_idYesRequest ID (starts with 'req', 24 characters).
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior, so the bar is lower. The description adds the async-operation context, which is useful, but it doesn't disclose behaviors like response format, error handling for unknown request IDs, or whether it polls or returns immediately. This goes slightly beyond annotations but not by much.

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 brief and front-loaded with the purpose, followed by a clear usage note. The 'Args:' section is redundant with the schema, but it doesn't bloat the description. Overall, it is concise and easy to scan.

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

Completeness3/5

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

With no output schema, the description should clarify what 'status and result' means in terms of return value. It doesn't describe the structure or possible states (e.g., pending, completed, error), which is a gap for an async polling tool. However, the tool is simple and the annotations cover safety, so the description is minimally adequate but not complete.

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%, with the parameter already described as 'Request ID (starts with 'req', 24 characters)'. The description repeats this requirement ('starts with 'req'') without adding new meaning. Baseline 3 is appropriate since the schema handles parameter documentation.

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 uses a specific verb ('Get') and resource ('status and result of an XBrush API request'), making the tool's function clear. It also distinguishes it from sibling tools by noting it checks async operations like image edit and video generate, which differentiates it from list_requests or generation tools.

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?

The description explicitly states to use this tool to check the result of async operations, providing clear context. It doesn't explicitly mention alternatives like list_requests, but the use case is well-defined and implies when this tool is appropriate.

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/lweight/xbrush-api-mcp'

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