Skip to main content
Glama

Get a data service

get_service
Read-only

One data service by id, with its state and — when it is not active — the reason. Poll this after create_service: a new service is provisioning until its certificate is issued and verified, and if that stalls the reason here is what says so. No credentials: none is returned by any tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
service_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds real behavioral context beyond that: the meaning of the returned state, why a non-active service carries a reason, and that no credentials appear in the result.

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, front-loaded with the return shape before the polling guidance. The em-dash interruption is slightly awkward but no sentence is wasted.

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 correctly compensates by describing the return (state + non-active reason) and the lifecycle semantics. Only the parameter's origin/format remains undocumented.

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?

The single parameter service_id has 0% schema description coverage, so the description carries the burden. 'One data service by id' conveys that the parameter is the service identifier, but adds no format, source, or lookup guidance (e.g., where to get the id from).

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 and resource ('One data service by id') and immediately scopes what is returned (its state, plus the failure reason when not active). This clearly separates it from list_services and the other get_* siblings.

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?

Names the trigger explicitly ('Poll this after create_service'), explains the expected lifecycle ('provisioning until its certificate is issued and verified'), and says what to do when it stalls. It also preempts a likely follow-up question by stating no credentials are returned by any tool.

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.