# AUVY Docs

> Official documentation for the AUVY API, TypeScript SDK, CLI, MCP server—neurons and pathways first, receptors as invoke gateways—and monorepo developer workflow.

Use this file for the curated entrypoints.
Use [llms-full.txt](https://docs.auvy.ai/llms-full.txt) for the full Mintlify-generated corpus.

## Core docs

- [Introduction](https://docs.auvy.ai/docs/intro): Product overview, neurons-first concepts, and entrypoints.
- [Integrate the API](https://docs.auvy.ai/guides/integrate-api): Fastest path from API key to first request.
- [Neuron scope](https://docs.auvy.ai/guides/neuron-scope): core, workspace, and brain scope (`scope` field).
- [Authentication](https://docs.auvy.ai/docs/getting-started/authentication): API key, JWT, publishable key, share token, CLI, and MCP auth matrix.
## TypeScript SDK

- [TypeScript SDK](https://docs.auvy.ai/sdk/introduction): Install and configure `@auvy-synapse/client`.
- [SDK Resources](https://docs.auvy.ai/sdk/resources): Resource namespaces, advanced helpers, and public/private boundaries.
- [Integration Patterns](https://docs.auvy.ai/guides/integration-patterns): Streaming, pagination, retries, and typed error handling.

## API reference

- [API Reference](https://docs.auvy.ai/api-reference/introduction): Base URL, auth, pagination, rate limits, and endpoint index.
- [Health](https://docs.auvy.ai/api-reference/health): Liveness and authenticated workspace context.
- [Config](https://docs.auvy.ai/api-reference/config): Models, embeddings, and cost estimates.
- [Neurons](https://docs.auvy.ai/api-reference/neurons): Agent CRUD, `scope`, and config.
- [Receptors](https://docs.auvy.ai/api-reference/receptors): Gateway invoke and share management.
- [Jobs](https://docs.auvy.ai/api-reference/jobs): Async execution, streaming, waiting input, and transcription.
- [Public Endpoints](https://docs.auvy.ai/api-reference/public): Share-token flows for public receptors and traces.

## CLI and MCP

- [CLI Reference](https://docs.auvy.ai/cli-reference/introduction): Human, script, and LLM-friendly CLI usage.
- [MCP Server](https://docs.auvy.ai/mcp-reference/introduction): Hosted MCP endpoint, auth, and client configuration.
- [MCP Tools](https://docs.auvy.ai/mcp-reference/tools): Tool families and usage expectations.

## Developer workflow

- [Developer Overview](https://docs.auvy.ai/developer/overview): Architecture, service map, and public/private surfaces.
- [Local Development](https://docs.auvy.ai/developer/local-development): Repo bootstrap, docs workflow, and common commands.

## Machine-readable assets

- [OpenAPI spec](https://docs.auvy.ai/openapi.json): Public OpenAPI 3.1 document mirrored from the API app.