slop-ai 0.2.0rc3

Python SDK for the SLOP protocol — let AI observe and interact with your app's state

slop-ai

Python SDK for the SLOP protocol.

The package includes provider and consumer APIs, descriptor helpers, tree scaling utilities, and transports for ASGI, WebSocket, Unix socket, and stdio flows.

Install

pip install slop-ai[websocket]

Use the websocket extra when you want the standalone WebSocket transport. The core package itself has no required runtime dependencies.

Quick start

from fastapi import FastAPI
from slop_ai import SlopServer
from slop_ai.transports.asgi import SlopMiddleware

app = FastAPI()
slop = SlopServer("my-api", "My API")

@slop.node("todos")
def todos_node():
    return {
        "type": "collection",
        "items": [
            {"id": str(todo.id), "props": {"title": todo.title, "done": todo.done}}
            for todo in db.get_todos()
        ],
    }

@slop.action("todos", "create", params={"title": "string"})
def create_todo(title: str):
    db.create_todo(title)

app.add_middleware(SlopMiddleware, slop=slop)

Included modules

• slop_ai.SlopServer and slop_ai.SlopConsumer
• slop_ai.discovery for provider scanning, bridge relay, lazy/auto-connect, and AI-facing tool helpers
• slop_ai.pick, slop_ai.omit, slop_ai.normalize_descriptor
• slop_ai.transports.asgi, .websocket, .unix, .stdio
• scaling helpers such as prepare_tree, truncate_tree, and auto_compact

Discovery layer

The Python SDK includes the core discovery layer in slop_ai.discovery:

import asyncio

from slop_ai.discovery import DiscoveryOptions, create_discovery_service


async def main() -> None:
    service = create_discovery_service(DiscoveryOptions())
    await service.start()
    try:
        provider = await service.ensure_connected("my-app")
        if provider is not None:
            print(provider.name)
    finally:
        await service.stop()


asyncio.run(main())

Install slop-ai[websocket] when discovery needs browser bridge support or direct WebSocket providers.

Documentation

• API reference: https://docs.slopai.dev/api/python
• Python guide: https://docs.slopai.dev/guides/python
• Protocol spec: https://docs.slopai.dev/spec/core/overview