Declarative tool interface contracts for agentic runtimes — typed parameters, command templates, evidence envelopes, session and browser modes
Project description
ToolClad
Declarative tool interface contracts for agentic runtimes.
ToolClad is a manifest format (.clad.toml) that defines the complete behavioral contract for a tool: typed parameters, validation rules, invocation mechanism, output parsing, and policy metadata. Three execution modes share a common governance layer:
- Oneshot (default): Single CLI command execution
- Session: Interactive CLI tools via PTY (msfconsole, psql, redis-cli) with per-interaction Cedar gating
- Browser: Governed headless browser via CDP/Playwright with URL scope enforcement and page state policies
The Problem
Every team building agentic systems writes custom glue code per tool: argument sanitization, timeout enforcement, output parsing, evidence capture, Cedar mappings, DSL capabilities, and policies. That's 7 steps per tool. It doesn't scale.
The Solution
# tools/whois_lookup.clad.toml
[tool]
name = "whois_lookup"
version = "1.0.0"
binary = "whois"
description = "WHOIS domain/IP registration lookup"
timeout_seconds = 30
risk_tier = "low"
[args.target]
position = 1
required = true
type = "scope_target"
description = "Domain name or IP address to query"
[command]
template = "whois {target}"
[output]
format = "text"
envelope = true
[output.schema]
type = "object"
[output.schema.properties.raw_output]
type = "string"
The agent fills typed parameters. The executor validates, constructs the command, executes with timeout, and returns structured JSON. The agent never sees or generates a shell command.
Security Model
ToolClad inverts the sandbox approach:
- Sandbox: LLM generates command -> sandbox intercepts -> allow/deny (deny-list)
- ToolClad: LLM fills typed parameters -> policy gate -> executor validates -> constructs command from template (allow-list)
The dangerous action cannot be expressed because the interface doesn't permit it.
Security Features
- Shell injection prevention: All string types reject metacharacters (
;|&$\(){}[]<>!\n\r`) by default - Array-based execution: Commands dispatched via direct
execve(nosh -cshell interpretation) - Process group isolation: Tools spawned in new PGID; timeout kills entire process group (no zombies)
- Absolute path blocking:
pathtype rejects/etc/shadow,C:\...style paths - Newline injection blocking:
\nand\rrejected in all string-based types - No eval: Conditional evaluators use closed-vocabulary parsers, never dynamic code execution
Packages
Install from your language's package registry:
cargo install toolclad # Rust / crates.io
pip install toolclad # Python / PyPI
npm install toolclad # JavaScript / npm
| Language | Registry | Package |
|---|---|---|
| Rust | crates.io | cargo install toolclad |
| Python | PyPI | pip install toolclad |
| JavaScript | npm | npm install toolclad |
| Go | Source | go install ./go/cmd/toolclad |
Reference Implementations
Each implementation provides:
- Manifest parsing -- load and validate
.clad.tomlfiles (oneshot, session, browser modes) - 14 type validators -- 10 core + 4 extended, all with injection sanitization
- Command construction -- template interpolation with mappings, conditionals, defaults
- Execution -- direct argv dispatch, process group kill on timeout, SHA-256 evidence hashing
- Output parsers -- builtin:json, builtin:xml, builtin:csv, builtin:jsonl, builtin:text, custom scripts
- Output schema validation -- validates parsed results against
[output.schema] - MCP schema generation -- auto-generate inputSchema + outputSchema for LLM tool use
- Evidence envelopes -- structured JSON with scan_id, timestamps, exit_code, stderr, output_hash
- CLI --
validate,run,schema,test(dry run) subcommands
Quick Start
# Rust
cd rust && cargo run -- test ../examples/whois_lookup.clad.toml --arg target=example.com
# Python
cd python && pip install -e . && toolclad test ../examples/whois_lookup.clad.toml --arg target=example.com
# JavaScript
cd js && npm install && node src/cli.js test ../examples/whois_lookup.clad.toml --arg target=example.com
# Go
cd go && go run ./cmd/toolclad test ../examples/whois_lookup.clad.toml --arg target=example.com
Type System
Core Types
| Type | Validates | Examples |
|---|---|---|
string |
Non-empty, injection-safe, optional regex pattern |
General text |
integer |
Numeric, optional min/max with clamp |
Thread counts |
port |
1-65535 | Network ports |
boolean |
Exactly "true" or "false" |
Feature flags |
enum |
Value in declared allowed list |
Scan types |
scope_target |
Injection-safe, no wildcards, valid IP/CIDR/hostname | Targets |
url |
Valid URL, optional schemes restriction, scope_check |
Web targets |
path |
No traversal (../), no absolute paths |
File paths |
ip_address |
Valid IPv4 or IPv6 | Addresses |
cidr |
Valid CIDR notation (IPv4 + IPv6) | Network ranges |
Extended Types
| Type | Validates | Use Case |
|---|---|---|
msf_options |
Semicolon-delimited set KEY VALUE pairs |
Metasploit options |
credential_file |
Relative path + must exist | Username/password lists |
duration |
Integer with suffix (30, 5m, 2h) |
Timeout overrides |
regex_match |
Matches declared pattern (required) |
Module paths |
Custom Types
Define reusable types in toolclad.toml at the project root:
[types.service_protocol]
base = "enum"
allowed = ["ssh", "ftp", "http", "https", "smb", "rdp"]
[types.severity_level]
base = "enum"
allowed = ["info", "low", "medium", "high", "critical"]
Reference in manifests: type = "service_protocol"
Output Handling
Built-in Parsers
| Parser | Use Case |
|---|---|
builtin:json |
Tools with native JSON output |
builtin:xml |
nmap, Nessus, OWASP ZAP |
builtin:csv |
Spreadsheet exports, log files |
builtin:jsonl |
Nuclei, streaming tools |
builtin:text |
Simple unstructured output (default) |
Custom Parsers
[output]
parser = "scripts/parse-outputs/parse-nmap-xml.py"
Custom parsers receive the raw output file path as argv[1] and emit JSON to stdout.
Evidence Envelope
Every execution returns a structured envelope:
{
"status": "success",
"scan_id": "1711929600-12345",
"tool": "nmap_scan",
"command": "nmap -sT -sV --max-rate 1000 10.0.1.0/24",
"duration_ms": 4523,
"timestamp": "2026-03-20T12:00:00Z",
"exit_code": 0,
"stderr": "",
"output_hash": "sha256:a1b2c3...",
"results": { "hosts": [...] }
}
On error, exit_code and stderr are included so LLM agents can self-correct.
Symbiont Integration
ToolClad is the tools/ directory convention for Symbiont:
- Runtime auto-discovers
.clad.tomlfiles at startup - Registers each tool as an MCP tool in the ORGA reasoning loop
- Cedar policy evaluation using manifest-declared
[tool.cedar]resource/action - Scope enforcement against
scope/scope.toml - Cedar policy auto-generation from manifest
risk_tier - Hot-reload in development mode
symbi tools list/validate/test/schema/initCLI
symbi tools list # show discovered tools
symbi tools test nmap_scan --arg target=10.0.1.0/24 --arg scan_type=service
symbi tools schema nmap_scan # output MCP JSON Schema
symbi tools init my_scanner # scaffold new manifest
SchemaPin Integration
SchemaPin signs .clad.toml files directly as first-class artifacts:
schemapin-sign tools/nmap_scan.clad.toml
The signature covers the entire behavioral contract. If anyone tampers with a command template, validation rule, scope constraint, or output schema, the hash changes and verification fails.
See TOOLCLAD_DESIGN_SPEC.md for the full specification.
License
- Protocol specification (manifest format, type system, evidence envelope): MIT
- Symbiont integration (Cedar gating, ORGA enforcement, scope enforcement): Apache 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file toolclad-0.6.0.tar.gz.
File metadata
- Download URL: toolclad-0.6.0.tar.gz
- Upload date:
- Size: 31.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b657ea03af65af18ab03a692add7769efdfb6bdcae5d86274b0baf65e637c58e
|
|
| MD5 |
4daa84e3e17b7ca6da95e755b8adde80
|
|
| BLAKE2b-256 |
29ba7fc14e4cf49f2fc13bf402c1378ae47cd427d9b0d7dcbb628ee084b4c450
|
File details
Details for the file toolclad-0.6.0-py3-none-any.whl.
File metadata
- Download URL: toolclad-0.6.0-py3-none-any.whl
- Upload date:
- Size: 30.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f61845e1361024d0059e0d3b4cc31274e22918c6fa830454367f96289552a93d
|
|
| MD5 |
e04e6f5f99d9314b4148e79a9a634fee
|
|
| BLAKE2b-256 |
366213674879c48f1d554427420ef4fdefc48b6c2bc118c98d80d556befa8633
|