Skip to content

AGENTS.md

Latest commit

 

History

History
49 lines (38 loc) · 2.2 KB

AGENTS.md

File metadata and controls

49 lines (38 loc) · 2.2 KB

Bridge SDK - Agent Instructions

Project Overview

Bridge SDK is a Python SDK for defining workflow pipelines with automatic dependency management. Pipelines are defined using @pipeline.step decorators and step_result annotations, then executed by the Bridge orchestrator on the Poolside platform.

Development

make venv   # Create virtual environment
make sync   # Install dependencies
make proto  # Generate protocol buffers
make test   # Run tests

Pre-commit hooks are configured — run uv run pre-commit install after cloning.

Key Architecture

  • bridge_sdk/pipeline.py — Pipeline class and PIPELINE_REGISTRY
  • bridge_sdk/step.py — @step decorator (deprecated) and get_dsl_output()
  • bridge_sdk/step_function.py — StepFunction wrapper and STEP_REGISTRY
  • bridge_sdk/step_data.py — StepData Pydantic model
  • bridge_sdk/annotations.py — step_result() annotation helper
  • bridge_sdk/function_schema.py — JSON schema generation from function signatures
  • bridge_sdk/cli.py — CLI commands: check, config get-dsl, run
  • bridge_sdk/bridge_sidecar_client.py — gRPC client for agent integration
  • bridge_sdk/proto/bridge_sidecar.proto — gRPC service definition
  • examples/ — Example pipelines (agent_example.py, example.py)
  • tests/ — Test suite

Bundled Skill: bridge-pipelines

This repo ships a bridge-pipelines skill at skills/bridge-pipelines/ that teaches agents how to build Bridge pipelines using this SDK. It is distributed via pkit as part of the bridge registry.

When making changes that affect how the SDK is used — such as changes to the public API, decorators, annotations, CLI commands, agent integration, configuration format, or usage patterns — you must also update the bridge-pipelines skill in skills/bridge-pipelines/ so it stays in sync with the SDK.

The skill files:

  • skills/bridge-pipelines/SKILL.md — Core usage guide (quick start, concepts, examples)
  • skills/bridge-pipelines/references/agents.md — Agent integration via BridgeSidecarClient
  • skills/bridge-pipelines/references/cli.md — CLI command reference
  • skills/bridge-pipelines/references/web-integration.md — Web UI and REST API integration