Skip to content

usm/mcp-summary

MCP summary tool — returns a quick summary of a .usm file with id, type, version, summary, and type-specific counts.

Intent

Agents need a lightweight overview of a .usm file without reading the full content. Summary returns just the key metadata — id, type, version, summary, and counts (features, services, flows, contracts, tests) — for rapid triage.

Flows

Get file summary (get-summary)

Agent gets a quick summary of a .usm file

  1. get → file path
  2. parse → extract metadata and counts
  3. observe → summary result with type-specific fields

Contracts

summary-lightweight

Summary must return only metadata — not the full file content

Acceptance criteria:

  • [ ] Includes id, type, version, last_updated, summary
  • [ ] System files include featureCount, serviceCount
  • [ ] Feature files include flowCount, contractCount, testCount
  • [ ] Service files include runtime, port, depends_on

Tests

summary-feature

Given:

  • valid_feature_usm: true

Then:

  • assertion: response includes flowCount, contractCount, testCount
  • assertion: response does not include full flows/contracts data

Implementation

  • Primary: src/mcp/summary.ts
  • Test code status: none

See Also

  • usm/mcp-read