# HeavenBase

> An agent-native unified data gateway for existing databases.

## Docs

- [Blog](https://ahvn.top/blog/index.md): HeavenBase articles and announcements.
- [Citation](https://ahvn.top/community/citation.md): How to cite HeavenBase in academic work.
- [Connect](https://ahvn.top/community/connect.md): Where to find the HeavenBase community.
- [Contributing](https://ahvn.top/community/contributing.md): How to contribute to HeavenBase.
- [License](https://ahvn.top/community/license.md): HeavenBase license information.
- [Roadmap](https://ahvn.top/community/roadmap.md): HeavenBase development roadmap and feature progress.
- [Agents](https://ahvn.top/features/agents.md): Building AI agents with HeavenBase workspaces and toolkits.
- [Backends](https://ahvn.top/features/backends.md): Pluggable storage providers for HeavenBase workspaces.
- [Caching](https://ahvn.top/features/caching.md): LLM response caching and function call monitoring.
- [Capsules](https://ahvn.top/features/capsules.md): Serialize, store, and restore Python callables as HeavenBase entities.
- [Configuration](https://ahvn.top/features/configuration.md): Runtime configuration management for HeavenBase workspaces.
- [Entities](https://ahvn.top/features/entities.md): Logical schemas with typed fields and deterministic hash IDs.
- [Extensions](https://ahvn.top/features/extensions.md): Extending HeavenBase with custom backends, handlers, strategies, and entity types.
- [Advanced LLM](https://ahvn.top/features/llm/advanced.md): Streaming, retries, structured output, usage, and image APIs.
- [LLM chat](https://ahvn.top/features/llm/chat.md): Chat completions and streaming with hb.LLM.
- [Embeddings](https://ahvn.top/features/llm/embeddings.md): Text embedding generation in HeavenBase.
- [LLM overview](https://ahvn.top/features/llm/overview.md): Unified LLM access in HeavenBase: chat, streaming, embeddings, and image APIs.
- [Sessions](https://ahvn.top/features/llm/sessions.md): Stateful LLM sessions in HeavenBase.
- [Tool use](https://ahvn.top/features/llm/tool-use.md): Structured tool calls and function-calling in HeavenBase LLM.
- [MCP](https://ahvn.top/features/mcp.md): Expose HeavenBase workspaces and Capsule Toolkits through MCP.
- [Prompts](https://ahvn.top/features/prompts.md): Function-based prompt specs with entity-backed storage and translation.
- [Query](https://ahvn.top/features/query.md): Typed query surface with transparent backend routing and explain support.
- [Routing](https://ahvn.top/features/routing.md): Field-level routing: assign each entity field to the backend best suited for it.
- [Schema](https://ahvn.top/features/schema.md): The user-facing catalog and MetaSchema internal bookkeeping.
- [Toolkits](https://ahvn.top/features/toolkits.md): MCP tool collections: define, convert, and persist tools in HeavenBase.
- [Common utilities](https://ahvn.top/features/utilities/common.md): Shared helper functions for typing, dataclasses, dicts, hashing, debug output, and logging.
- [File and path utilities](https://ahvn.top/features/utilities/file-and-path.md): Path helpers and file I/O utilities for HeavenBase.
- [Function utilities](https://ahvn.top/features/utilities/functions.md): StableRNG, bounded parallel helpers, and command execution for HeavenBase.
- [Utilities overview](https://ahvn.top/features/utilities/overview.md): HeavenBase utility functions for path, serialization, concurrency, and more.
- [Serialization utilities](https://ahvn.top/features/utilities/serialization.md): JSON, YAML, pickle, binary, and text serialization helpers.
- [String utilities](https://ahvn.top/features/utilities/strings.md): String and Markdown formatting helpers for HeavenBase.
- [Workspace](https://ahvn.top/features/workspace.md): The HeavenBase workspace: schema, backends, routing, and data in one boundary.
- [Database integrations](https://ahvn.top/integrations/databases.md): SQL-family backends: SQLite and PostgreSQL.
- [LLM provider integrations](https://ahvn.top/integrations/llm-providers.md): Portkey, OpenAI, LiteLLM, and Bifrost gateway support.
- [MCP integration](https://ahvn.top/integrations/mcp.md): Using HeavenBase with Model Context Protocol clients and servers.
- [Integrations overview](https://ahvn.top/integrations/overview.md): Database backends, vector stores, LLM providers, and MCP support in HeavenBase.
- [Skills](https://ahvn.top/integrations/skills.md): Agent skills and extensions for HeavenBase.
- [Vector database integrations](https://ahvn.top/integrations/vector-databases.md): Vector backends: Milvus, pgvector, and in-memory.
- [Architecture](https://ahvn.top/introduction/architecture.md): How HeavenBase is structured internally.
- [What is HeavenBase?](https://ahvn.top/introduction/overview.md): An overview of HeavenBase as an agent-native unified data gateway.
- [Philosophy](https://ahvn.top/introduction/philosophy.md): The design values and tradeoffs behind HeavenBase.
- [Entity quick reference](https://ahvn.top/quickstart/first-entity.md): Field types, computed fields, and routing for entity definitions.
- [5-Minute Workshop](https://ahvn.top/quickstart/first-workspace.md): A toy problem walkthrough: build a task management MCP server with entities, CRUD, and queries.
- [Install and setup](https://ahvn.top/quickstart/installation.md): Install HeavenBase, run initial setup, and verify it works.
- [First LLM Call](https://ahvn.top/quickstart/quick-setup.md): Use the hb CLI and Python API to chat, embed, and interact with LLMs.
- [API reference](https://ahvn.top/reference/api/overview.md): HeavenBase Python API reference.
- [CLI reference](https://ahvn.top/reference/cli/overview.md): HeavenBase command-line interface reference.
- [Glossary](https://ahvn.top/reference/glossary.md): Key terms and concepts in HeavenBase.
- [MCP toolkit reference](https://ahvn.top/reference/mcp-toolkit/overview.md): Full reference for HeavenBase MCP toolkit tools and schemas.