Skip to content

anismabaziz/saurix

Repository files navigation

Saurix

PyPI version Python versions License: MIT Downloads

Saurix is an interactive knowledge graph engine that transforms complex codebases into a queryable, 3D-visualizable map. It is designed to be the Symbolic Intelligence Layer for modern AI coding agents.

Why Saurix for AI Agents?

Saurix solves the "Context Window" problem for LLMs by providing a structured representation of code that is superior to keyword search:

  • Structural Awareness: Understands CALLS, INHERITS, and IMPORTS relationships rather than just raw text.
  • Context Efficiency: Agents can query specific subgraphs, receiving only the architectural context they need, drastically reducing token usage.
  • Blast Radius Analysis: Built-in impact analysis allows agents to calculate the transitive side effects of a proposed change before making it.
  • Native MCP Support: Built on the Model Context Protocol, allowing AI agents to treat the repository graph as an extension of their own memory.

See docs/agent-lifecycle.md for a step-by-step walkthrough of how an AI agent uses these capabilities.


1) Core Mission

  • Knowledge Extraction: Turn local or GitHub repositories into a structured graph of symbols and relationships.
  • Agent Infrastructure: Expose high-level tools (MCP) for autonomous agents to navigate complex architectures.
  • Fast Navigation: Answer questions about dependencies, callers, and impact analysis in milliseconds.
  • Modular Architecture: Built for extensibility across languages and tools.

2) Architecture

Saurix follows a clean, domain-driven modular structure designed for scale and symbolic intelligence. For a detailed breakdown of how Saurix indexes, stores, and queries code, see docs/architecture.md.


Setup & Installation

  1. Install Saurix:
    pip install saurix
  2. Initialize Any Project:
    cd /path/to/your/project
    saurix init
    This command indexes your project, creates a local 3D dashboard (saurix.html), and generates your MCP config in one step.

Running the MCP Server

Expose graph tools to AI agents (e.g., Claude Desktop, Cursor):

saurix-mcp

4) Interactive Commands

Command Description
init Zero-config setup for the current project
index <source> Index a local path or GitHub URL
stats Show graph statistics and extraction coverage
find <query> Fuzzy search symbols by name or ID
callers <sym> List symbols calling the target
path <A> <B> Find shortest directed path between two symbols
impact <sym> Estimate blast radius of a change
visual Generate a hybrid 2D/3D knowledge graph visualization
export Export to GraphML or Neo4j CSV

5) AI Agent Integration (MCP)

Saurix is optimized for agentic workflows. It exposes tools that help agents understand:

  1. Context Discovery: find_symbol and related_files.
  2. Behavioral Mapping: callers and path_between.
  3. Risk Assessment: impact_of_symbol.

Configure your agent with the saurix-mcp entry point. Once configured, the AI client (e.g., Claude Desktop) will automatically manage the server lifecycle—starting it in the background when needed and stopping it when the app closes. No manual terminal execution is required.


6) Development

Running Tests

uv run pytest

Testing the MCP Server

You can test the MCP integration without a full IDE using the MCP Inspector:

  1. Install the Inspector: npm install -g @modelcontextprotocol/inspector
  2. Run the Server: npx @modelcontextprotocol/inspector uv run saurix-mcp
  3. Interact: Open http://localhost:5173, click Connect, and use the Call Tool tab.

For step-by-step setup (Claude Desktop, Cursor, OpenCode), simply run saurix init in your project folder.


Saurix is built for the era of autonomous coding.

About

Interactive CLI that turns polyglot codebases into queryable knowledge graphs for AI agent code exploration.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages