Resources · API

API reference.

TraceWorks has live MCP access for AI clients today. Public REST and webhook APIs for PLM, ERP, CI, and bespoke engineering tooling are in active design — request early access if you'd like to shape them.

Status:MCP live · REST/webhooks in design

Integration surfaces

What is live now and what the v1 API will cover

MCP tools

OAuth + MCP

Live today: connect Claude, Cursor, or another MCP client to read and write workspace records through 52 scoped tools.

https://www.traceworks.app/mcp

Tools: listProjects, listRequirements, createRequirement,
createTraceLink, queryProjectContext, getTraceScore, ...

Records

GET / POST / PATCH

Planned public REST surface for reading and writing project artifacts: requirements, specifications, products, components, tasks, risks, decisions, submittals.

GET /v1/projects/:projectId/requirements
?status=APPROVED&type=REGULATORY

Trace links

GET / POST / DELETE

Planned public REST surface for typed traceability links between artifacts. All link writes flow through authorization.

POST /v1/projects/:projectId/trace-links
{
  "sourceType": "Requirement",
  "sourceId":   "req_abc",
  "targetType": "Specification",
  "targetId":   "spec_xyz",
  "kind":       "SATISFIES"
}

Trace Score

GET

Planned REST endpoint for the same computed Trace Score already shown in the workspace and exposed through MCP.

GET /v1/projects/:projectId/trace-score

→ {
  "score": 73,
  "breakdown": [
    { "key": "requirementDefinition", "score": 84, ... }
  ]
}

Webhooks

Outbound

Planned outbound events: requirement approved, change request opened, AI suggestion accepted, trace link created.

POST <your endpoint>
{
  "event":   "requirement.approved",
  "project": "proj_123",
  "actor":   { "userId": "u_456" },
  "data":    { "requirementId": "req_abc" }
}

Want early access?

Tell us what you'd sync and which records matter most. Early-access partners help shape v1.

Request access