Skip to main content

Agent tools for the calfkit SDK: shell, files, code execution, web search/fetch, and todo, each deployable as a calfkit tool node.

Project description

🐮 calfkit-tools

PyPI version Python versions Coverage License: Apache-2.0 AND MIT

Tools for calfkit agents — shell, files, code, web, and todo — each deployable as a tool node.

calfkit is an SDK for building AI agents as distributed, event-driven microservices over Kafka. calfkit-tools gives those agents a ready-made toolbox of eleven tools. Every tool is a calfkit ToolNodeDef — a small service (a "node") that you run as a process; it exposes the tool on Kafka topics that calfkit agents call.

  • One install, eleven tools — shell, file ops, code execution, web search/fetch, and task tracking.
  • Import and go — every tool is importable straight from calfkit_tools.tools, ready to deploy.
  • Deploy as nodes — 1:1 tool→node; tools run on your own host by default (Docker/Modal/Daytona sandboxes are opt-in, not required).

Contents

Install

pip install calfkit-tools          # or: uv add calfkit-tools

Requires Python 3.10+. Installing calfkit-tools also pulls in the calfkit SDK and its ck run CLI. The base install runs every tool with its default backend (shell and code execution run locally).

Optional extras add remote shell-execution backends for the terminal, process, and execute_code tools — the default local backend needs none of them:

pip install "calfkit-tools[shell-docker]"    # run shell commands in Docker
pip install "calfkit-tools[shell-modal]"     # ... in Modal sandboxes
pip install "calfkit-tools[shell-daytona]"   # ... in Daytona sandboxes
pip install "calfkit-tools[all]"             # all three

Quickstart

Each tool is a calfkit node, so running one needs a reachable Kafka broker (defaults to localhost; point elsewhere with --host / -H or the $CALFKIT_MESH_URL env var). Serve a tool on the mesh with the ck run dev command:

ck run calfkit_tools.tools:terminal

The node consumes tool.terminal.input and replies on tool.terminal.output — any calfkit agent on the mesh can now call terminal. Host every tool in one worker with the ALL_TOOLS bundle:

ck run calfkit_tools.tools:ALL_TOOLS   # all eleven tools in one worker

To host tools programmatically, add the imported nodes to a calfkit Worker (constructed with a Client for the Kafka connection). See the calfkit SDK for Client / Worker setup and for how an agent calls a deployed tool:

from calfkit_tools.tools import terminal, read_file, write_file

# `worker` is a configured calfkit Worker — see the calfkit SDK for construction.
worker.add_nodes(terminal, read_file, write_file)

Available tools

Eleven tools, all importable from calfkit_tools.tools:

from calfkit_tools.tools import terminal, read_file, web_search, web_fetch  # etc.
Tool What it does
terminal Execute a shell command in the session's terminal environment.
process Manage background processes started with terminal(background=True).
execute_code Run a Python script that can call the other tools programmatically.
read_file Read a text file with line numbers and pagination.
write_file Write content to a file, completely replacing existing content.
patch Make targeted find-and-replace edits in files.
search_files Search file contents or find files by name.
web_search Search the web and return ranked links.
web_extract Extract readable content from one or more web pages.
web_fetch Fetch a single URL through an SSRF-protected fetcher and return its content as markdown (binary responses come back base64-encoded with their media type).
todo Manage a per-session task list.

ALL_TOOLS is the list of all eleven tool nodes; InMemoryTodoStore is the worker-lifetime store the todo tool binds as a resource. Both import from calfkit_tools.tools too.

Importing a specific tool

Import any tool straight from the package root:

from calfkit_tools.tools import terminal, search_files, web_search, web_fetch

or pull in the whole set at once:

from calfkit_tools.tools import ALL_TOOLS

See docs/reference/tool-contracts.md for each tool's full parameter, resource-wiring, and reply-shape contract.

Security

The default local backend is not a sandboxterminal, process, and execute_code run real commands directly on the host machine. Review the blast radius before deploying:

  • terminal, process, and execute_code run real commands. On the default local backend they run directly on the host; use a remote shell backend ([shell-docker] / [shell-modal] / [shell-daytona]) to sandbox them.
  • write_file and patch modify the real filesystem; read_file and search_files read it.
  • web_fetch is SSRF-guarded by default: private/loopback addresses are blocked, requests time out after 30s, and content is capped.

State is held in memory and isolated per calling agent (ADR-0004), so run one process per stateful node. Durable state and further hardening are on the roadmap.

Deploying tools as nodes

Each tool is a 1:1 calfkit ToolNodeDef serving name-derived topics (tool.<name>.input / tool.<name>.output). For node contracts, deps/resource wiring, env configuration, and the trust model, see:

Contributing

Contributions are welcome. See CONTRIBUTING.md for the dev setup and how to add a tool. Questions and bug reports are welcome at GitHub Issues.

License

Apache-2.0 © calf-ai. The distribution also bundles third-party components under the MIT license; see THIRD_PARTY_NOTICES.md for the full attribution index. The combined SPDX expression is Apache-2.0 AND MIT.

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

calfkit_tools-0.1.3.tar.gz (770.5 kB view details)

Uploaded Source

Built Distribution

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

calfkit_tools-0.1.3-py3-none-any.whl (531.0 kB view details)

Uploaded Python 3

File details

Details for the file calfkit_tools-0.1.3.tar.gz.

File metadata

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

File hashes

Hashes for calfkit_tools-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9a80b2ef713ebf3cc7d6b4e49d65d433999ba900dace1ea5ef1a42092e9fe770
MD5 8a6a4184348dff6616bd2bd38c0afcdf
BLAKE2b-256 7598485eb3bd14f00e30fe14a9506d4bd3850dafce47dab0ba6e5751b2839d07

See more details on using hashes here.

Provenance

The following attestation bundles were made for calfkit_tools-0.1.3.tar.gz:

Publisher: release.yml on calf-ai/calfkit-peripherals

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

File details

Details for the file calfkit_tools-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: calfkit_tools-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 531.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for calfkit_tools-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 39176052b12da04bd0ace5e840cd9fc82a7869d49814f33c704bf11fc3b64cba
MD5 9c86de86a57cc90ae224714215e8c584
BLAKE2b-256 63cde5ec935978b72e2d0f361bce5a3c8439adc7ee708775b6debce5998cd890

See more details on using hashes here.

Provenance

The following attestation bundles were made for calfkit_tools-0.1.3-py3-none-any.whl:

Publisher: release.yml on calf-ai/calfkit-peripherals

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