Skip to main content
Glama

middleware_get_transaction

Read-only

Middleware admin only: read a middleware transaction's status and result by transaction_id. succeeded confirms completion; pending_provider, outcome_unknown and manual_review must not trigger a duplicate order. Authcodes require middleware_get_transaction_secret.

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": {
      "transaction_id": "<transaction_id>"
    },
    "name": "middleware_get_transaction"
  }
}

Input Schema

NameRequiredDescriptionDefault
customer_idNo
transaction_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / customer_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Customer Id"
      +}
  2. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds value beyond them: an admin-only access precondition, an interpretation map for the status field, and a safety warning against re-submitting on indeterminate statuses. It does not cover rate limits, pagination, or retention/visibility of older transactions, so it is not exhaustive.

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?

Three tight sentences with the access restriction front-loaded, then the action, then the safety-critical status semantics and the related-tool pointer. No filler, though the phrasing 'read a middleware transaction's status and result by transaction_id' is slightly redundant with the tool name.

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?

An output schema exists, so return shape need not be restated, and the description covers the things that schema cannot: admin prerequisite, status interpretation, duplicate-order hazard, and the companion secret tool. The only real gap is the undocumented customer_id parameter, which is minor given the output schema and annotations carry the rest.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry the parameter burden, but it only implies what transaction_id means. The optional customer_id parameter is never mentioned at all, leaving the agent to guess whether it scopes the lookup, is a cross-check, or is ignored. It also adds no format details (length, prefix, case) for transaction_id.

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?

States a specific verb and resource ('read a middleware transaction's status and result') and pins the lookup key ('by transaction_id'), which separates it from the list-style sibling middleware_list_transactions without naming it. It also front-loads an audience constraint ('Middleware admin only'). It stops short of an explicit contrast with siblings, keeping it at 4 rather than 5.

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 concrete consumption rules: 'succeeded confirms completion' while pending_provider, outcome_unknown and manual_review 'must not trigger a duplicate order' — that is real when/when-not guidance an agent can act on. It also routes authcode retrieval to middleware_get_transaction_secret, a named alternative. No exclusions beyond that routing, so 4.

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.