Skip to main content
Glama

Get work request

upkeep_get_request
Read-only

One work request by id with its form fields and, once approved, the linked work order id. GET /requests/{id}.

Input Schema

NameRequiredDescriptionDefault
request_idYesUpKeep request id (a short string such as "HW2I379ErS").

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description still adds real value by disclosing return semantics, notably that the linked work order id exists only 'once approved', telling the agent the field can be absent — context the annotations cannot convey.

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?

One compact sentence front-loads the resource and scope before listing payload contents, followed by the endpoint. No filler.

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?

With no output schema, the description does a good job sketching the return shape (form fields, conditional work order id) for a tool signature this simple. Minor gaps remain: nothing on not-found behavior or whether form fields are always present, but nothing essential to calling it is missing.

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 coverage is 100% and the schema documents request_id with an example format, so the parameter burden is already handled. The description only repeats 'by id' and adds no format or lookup guidance beyond the schema. Baseline 3 applies.

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?

States a specific verb (get), resource (work request), and scope (one by id), plus what the payload contains: form fields and the linked work order id. That distinguishes it from upkeep_list_requests and from upkeep_get_work_order without needing the schema.

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

Usage Guidelines3/5

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

The 'by id' phrasing implies this is the single-record lookup, but it never states when to use it over upkeep_list_requests, nor that you need an id obtained elsewhere. Usage is inferable rather than stated.

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.