Skip to main content

SurrealDB Spectron memory as tools for Google Agent Development Kit (ADK) agents.

Project description

spectron-google-adk

Give Google ADK agents persistent memory backed by Spectron, SurrealDB's agent-memory layer.

An agent can store facts, search them back, forget them, and reason over them, with memory that survives restarts and separate conversations. Spectron handles entity extraction, knowledge-graph storage, temporal facts, and hybrid retrieval; this package is the thin layer that hands those verbs to an ADK agent.

Install

pip install spectron-google-adk

This pulls in google-adk and surrealdb. The Spectron client ships in the surrealdb package (3.0.0a1 and later), which is installed for you from PyPI.

Configuration

Spectron needs a context id, an endpoint, and an API key. The Spectron SDK does not read environment variables itself, so you pass these in explicitly. For scripts, SpectronConfig.from_env() reads them from the environment for you:

export SPECTRON_CONTEXT="acme-prod"
export SPECTRON_ENDPOINT="https://api.spectron.example"
export SPECTRON_API_KEY="sk-spec-..."
export GOOGLE_API_KEY="your-google-api-key"   # used by the ADK model

See .env.example for the full list.

Quickstart

import asyncio
from google.adk.agents import Agent
from google.adk.runners import InMemoryRunner
from spectron_google_adk import SpectronToolset

async def main():
    toolset = SpectronToolset(
        context="acme-prod",
        endpoint="https://api.spectron.example",
        api_key="sk-spec-...",
    )

    agent = Agent(
        model="gemini-2.5-flash",
        name="assistant",
        description="An assistant with persistent memory.",
        instruction="Store durable facts with remember and look things up with recall.",
        tools=[toolset],
    )

    runner = InMemoryRunner(agent=agent)
    try:
        await runner.run_debug("Remember: Acme Corp, healthcare, 1.2M dollar contract.")
        events = await runner.run_debug("What healthcare contracts do we have?")
        for event in events:
            if event.is_final_response() and event.content:
                for part in event.content.parts:
                    if part.text:
                        print(part.text)
    finally:
        await runner.close()
        await toolset.close()

asyncio.run(main())

SpectronToolset extends ADK's BaseToolset, so an ADK Runner closes it on shutdown. When the toolset creates the client, close() closes that client too.

Two ways to build tools

SpectronToolset (recommended)

Owns the client and manages its lifecycle. Add it to an agent as a single item in the tools list:

toolset = SpectronToolset(config=SpectronConfig.from_env())
agent = Agent(model="gemini-2.5-flash", name="assistant", tools=[toolset])

get_spectron_tools (for quick scripts)

Returns a plain list of tools. Pass your own client when you want to control its lifecycle; otherwise the client it creates lives for the process:

from surrealdb.spectron import AsyncSpectron
from spectron_google_adk import get_spectron_tools

client = AsyncSpectron(context="acme-prod", endpoint="...", api_key="sk-...")
tools = get_spectron_tools(client=client)
agent = Agent(model="gemini-2.5-flash", name="assistant", tools=tools)

Session and tenant isolation

Bind a session_id (and optionally a scope) when you build the tools. The values are fixed at build time and are not exposed to the model, so an agent cannot read or write outside its slice of memory:

toolset = SpectronToolset(config=config, session_id="user-123")

Two agents built with the same session_id share memory; agents on different session ids stay isolated. See examples/sessionized_memory.py.

Choosing which verbs to expose

By default all of the verbs below are available. Pass include=[...] to expose a subset, for example a collector agent that can only write and a researcher agent that can only read (see examples/multi_agent.py):

collector = SpectronToolset(config=config, include=["remember"])
researcher = SpectronToolset(config=config, include=["recall", "reflect"])

Tools

Tool Argument What the agent uses it for
remember text Store a fact, preference, or piece of information.
recall query Search memory and get back ranked matching passages.
forget query Remove information that matches a description.
reflect query Get a written summary synthesized from memory, with evidence.
chat message Ask memory a question and get a grounded natural-language answer.
consolidate (none) Pool recent facts into durable observations.
elaborate entity_ref Expand an entity's relationships from stored facts.
query_context query Build a composed context string for grounding a response.
inspect ref Inspect a single memory object by reference.
state (none) Get a snapshot of current working memory.

Every tool returns a JSON-safe dict with a status key that is "success" or "error". A failed Spectron request becomes {"status": "error", "message": ..., "status_code": ..., "trace_id": ...} so the model sees it as data rather than the agent turn failing.

Examples

  • examples/quickstart.py - one agent that stores a fact and recalls it.
  • examples/sessionized_memory.py - memory isolation across sessions.
  • examples/multi_agent.py - a writer agent and a reader agent sharing a context.

Fill in .env from .env.example, then run any example, for example python examples/quickstart.py.

Development

pip install -e ".[dev]"
pytest

The tests use a fake client, so they need no network access or credentials.

Links

License

Apache 2.0. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spectron_google_adk-0.3.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spectron_google_adk-0.3.0-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file spectron_google_adk-0.3.0.tar.gz.

File metadata

  • Download URL: spectron_google_adk-0.3.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for spectron_google_adk-0.3.0.tar.gz
Algorithm Hash digest
SHA256 8eb819b1f59e9efc665f0edf36ed3be8d9edf18ef3500f3ca6cb8441976eb31c
MD5 ad16fcc2a9389ac2a9a31ea4603644ce
BLAKE2b-256 0a26451f0078795b638265a9e0e1e9182acb70745f64b70be741a04cff70cf18

See more details on using hashes here.

Provenance

The following attestation bundles were made for spectron_google_adk-0.3.0.tar.gz:

Publisher: release.yml on surrealdb/spectron-google-adk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file spectron_google_adk-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for spectron_google_adk-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 803430107caa2b15d816e6d7a8e5538e32abf4ba5285f827c0b2df998f78a455
MD5 67d3fe0e6ba4cd4991480a0714777762
BLAKE2b-256 be85226c1bb5eccf5adf0fb441737a8620d9f1f2ffe5cfb712efa198b5da0a57

See more details on using hashes here.

Provenance

The following attestation bundles were made for spectron_google_adk-0.3.0-py3-none-any.whl:

Publisher: release.yml on surrealdb/spectron-google-adk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page