Skip to content

Package map

Browse every package by responsibility. Each guide identifies key source files, change boundaries, and neighboring modules. These are maintenance boundaries, not independently running services or installable npm workspaces.

Find the right layer

Looking for Start here
Bot prompts, tools, and capabilities grok-bot-harness
Inference and tool iterations agent
Tool calls reaching an execution environment agent-exec → local-exec → shell-exec
Local model, web, speech, and plugin adapters Harness src/local
Application startup, Gateway, persistence src/host, outside packages

Browse by responsibility

Agent and inference

Package Responsibility
agent Generic Agent state, interaction handling, tool orchestration, and context processing.
agent-client Connects to an Agent, drives turns, and detects stalled interactions.
agent-core Shared interaction queries, updates, listeners, and goal continuation.
agent-summarization Prepares summary input, manages context budgets, and coordinates background summaries and durable content.
chat-inference Prompt execution abstractions and middleware for images, reasoning effort, and tracing.
chat-inference-proto Model clients and protocol conversion between prompt execution and the retained inference protocol.
grok-bot-harness Composes Agent, prompts, tools, memory, and service ports into the Bot task runner.
grok-bot-voice-call-harness Voice-call tool definitions, RPC harness, and wire protocol.

Execution and permissions

Package Responsibility
agent-exec Agent-facing interfaces for files, shell, MCP, subagents, and background work.
local-exec Concrete file, shell, MCP, screenshot, and computer-use implementations for an execution environment.
shell-exec Shell processes, output limits, environment filtering, and platform sandbox policies.
cursor-config Project and user permission-file providers for execution configuration.

MCP, plugins, and hooks

Package Responsibility
mcp-core MCP connection lifecycle, authentication state machines, reconnection, and service policies.
mcp-agent-exec Loads MCP clients into Agent execution with network, authentication, and approval handling.
cursor-plugins Plugin manifest parsing, component discovery, loading, and variable handling.
hooks Hook data structures, phase mapping, compatibility conversion, and response validation.
hooks-carriers Collects and renders Hook results for Agent, with context size and shape limits.
hooks-exec Integrates Hooks into tool execution, including errors, sandbox handling, and tool phases.

Storage and context

Package Responsibility
agent-kv Agent key-value/blob interfaces, serialization, caching, and retries.
agent-store Retained storage sync subpackage: indexes, locks, conflicts, and remote transport.
agent-transcript Execution trace formats, transcript paths, and context stripping for exports.
context Execution contexts, scoped values, contextual logging, and abort reasons.
context-rpc Connects caller context to resource RPC and streaming results across execution boundaries.

Protocols and foundations

Package Responsibility
proto Retained generated protocols for Agent, tools, services, and related messages.
redacted-protos Protocol-specific redacted representations for diagnostics and restricted data views.
redaction Privacy modes, data classification, redaction schemas, and error conversion.
constants Shared identifiers and constants for tools, conversations, Box, and project behavior.
utils Shared helpers for processes, paths, async streams, caches, images, and repository URLs.
git-core Git subprocess execution and environment construction.
prompt-jsx JSX-style components and rendering for model prompt content.
metrics Shared metric-recording interfaces.

Diagnostics and retained integrations

Package Responsibility
agent-analytics Commit-scoring types and Git repository helpers.
analytics-client Event conversion, buffering, and deferred buffering.
codebase-telemetry Codebase telemetry sessions, controllers, channels, and privacy handling.
canvas-shared Retained Cloud Canvas shared representations and helpers.
grok-bot Small shared Bot presentation and marking helpers.
messages-mac Retained macOS Messages paging, phone-number, and wire helpers.

Build conventions

Most dist/*.js files are maintained release source. Together with recovered .ts fragments, they are assembled through the manifest. Do not delete these dist directories as caches, add per-directory package.json files, or guess missing imports. Strict TypeScript adapters live in Harness src/local and compile through the root build.

Architecture · Development · Source recovery · Project