Microservice.MD

Get a generated file

get_artifact

Read-only

Get one generated file of any type, by a path from list_artifacts. Use it for this service's contracts, and also for a dependency's contracts (its asyncapi.yaml or openapi.yaml) before writing code that calls or consumes it. 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>",
      "path": "<path>"
    },
    "name": "get_artifact"
  }
}

Input Schema

Name	Required	Description
`path`	Yes	A file path from list_artifacts, for example `openapi.yaml` or `proto/service.proto`. Any other path returns an error.
`version`	No	A saved version number. Defaults to the last saved version. A version that doesn't exist returns an error.
`service_id`	Yes	The service's catalog ID, from the repo's Catalog ID: line or from list_services.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedNov 9, 2026

changedInput schema / properties / path / description

Previous value: -"A file path from list_artifacts, for example `openapi.yaml` or `proto/service.proto`."New value: +"A file path from list_artifacts, for example `openapi.yaml` or `proto/service.proto`. Any other path returns an error."

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."

First observedNov 9, 2026

TDQS

A4/5.0

Behavior4/5

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

Annotations already mark the tool read-only, non-destructive, and closed-world. The description adds useful behavior: invalid paths return errors, and hasDraftChanges means unsaved microservice.md edits are omitted, which an agent would not know from annotations alone.

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?

Three short sentences, front-loaded with purpose, followed by usage guidance and an important draft-edit caveat. No wording is redundant or 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?

For a read-only file retrieval tool with full schema coverage and annotations, the definition covers path provenance, intended use, and a draft-edit caveat. It could say slightly more about returned file content, but the absence of an output schema is partly mitigated by the clear 'generated file' framing.

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 path, version, and service_id are already documented in the input schema. The description reinforces that path comes from list_artifacts and mentions intended contract file types, but adds little parameter-level detail beyond the schema.

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?

The description states a specific verb and resource: retrieve one generated file by path, with paths coming from list_artifacts. It also narrows usage to service and dependency contracts, though it does not explicitly contrast with get_service_md beyond the draft-edit caveat.

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?

It gives clear when-to-use guidance: use for this service's contracts or a dependency's asyncapi.yaml/openapi.yaml before writing code that calls or consumes it. It also says the path must come from list_artifacts, but it does not state explicit exclusions or alternatives.

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

All Microservice.MD tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?