Skip to main content

coloph-toolset

Declare Python tools once. Export their schema, organize them in catalogs, and run validated synchronous or asynchronous calls.

Version 0.6 adds authorized hierarchical discovery, first-use documentation gates, and terminal completion signals while preserving the declaration, catalog, CLI, runtime, HTTP, and direct Pydantic AI APIs. The application owns authorization, business dependencies, resource behavior, and model providers. The roadmap describes later adapters. The package remains on 0.x while its interfaces settle.

Install

uv add coloph-toolset

The package requires Python 3.11 or later and Pydantic 2.12 or later within major version 2. No Coloph installation, database, credentials, HTTP framework, or agent framework is required. Install the optional HTTP adapter with uv add "coloph-toolset[http]". Install the optional Pydantic AI adapter with uv add "coloph-toolset[pydantic-ai]".

Declare and validate

from typing import Annotated
from pydantic import Field, ValidationError
from coloph_toolset import tool, tool_for


@tool()
def shipping_quote(
    ctx,
    quantity: Annotated[int, "Number of parcels", Field(gt=0)],
    destination: Annotated[str | None, "Country code, or null for collection"],
    insured: Annotated[bool, "Include insurance"] = False,
) -> dict[str, object]:
    return {"quantity": quantity, "destination": destination, "insured": insured}


declaration = tool_for(shipping_quote)
schema = declaration.json_schema()
arguments = declaration.validate_arguments({"quantity": "2", "destination": None})
result = shipping_quote(None, **arguments)

try:
    declaration.validate_arguments({"quantity": 0, "destination": None})
except ValidationError as error:
    print(error.errors(include_url=False))

Validation never calls the function. Calling the Python function directly does not apply validation. The application owns execution and must use validated arguments at its dispatch boundary.

Run tools

from dataclasses import dataclass
from coloph_toolset import ToolContext, ToolRuntime


@dataclass
class Session:
    calls: int = 0


runtime = ToolRuntime(dependencies={"region": "eu"}, state_factory=Session)
result = runtime.invoke_sync(shipping_quote, {"quantity": 2, "destination": None})
print(result.raw)
print(result.output)

Use await runtime.invoke(...) in asynchronous code. The runtime awaits synchronous and asynchronous tools exactly once. Add a ResourceLifecycle when each call needs a transaction, client, or other resource.

Context and restricted arguments

The declaration expects a required first parameter named ctx. Its type is application-owned and its annotation is not evaluated. Context never appears in the argument schema.

@tool(model_hidden_args=("internal",))
def inspect_order(ctx, order: str, internal: bool = False):
    return ctx.lookup(order, internal=internal)


public = tool_for(inspect_order)
public.validate_arguments({"order": "demo"})
# An external "internal" argument raises ValidationError.
operator_schema = public.json_schema(include_hidden=True)

Hidden arguments require valid defaults. Only trusted application code can select include_hidden=True. Argument projection is not an authorization system.

Contracts and examples

Every milestone adds a project under examples/. CI runs all preserved examples against the current library.

Development

uv sync --locked
uv run pytest
uv run mypy
uv run python -m ruff check .
uv run python -m ruff format --check .
uv build
uv run python scripts/smoke_wheel.py

MIT licensed.

Release files for coloph-toolset 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for coloph-toolset 0.6.0
File Size Uploaded
coloph_toolset-0.6.0.tar.gz 299.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for coloph-toolset 0.6.0
File Interpreter ABI Platform
coloph_toolset-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 340.0 kB

Release files / coloph_toolset-0.6.0.tar.gz

Download URL coloph_toolset-0.6.0.tar.gz
Size 299.8 kB
Tags Source
SHA-256 checksum
How to use checksums
dc03ab44272882ebd2ba1aac366edbbfdc67a197c641d41484aee7c350b11d27
BLAKE2b-256 checksum
How to use checksums
7d66a36882314be6e1cc7ccc5bf61757190838b8e295dc706ba46c71caf8ccea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release files / coloph_toolset-0.6.0-py3-none-any.whl

Download URL coloph_toolset-0.6.0-py3-none-any.whl
Size 40.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1184546cb38583637ab269799c7abab8f3106e31e0df765585b7cb2dbb90deab
BLAKE2b-256 checksum
How to use checksums
b4d0013061bac6d45c2dfcdb3ac41fc2878108282e34d9e226796cf19be0b018
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.

Transparency log

Release history Release notifications | RSS feed

0.6.2

2 release files

0.6.1

2 release files

This release

0.6.0 This release

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page