Skip to main content
Resources provide structured, low-token snapshots of your codebase. Unlike tools (which perform actions), resources are read-only data endpoints that agents can access to understand the codebase structure.

​
Why Resources?

Resources are optimized for AI agent navigation:
  • Lightweight: 100-500 tokens per resource
  • Cacheable: Agents can reference them repeatedly
  • Structured: YAML format for consistent parsing
  • On-demand: Only fetched when needed

​
Resource Types

​
Global Resources

These resources don’t require a repository context:

gitnexus://repos

List all indexed repositories with stats. Read this first to discover available repos.

​
Repository Resources

These resources are scoped to a specific repository using the pattern gitnexus://repo/{name}/...:

context

Codebase stats, staleness check, and available tools

clusters

All functional areas (modules) with cohesion scores

processes

All execution flows detected in the codebase

​
Detail Resources

These provide deep-dives into specific clusters or processes:

cluster/{name}

Members and details of a specific functional area

process/{name}

Step-by-step trace of a specific execution flow

​
Workflow

Typical agent workflow using resources:
  1. Discovery: Read gitnexus://repos to see all indexed repositories
  2. Overview: Read gitnexus://repo/{name}/context to check stats and staleness
  3. Navigation: Read clusters or processes to find areas of interest
  4. Deep Dive: Read specific cluster/{name} or process/{name} for details
  5. Action: Use tools like query, context, or impact for analysis

​
Resource URIs

All GitNexus resources use the gitnexus:// URI scheme: 
gitnexus://repos                              # Global
gitnexus://repo/{name}/context                # Repo-scoped
gitnexus://repo/{name}/clusters               # Repo-scoped
gitnexus://repo/{name}/cluster/{clusterName}  # Detail
gitnexus://repo/{name}/processes              # Repo-scoped
gitnexus://repo/{name}/process/{processName}  # Detail
gitnexus://repo/{name}/schema                 # Cypher schema

​
MIME Types

All resources return one of two MIME types:
  • text/yaml — Structured data (most resources)
  • text/markdown — Documentation content

​
Next Steps

Repos Resource

Start here to discover indexed repositories

MCP Tools

See available tools for analysis and navigation

Build docs developers (and LLMs) love

Get started for freeTalk to us