Skip to main content
Glama

List generated files

list_artifacts
Read-only

List the files microservice.md generates for a service (OpenAPI, AsyncAPI, proto, GraphQL, runbook, ADRs, C4, context pack) from its last saved version (or version). Call it to get the paths for get_artifact. For the MICROSERVICE.md itself, use get_service_md. 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": "list_artifacts"
  }
}

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 the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the description is not carrying that burden. It nonetheless adds real behavioral context beyond them: results come from the last saved version, unsaved edits are excluded, and the agent is told to surface the hasDraftChanges warning to the user. It stops short of describing the response shape or ordering of the returned list, which is the remaining gap.

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 most important clause, what gets listed and from which version, is front-loaded, and every sentence carries a routing or behavioral instruction. The long parenthetical enumeration of artifact types is dense but earns its place by telling the agent what to expect. Slightly packed, but no wasted wording.

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 two-parameter read tool with full schema coverage and annotations already declaring the safety profile, the description covers scope, sibling routing, and the draft-changes caveat. Since there is no output schema, the description should ideally say more about the shape of the returned list (beyond the hint that it yields 'paths'), which keeps it from a 5.

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 version parameter's schema text already states 'Defaults to the last saved version' and that a nonexistent version errors, so the description's '(or `version`)' restates rather than extends the schema. With the schema doing the heavy lifting, the baseline of 3 applies; no extra format or semantic detail is contributed.

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?

The description names a specific verb and resource ('List the files microservice.md generates for a service'), enumerates the artifact kinds covered (OpenAPI, AsyncAPI, proto, GraphQL, runbook, ADRs, C4, context pack), and scopes it to a saved version. It also explicitly separates itself from get_service_md, so an agent can distinguish it from siblings without opening any schema.

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?

It gives an explicit downstream routing rule ('Call it to get the paths for get_artifact') and an explicit exclusion with the correct alternative ('For the MICROSERVICE.md itself, use get_service_md'). It also states a conditional follow-up action for hasDraftChanges, which is genuine when-to-use guidance rather than inference.

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