Skip to main content

Reusable Harbor custom agent that runs Pi SDK sessions and writes trajectory artifacts.

Project description

harbor-pi-sdk-agent

Run the Pi coding agent from Harbor.

Use this package when you want Harbor to launch a Pi SDK agent and collect Harbor-compatible trajectory artifacts.

Mental Model

harbor-pi-sdk-agent is a thin Harbor wrapper around the official Pi coding agent package, @mariozechner/pi-coding-agent.

It is not a provider compatibility layer. Pass Pi's provider/model-id through to this package, and let the Pi SDK registry decide the built-in model API, base URL, and request headers. Only pass base_url, model_api, or provider_headers_json when you intentionally want to override Pi's built-in provider metadata or connect to a compatible custom endpoint.

Install

Install this package into the same Python environment or image that runs Harbor.

From a private package index:

pip install harbor-pi-sdk-agent

From this private GitHub repo:

pip install git+ssh://git@github.com/Kingwl/harbor-pi-sdk-agent.git

With uv:

uv pip install git+ssh://git@github.com/Kingwl/harbor-pi-sdk-agent.git

Harbor should already be available in that environment. This package is loaded by import path.

Run

Set the API key for the provider you want to use:

export OPENAI_API_KEY=...

Then pass the agent import path to Harbor:

harbor run \
  --agent-import-path harbor_pi_sdk_agent.agent:PiSdkAgent \
  --agent-kwarg 'model_name=openai/gpt-4.1' \
  --agent-kwarg 'api_key_env=OPENAI_API_KEY'

For another Pi built-in provider:

export DEEPSEEK_API_KEY=...

harbor run \
  --agent-import-path harbor_pi_sdk_agent.agent:PiSdkAgent \
  --agent-kwarg 'model_name=deepseek/deepseek-v4-pro' \
  --agent-kwarg 'api_key_env=DEEPSEEK_API_KEY'

For the Pi built-in Kimi Coding provider:

export KIMI_API_KEY=...

harbor run \
  --agent-import-path harbor_pi_sdk_agent.agent:PiSdkAgent \
  --agent-kwarg 'model_name=kimi-coding/kimi-for-coding' \
  --agent-kwarg 'api_key_env=KIMI_API_KEY'

For a compatible endpoint that is not already described by Pi's provider registry:

export ANTHROPIC_API_KEY=...

harbor run \
  --agent-import-path harbor_pi_sdk_agent.agent:PiSdkAgent \
  --agent-kwarg 'model_name=anthropic/model-id' \
  --agent-kwarg 'api_key_env=ANTHROPIC_API_KEY' \
  --agent-kwarg 'base_url=https://your-anthropic-compatible-endpoint' \
  --agent-kwarg 'model_api=anthropic-messages'

Launcher Setup

In your Harbor launcher or task wrapper, use:

harbor_pi_sdk_agent.agent:PiSdkAgent

Recommended kwargs:

model_name=provider/model-id
api_key_env=PROVIDER_API_KEY
agent_label=pi-sdk
thinking=xhigh

Optional kwargs:

base_url=https://...
model_api=anthropic-messages
provider_headers_json={"User-Agent":"..."}
compaction_enabled=0
filtered_events=1
raw_events=0
max_field_chars=200000

Recommended artifacts:

/logs/agent/trajectory.json
/logs/agent/trajectory.steps.jsonl
/logs/agent/pi-filtered.jsonl
/logs/agent/pi-sdk-runner.txt

Add this only when you explicitly want raw SDK events:

/logs/agent/pi-raw.jsonl

Outputs

  • trajectory.json: the main Harbor trajectory.
  • trajectory.steps.jsonl: step-by-step trajectory stream for long or interrupted runs.
  • pi-filtered.jsonl: compact Pi SDK event log.
  • pi-raw.jsonl: raw Pi SDK event log when raw_events=1.
  • pi-sdk-runner.txt: concise agent stdout.

Python Usage

Harbor usually creates the agent from the import path. If you need to construct it in Python:

from harbor_pi_sdk_agent import PiSdkAgent

agent = PiSdkAgent(
    logs_dir=logs_dir,
    model_name="openai/gpt-4.1",
    api_key_env="OPENAI_API_KEY",
)

Use this package as a Harbor agent plugin, not as a standalone command-line tool.

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

harbor_pi_sdk_agent-0.1.1.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

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

harbor_pi_sdk_agent-0.1.1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file harbor_pi_sdk_agent-0.1.1.tar.gz.

File metadata

  • Download URL: harbor_pi_sdk_agent-0.1.1.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for harbor_pi_sdk_agent-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d42764f54ffd59ebae08691d42b34fad731598762e2fd056826dd7bd1dcb73fc
MD5 9accc026ac6e0a71d3f70e4a4598dcbf
BLAKE2b-256 1769ea3da5ff858d9a1751b664e83030894f7802533dbdc5ad326f58d3d901cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for harbor_pi_sdk_agent-0.1.1.tar.gz:

Publisher: publish.yml on Kingwl/harbor-pi-sdk-agent

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

File details

Details for the file harbor_pi_sdk_agent-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for harbor_pi_sdk_agent-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fc6330438910135ec9c383790aac3fbfe8a41ccb1a0be047213c18246e3f4cbc
MD5 20e0a9e6df52688c2ca2b93c364d4063
BLAKE2b-256 939a48faa2ebc89642afe24e7b112d42880bcdce8b5c9c156b6e53e3d834750c

See more details on using hashes here.

Provenance

The following attestation bundles were made for harbor_pi_sdk_agent-0.1.1-py3-none-any.whl:

Publisher: publish.yml on Kingwl/harbor-pi-sdk-agent

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