Namzu Documentation
Entry point for the published Namzu docs covering the SDK, computer-use package, and provider packages.
This directory is the publishable documentation surface for Namzu. It is written for direct use on docs.namzu.ai, covers only packages that are currently shipped, and intentionally excludes local-only or ignored workspace content.
1. Start Here
Use this documentation if you are building on the published Namzu packages:
| Area | Package | What it covers |
|---|---|---|
| Core runtime | @namzu/sdk | Agents, tools, provider registration, runtime building blocks, stores, and extension points |
| Desktop control | @namzu/computer-use | Screenshot, mouse, and keyboard control through a ComputerUseHost |
| Providers | @namzu/* | OpenAI, Anthropic, Bedrock, OpenRouter, HTTP, Ollama, and LM Studio integrations |
Ignored and unpublished workspace areas are intentionally excluded from this docs surface.
2. Documentation Map
| Section | Purpose |
|---|---|
| Getting Started | Choose packages, install them, and make the first successful call |
| SDK Overview | Understand what lives in @namzu/sdk and how its parts fit together |
| SDK Runtime | Runtime map plus IDs, configuration, and low-level execution entrypoints |
| SDK Agents | Agent classes, orchestration, and delegation boundaries |
| SDK Tools | Tool definition, built-in tools, and tool-safety policy |
| SDK Provider Integration | SDK-level provider registry and direct provider operations |
| SDK Prompting | Skills, personas, and prompt composition |
| SDK Retrieval | Knowledge bases, retrieval, and RAG tool exposure |
| SDK Sessions | Project-session-sub-session lifecycle, workspaces, and retention |
| SDK Integrations | Connectors, MCP, plugins, and bridge surfaces |
| SDK Observability | Telemetry and instrumentation surfaces |
| SDK Architecture | Understand the internal folder boundaries and recurring patterns inside @namzu/sdk |
| SDK Quickstart | Run a minimal reactive agent with a real provider |
| Computer Use | Add desktop control to a Namzu tool registry |
| Computer Use Action Reference | Inspect the full computer_use action contract |
| Computer Use Host Lifecycle | Understand host initialization, capabilities, and disposal |
| Platform Support | Review OS support, permissions, and operational caveats |
| Providers | Compare provider packages and route to the right integration page |
| Provider Selection Guide | Choose the right provider package by deployment model, dependency shape, and local-vs-cloud tradeoffs |
3. Recommended Reading Order
- Read Getting Started to pick the package set you need.
- Read SDK Quickstart once you are ready to run an agent.
- Read Provider Selection Guide before choosing a production provider package.
- Read SDK Runtime before diving into individual runtime fields.
- Read SDK Agents when you need more than the one-agent quickstart path.
- Read SDK Tools before exposing a real tool surface to models.
- Read SDK Provider Integration if you need registry-level provider wiring or direct provider calls.
- Read SDK Integrations if the runtime needs external systems, MCP interoperability, or plugin-managed tools.
- Read SDK Sessions before persisting project or delegation state.
- Read SDK Observability if you need production tracing or metrics.
- Read SDK Architecture if you are extending or contributing to the SDK internals.
- Read Computer Use only if your agent needs desktop interaction.
4. Documentation Conventions
These docs follow a simple publishing model so they work both in-repo and on a static docs site:
- Every page includes structured frontmatter for indexing and freshness tracking.
- Every page uses numbered sections so page structure is easy to parse visually and by tools.
- Every page ends with a
Relatedsection that links to adjacent docs and source material. - Examples use the public package surfaces that are exported today.