MCP Integration
RTMify Live exposes a local Model Context Protocol server over HTTP. An MCP-connected assistant can query requirements, tests, risks, code evidence, verification state, Design BOMs, and SOUP/software inventory without scraping the dashboard or reading the source spreadsheets directly.
What this means in practice
The assistant is querying the Live graph, so BOM answers can traverse Products, DesignBOMs, BOMItems, requirements, tests, test groups, source-code annotations, and execution evidence in one model.
Endpoint
POST http://127.0.0.1:<port>/mcp GET http://127.0.0.1:<port>/mcp (SSE discovery for legacy clients) The dashboard Guide → MCP & AI tab shows the exact endpoint, current port, API token, and inbox directory for your running instance.
Resources
Resources are named graph objects an assistant can fetch directly.
requirement://<id> Full requirement detail with links, status, and annotations
gap://<code>/<node_id> A specific gap condition and the affected node
design-history://<id> Design-history narrative for a requirement
impact://<id> Upstream and downstream impact chain for a node
design-bom://<full_product_identifier>/<bom_name> Design BOM markdown summary, coverage, and unresolved refs
software-boms:// Software BOM and SOUP register inventory across the active workbook
soup-components://<full_product_identifier>/<bom_name> SOUP register markdown view with anomaly text, safety class, and trace coverage
bom-item://<full_product_identifier>/<bom_type>/<bom_name>/<part>@<revision> One BOM item drill-down with resolved and unresolved trace refs
Design BOM tools
These tools are the main MCP affordances for product-structure and BOM traceability work.
| Tool | What it returns |
|---|---|
| get_bom | One hierarchical Design BOM tree for a product and bom_name |
| get_bom_item | One BOMItem with parent chains, linked requirements, linked tests, and unresolved declared refs |
| list_design_boms | BOM inventory with product, type, source format, ingest timestamp, item count, and warnings |
| find_part_usage | Where-used lookup for a part across products, Design BOMs, and parent assemblies |
| bom_gaps | BOM items with unresolved requirement/test refs or other no-link conditions |
| bom_impact_analysis | Coverage and linked-node context for one Design BOM |
The general RTM, gap, status, review, code-traceability, and design-history tools remain available alongside these BOM-specific surfaces.
SOUP tools
These tools expose software DesignBOMs and manual SOUP registers without forcing the assistant to infer them from generic BOM queries alone.
| Tool | What it returns |
|---|---|
| list_software_boms | Software Design BOM and SOUP register inventory with source format, ingest timestamp, item count, and warnings |
| get_soup_components | Flattened SOUP component rows with safety class, anomaly text, unresolved refs, and SOUP statuses |
| soup_by_safety_class | Software components for one product filtered by safety_class |
| soup_by_license | Software components filtered by product and/or license substring |
Prompts
Prompts guide an assistant toward the right combination of tools and resources.
trace_requirement Trace one requirement through the graph
impact_of_change Change-impact workflow for one node
explain_gap Human-readable explanation of a gap code
audit_readiness_summary Overall readiness summary
design_history_summary Requirement design-history narrative
inspect_bom_item_traceability Guided entrypoint for one BOM item’s linked and unresolved refs
eol_impact End-of-life impact workflow for a part
bom_coverage Design BOM coverage and unresolved-ref summary
component_substitute Traceability and verification exposure for a substitute part
soup_audit_prep SOUP anomaly, linkage, and audit-readiness summary
soup_coverage SOUP traceability, safety-class, and license coverage summary
Connection info
The dashboard Guide → MCP & AI tab shows the current endpoint URL, API token, inbox directory path, and token regeneration controls.
Claude Desktop / Claude Code
{
"mcpServers": {
"rtmify": {
"url": "http://127.0.0.1:8000/mcp"
}
}
} Cursor
http://127.0.0.1:8000/mcp
Local-only by design
The Live MCP endpoint binds to 127.0.0.1. It is same-machine only and is not exposed as a public internet MCP server.