Skip to main content
Glama

Get a service's MICROSERVICE.md

get_service_md
Read-only

Start here when implementing or changing a service. Returns its MICROSERVICE.md from the last saved version (or version). For contracts and other generated files, use list_artifacts. If the repo's MICROSERVICE.md has a Catalog ID: line, use that ID. If hasDraftChanges is true, tell the user there are unsaved edits in microservice.md that are not included.

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": {
      "service_id": "<service_id>"
    },
    "name": "get_service_md"
  }
}

Input Schema

NameRequiredDescriptionDefault
versionNoA saved version number. Defaults to the last saved version. A version that doesn't exist returns an error.
service_idYesThe service's catalog ID, from the repo's **Catalog ID:** line or from list_services.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / service_id / description
      Previous value: -"The service's catalog ID."New value: +"The service's catalog ID, from the repo's **Catalog ID:** line or from list_services."
    • changedInput schema / properties / version / description
      Previous value: -"A saved version number. Defaults to the last saved version."New value: +"A saved version number. Defaults to the last saved version. A version that doesn't exist returns an error."
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover read-only/no-destruction/closed-world, so the description's job is to add operational nuance. It does: content comes from the last saved version, and unsaved draft edits are NOT included, which is a genuinely useful caveat an agent must relay. It stops short of describing the overall response shape.

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?

Front-loaded with the highest-value instruction ('Start here...') and kept to a few tight sentences. The conditional hasDraftChanges instruction is slightly opaque about where that flag comes from, but no sentence is 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 must carry return-value context; it identifies the returned document and surfaces the hasDraftChanges flag, which is the key field for agent behavior. A brief note on the broader response structure would make it complete.

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%, so both parameters are already documented in the schema, including the error behavior for nonexistent versions. The description reinforces where service_id comes from (Catalog ID line or list_services), which is a marginal addition rather than new meaning.

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?

Names a specific verb and resource — returns a service's MICROSERVICE.md — and scopes it to the last saved version or a given version. The first sentence establishes it as the entry point, which cleanly separates it from list_artifacts and get_artifact.

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?

Explicit 'start here when implementing or changing a service' guidance, plus a named alternative for the adjacent case ('For contracts and other generated files, use list_artifacts'). It also routes the agent on how to obtain the service_id and what to do when hasDraftChanges is true.

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.

Resources