Skip to main content
Glama
Sign In

Linked API

by io.github.Linked-API
OverviewDiscussionsAdmin

get_workflow_result

Read-only

Check the current state of a previously started Linked API workflow. Returns the final result when the workflow has completed, otherwise returns the current in-progress snapshot ({status, pendingReason, workflowId, operationName, message}). The server long-polls up to waitSeconds while the workflow is still running; if the budget elapses without completion, the in-progress snapshot is returned and the client should call this tool again with the same workflowId and operationName. Exception: when pendingReason is "outsideWorkingHours" the workflow is parked until the account working hours reopen — the server returns immediately without polling, message states when that is, and calling this tool again before then will report the same state.

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": {
      "workflowId": "<workflowId>",
      "operationName": "<operationName>"
    },
    "name": "get_workflow_result"
  }
}

Input Schema

NameRequiredDescriptionDefault
workflowIdYesRequired. The workflow ID returned by the original Linked API tool call.
waitSecondsNoOptional. Maximum seconds the server should wait for the workflow to complete before returning the current in-progress snapshot. Defaults to the maximum the current MCP client allows; pass 0 to get an immediate one-shot snapshot.
operationNameYesRequired. The operationName returned by the original Linked API tool call. Used to map the response to the right operation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnlyHint and openWorldHint, but the description adds the non-obvious behaviors that matter here: server-side long-polling bounded by waitSeconds, a non-polling short-circuit for off-hours workflows, and the exact snapshot fields returned. An agent knows both the latency profile and the loop-termination rules before calling.

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 purpose and return shape are front-loaded, and the exception is correctly placed last. It is a single dense paragraph; breaking the retry rule and the off-hours exception into separate lines would improve scanability, but no sentence is filler.

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?

There is no output schema, so the description carries the return contract, and it does so by enumerating the snapshot fields and distinguishing completed results from in-progress snapshots. Combined with the polling and off-hours rules, an agent has everything needed to drive this tool to completion.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3 and the schema already defines waitSeconds (including the 0 value). The description adds the correlation semantics — that workflowId and operationName must be carried unchanged across repeated calls, and that operationName is used to map the response — which is meaningful usage context beyond the field text.

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?

Opens with a specific verb and resource: 'Check the current state of a previously started Linked API workflow.' It also names the scope constraint ('previously started') that separates it from workflow-starting siblings like execute_custom_workflow, and states what is returned in both the completed and in-progress cases.

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?

Explicitly describes the polling contract: call, and if the budget elapses, call again with the same workflowId and operationName. It also carves out an exception case (pendingReason 'outsideWorkingHours') where re-calling before reopening is explicitly pointless.

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

All Linked API toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources