Skip to main content
Glama

status

Check payment or charge status using a correlation ID to verify transaction completion and details.

Instructions

Check payment or charge status by correlation ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPayment or charge correlation ID
providerNoProvider that handled the transaction

Implementation Reference

  • The `status` method in `WooviProvider` fetches the status of a charge from the Woovi API and returns a `StatusResult`.
    async status(id: string): Promise<StatusResult> {
      const raw = await this.request(
        "GET",
        `/charge/${encodeURIComponent(id)}`
      );
    
      const data = WooviChargeResponse.parse(raw);
    
      return {
        id,
        status: data.charge.status ?? "UNKNOWN",
        provider: this.name,
        amount: data.charge.value ?? 0,
        currency: "BRL",
        timestamp: data.charge.updatedAt ?? new Date().toISOString(),
      };
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It fails to mention error handling (e.g., invalid ID), whether this requires specific permissions, what status values are returned, or if the operation is idempotent/safe. The word 'Check' implies read-only but doesn't confirm it.

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?

The description is a single, efficient sentence of eight words with the action verb front-loaded. There is no redundant or wasted language; every word contributes to understanding the tool's function.

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?

Given the simple 2-parameter input schema with no output schema, the description is minimally adequate. However, it could be improved by describing the expected return value (status values, transaction details) or behavior when the ID is not found, especially since no output schema exists to document this.

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?

With 100% schema description coverage, the baseline is 3. The description mentions 'correlation ID' which aligns with the 'id' parameter description in the schema, but adds no additional semantic context (e.g., format, where to obtain it) beyond what the schema already provides for either parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses the specific verb 'Check' with the resource 'payment or charge status' and identifies the lookup key 'correlation ID'. It implicitly distinguishes from action-oriented siblings like 'charge', 'pay', and 'refund' by being a read operation, though it doesn't explicitly contrast with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit guidance on when to use this tool versus alternatives. While the correlation ID requirement implies use for existing transactions (vs. creating new ones via 'charge' or 'pay'), there is no explicit 'when-to-use' or mention of prerequisites like obtaining the ID from a prior call.

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/vrllrv/junto-mcp'

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