Metadata-Version: 2.4
Name: firekeep-client
Version: 1.0.1
Summary: Client for Firekeep, the self-hosted operating layer for connected AI agents.
License-Expression: LicenseRef-Firekeep-BUSL-1.1
Project-URL: Homepage, https://firekeep.ai
Project-URL: Documentation, https://firekeep.ai/docs.html
Project-URL: Changelog, https://kapella-hub.github.io/firekeep-dist/latest/latest.json
Project-URL: Source, https://github.com/kapella-hub/FirekeepHQ
Project-URL: MCP Registry, https://registry.modelcontextprotocol.io/v0.1/servers/io.github.kapella-hub%2Ffirekeep/versions/latest
Keywords: mcp,model-context-protocol,ai-agents,agent-memory,agent-continuity,agent-coordination,claude-code,codex,self-hosted
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: mcp<2,>=1.28
Requires-Dist: httpx<1,>=0.27
Requires-Dist: truststore>=0.9.1
Provides-Extra: symdex
Requires-Dist: firekeep-symdex<1,>=0.2; extra == "symdex"
Dynamic: license-file

# firekeep-client

The portable client kit for [Firekeep](https://firekeep.ai) — the **self-hosted
operating layer for connected AI agents**. It carries durable knowledge,
working context, procedures, coordination, and replayable evidence across
sessions, models, machines, and teammates. Agent-facing MCP tools are exposed
through one local `firekeep` gateway. Shipped adapters configure Claude Code,
Codex, Kiro, and OpenCode; other MCP clients can connect through the generic
configuration path, without hook-driven lifecycle automation.

mcp-name: io.github.kapella-hub/firekeep

## What this package is

The client half of Firekeep: the stdio MCP gateway (`firekeep gateway`) that
aggregates your team server's services (memory, sessions, environment,
coordination) plus the Decision Board and whichever **dexes** — the domain
indexes the Keep understands — you have registered, the lifecycle hook cores,
the runtime adapters, and the `firekeep` CLI (`install`, `join`, `doctor`,
`update`, `dex`, `docdex`).

Two dexes ship today: `firekeep-symdex` (code intelligence) and
`firekeep-docdex` (folders of documents indexed into the Keep's corpus). The
managed installer always installs both wheels; `firekeep dex list|add|remove`
decides which of them actually run. Existing installs keep symdex across an
update; a fresh install opts in with `firekeep dex add symdex`.

**Firekeep is self-hosted — this package needs a server to talk to.** A person
or team runs its own server, with per-key authentication. Current server images
target `linux/amd64`: use an x86-64 Linux host, or Docker Desktop with amd64
container support on Windows or Mac. There is no hosted endpoint. Server install:
[firekeep.ai/docs.html](https://firekeep.ai/docs.html#server).

## Install

The recommended path is the managed installer, which pins a private
environment under `~/.firekeep`, verifies Ed25519-signed releases, renders
every runtime adapter, and keeps itself updated:

```bash
curl -fsSL https://firekeep.ai/latest/install | sh    # macOS / Linux
irm https://firekeep.ai/latest/install.ps1 | iex         # Windows
```

It asks two required questions: the agent identity your memories, sessions and
replay events are attributed to, and where your server is — set one up on this
machine, redeem a join code, point at one that is already running, or decide
later. It then offers a skippable prompt for another MCP client's rules file.
The full guide is
[firekeep.ai/docs.html](https://firekeep.ai/docs.html).

Installing from PyPI works too and gives you the same CLI and gateway:

```bash
pip install firekeep-client            # gateway + CLI + hooks + adapters
pip install "firekeep-client[symdex]"  # + the symdex code-intelligence dex
pip install firekeep-docdex            # + the docdex documents dex
firekeep join fk_join_...              # single-use code from your team's dashboard
firekeep install                       # render adapters for your agent clients
firekeep dex list                      # which dexes are registered on this machine
```

A pip install does **not** bundle the dex wheels, so install the ones you want
before registering them — `firekeep dex add <name>` refuses to register a dex
whose wheel it cannot import, rather than leaving you with a backend that fails
to start.

Note the trade-off: a pip install lives in whatever environment you put it in
and updates when you update it; the managed installer owns its environment,
verifies release signatures against a pinned key, and swaps versions without
closing agent sessions.

## Connect an MCP client manually

Any MCP client can launch the gateway over stdio once `firekeep join` has
written the connection:

```json
{
  "mcpServers": {
    "firekeep": { "command": "firekeep", "args": ["gateway"] }
  }
}
```

## Links

- Product and docs: https://firekeep.ai · https://firekeep.ai/docs.html
- Why agents need this: https://firekeep.ai/agents-md-vs-memory.html
- The instruction-compliance study: https://firekeep.ai/instruction-compliance.html
- Security contact: security@firekeep.ai

## License

BUSL-1.1 (source-available). The Additional Use Grant permits free self-hosted
production use by individuals and teams while Firekeep is in early access.
Commercial licensing covers Firekeep Enterprise and hosted or managed use
outside that grant (sales@firekeep.ai). Each version converts to Apache-2.0
four years after its first public release.
