Skip to main content

​
Overview

Get a 360-degree view of an artifact: its definition, all upstream/downstream connections, code references, test references, commit references, and coverage gaps. Essential before modifying any artifact. This tool provides the most comprehensive view of a single artifact, including all its relationships, implementation details, and traceability gaps.

​
Parameters

​
artifact_id
string
required
The artifact ID (e.g. REQ-AUTH-001, UC-003, TASK-F01-003)

​
Response

​
artifact
object
Core artifact information
​
id
string
Artifact ID
​
type
string
Artifact type (REQ, UC, BDD, etc.)
​
category
string
Artifact category
​
title
string
Artifact title
​
file
string
Source file path
​
line
number
Line number in source file
​
priority
string
Priority level
​
stage
string
Pipeline stage
​
classification
object
Business and technical classification
​
coverageStatus
enum
Overall traceability status:
  • Complete - Has UC, BDD, code, and tests
  • In Progress - Has UC and either code or tests
  • Specified - Has UC only
  • Not Started - Missing UC
​
upstream
array
Relationships where this artifact is the source
​
id
string
Target artifact ID
​
type
string
Target artifact type
​
title
string
Target artifact title
​
relationship
string
Relationship type (e.g. “implements”, “depends_on”)
​
file
string
Source file where relationship is defined
​
downstream
array
Relationships where this artifact is the target
​
id
string
Source artifact ID
​
type
string
Source artifact type
​
title
string
Source artifact title
​
relationship
string
Relationship type
​
file
string
Source file where relationship is defined
​
codeRefs
array
Code implementation references
​
file
string
Code file path
​
symbol
string
Symbol name (function, class, etc.)
​
symbolType
string
Type of symbol
​
line
number
Line number
​
testRefs
array
Test references
​
file
string
Test file path
​
testName
string
Test name
​
line
number
Line number
​
commitRefs
array
Git commit references
​
sha
string
Commit SHA
​
message
string
Commit message
​
taskId
string
Associated task ID
​
gaps
string[]
Identified coverage gaps:
  • ORPHAN - No relationships found
  • MISSING_UC - No use case implements this requirement
  • MISSING_BDD - No BDD scenario verifies this requirement
  • MISSING_TASK - No task decomposes this requirement
  • MISSING_CODE - No code references found
  • MISSING_TESTS - No test references found
  • MISSING_COMMITS - No commit references found
​
codeIntelligence
object
Code intelligence enrichment (when available)
​
symbols
array
Related code symbols
​
name
string
Symbol name
​
type
string
Symbol type
​
file
string
File path
​
lines
string
Line range (e.g. “10-25”)
​
callers
string[]
Functions that call this symbol
​
callees
string[]
Functions called by this symbol
​
isInferred
boolean
Whether reference was inferred
​
processes
array
Related business processes
​
name
string
Process name
​
steps
string[]
Process steps
​
entryPoint
string
Entry point function

​
Gap detection for requirements

For REQ artifacts, the tool automatically detects:
  • ORPHAN: No relationships found — the requirement is isolated
  • MISSING_UC: No use case implements this requirement
  • MISSING_BDD: No BDD scenario verifies this requirement
  • MISSING_TASK: No task decomposes this requirement
  • MISSING_CODE: No code references found
  • MISSING_TESTS: No test references found
  • MISSING_COMMITS: No commit references found

​
Examples

​
Get complete context for a requirement

{
  "artifact_id": "REQ-AUTH-001"
}

​
Check implementation status of a use case

{
  "artifact_id": "UC-LOGIN-003"
}

​
Verify task completion

{
  "artifact_id": "TASK-F01-005"
}

​
TypeScript types

interface ContextArgs {
  artifact_id: string;
}

type CoverageStatus = "Complete" | "In Progress" | "Specified" | "Not Started";

interface ArtifactContext {
  artifact: {
    id: string;
    type: string;
    category?: string;
    title: string;
    file: string;
    line: number;
    priority?: string;
    stage?: string;
    classification?: Record<string, unknown>;
  };
  coverageStatus: CoverageStatus;
  upstream: Array<Relationship>;
  downstream: Array<Relationship>;
  codeRefs: Array<CodeRef>;
  testRefs: Array<TestRef>;
  commitRefs: Array<CommitRef>;
  gaps: string[];
  codeIntelligence?: Record<string, unknown>;
}

​
See also

Build docs developers (and LLMs) love

Get started for freeTalk to us