swamp

Swamp — API Modeling & *Claw Enrichment

You are an AI agent that uses Swamp to model any API, test it, and turn it into a reusable *Claw capability. Swamp is an AI-native automation CLI that represents external resources (APIs, CLIs, cloud services) as typed models with executable methods and composable workflows.

Repository Setup

Before any operation, check if the current directory is a swamp repository. If not, initialize one:

swamp repo init --tool claude

This creates a .swamp/ directory with the necessary structure. Use --tool claude to set up the AI agent integration for Claude/OpenClaw.

API Modeling Workflow

Step 1: Discover Model Types

Find available model types to understand what kinds of resources can be modeled:

swamp model type search
swamp model type describe 

The command/shell type is the most versatile — it can model any API via shell commands (curl, httpie, CLI tools).

Step 2: Create a Model

Create a new model definition for the API:

swamp model create  

Example: swamp model create command/shell github-issues

Step 3: Edit the Model Definition

Open and edit the model's YAML definition to configure endpoints, authentication, parameters, and methods:

swamp model edit 

When editing, define:

Step 4: Validate

Ensure the model definition is well-formed:

swamp model validate 

Fix any validation errors before proceeding.

Testing & Execution

Run a Method

Execute a method on your model to test it:

swamp model method run  

Inspect Results

Check outputs, logs, and data from the execution:

swamp model output get 
swamp model output logs 
swamp model output data 

Review History

See past executions:

swamp model method history search
swamp model method history get 

Iterate on the model definition until methods return the expected results.

Workflow Orchestration

Chain multiple model methods into automated workflows with dependency ordering:

swamp workflow create 
swamp workflow edit 
swamp workflow validate 
swamp workflow run 

Workflows support:

Check workflow results:

swamp workflow history get 
swamp workflow history logs 

Vault & Credentials

Store API keys and secrets securely — never hardcode them:

swamp vault create  
swamp vault put  
swamp vault list-keys 

Reference secrets in model definitions using CEL expressions like vault.get("my-vault", "API_KEY").

Data Management

Inspect outputs and artifacts across models:

swamp data list 
swamp data get  
swamp data search 

Swamp-Club Authentication

Swamp-club is the community registry and collaboration layer. Authenticate to push/pull extensions and share work:

swamp auth login
swamp auth login --server 
swamp auth whoami
swamp auth logout

Authentication is required before pushing extensions to the registry.

Extensions

Extensions expand Swamp's model types and capabilities. Use the extension registry to share and reuse custom models:

Pull an Extension

Install a community or team extension from the registry:

swamp extension pull 
swamp extension pull  --force

Use --force to overwrite existing files without prompting.

List Installed Extensions

See what extensions are currently installed:

swamp extension list

Push an Extension

Publish your own extension to the swamp registry (requires swamp auth login first):

swamp extension push 
swamp extension push  --dry-run

Use --dry-run to build the archive locally and verify it without actually publishing. Use -y to skip confirmation prompts.

Remove an Extension

Uninstall a pulled extension and clean up its files:

swamp extension remove 

Extension Workflow

The typical flow for extending Swamp with new model types:

1. Create custom TypeScript model definitions in extensions/models/ 2. Test locally with swamp model create 3. Package with a manifest file 4. Dry-run: swamp extension push ./manifest.yaml --dry-run 5. Publish: swamp extension push ./manifest.yaml 6. Others install: swamp extension pull

Enriching *Claw with New Capabilities

Once a Swamp model is validated and working, turn it into a standalone *Claw skill:

1. Export the model: Use swamp model get --json to extract the full definition 2. Generate a SKILL.md: Create a new skill file that wraps the Swamp model's methods as agent instructions 3. Include setup instructions: Document the required env vars, binaries, and vault configuration 4. Publish to ClawHub: Share the skill with the community via clawhub publish

The generated skill should:

Sharing via Extensions

For reusable model types (not just individual models), publish as a Swamp extension:

1. Build the custom model type in extensions/models/ 2. Push to the Swamp registry: swamp extension push ./manifest.yaml 3. Create a *Claw skill that pulls the extension and uses it: swamp extension pull

This creates a two-layer sharing model: extensions for model types (Swamp registry), skills for agent workflows (ClawHub).

Examples

Model a REST API

> "Model the JSONPlaceholder API so I can list and create posts"

1. swamp model create command/shell jsonplaceholder 2. Edit to add methods: list-posts (GET /posts), create-post (POST /posts) 3. swamp model method run jsonplaceholder list-posts 4. Verify output, iterate

Set Up a Weather Integration

> "Create a weather model that fetches forecasts by city"

1. swamp model create command/shell weather 2. Edit to add a forecast method using curl -s "wttr.in/{city}?format=j1" 3. Test with swamp model method run weather forecast

Chain APIs in a Workflow

> "Create a workflow that fetches GitHub issues, summarizes them, and posts to Slack"

1. Create models: github-issues, slack-webhook 2. Create workflow: swamp workflow create issue-digest 3. Define jobs with dependencies: fetch issues -> format summary -> post to Slack 4. swamp workflow run issue-digest

Graduate to a *Claw Skill

> "Turn my working weather model into a skill others can install"

1. swamp model get weather --json to export 2. Create a new SKILL.md wrapping the weather model commands 3. clawhub publish ./weather-skill

Share a Custom Extension

> "Publish my custom Stripe model type so the team can use it"

1. swamp auth login to authenticate with swamp-club 2. swamp extension push ./stripe-models/manifest.yaml --dry-run to verify 3. swamp extension push ./stripe-models/manifest.yaml to publish 4. Team members install: swamp extension pull stripe-models

Important Notes

Model a REST API

> "Model the JSONPlaceholder API so I can list and create posts"

1. swamp model create command/shell jsonplaceholder 2. Edit to add methods: list-posts (GET /posts), create-post (POST /posts) 3. swamp model method run jsonplaceholder list-posts 4. Verify output, iterate

Set Up a Weather Integration

> "Create a weather model that fetches forecasts by city"

1. swamp model create command/shell weather 2. Edit to add a forecast method using curl -s "wttr.in/{city}?format=j1" 3. Test with swamp model method run weather forecast

Chain APIs in a Workflow

> "Create a workflow that fetches GitHub issues, summarizes them, and posts to Slack"

1. Create models: github-issues, slack-webhook 2. Create workflow: swamp workflow create issue-digest 3. Define jobs with dependencies: fetch issues -> format summary -> post to Slack 4. swamp workflow run issue-digest

Graduate to a *Claw Skill

> "Turn my working weather model into a skill others can install"

1. swamp model get weather --json to export 2. Create a new SKILL.md wrapping the weather model commands 3. clawhub publish ./weather-skill

Share a Custom Extension

> "Publish my custom Stripe model type so the team can use it"

1. swamp auth login to authenticate with swamp-club 2. swamp extension push ./stripe-models/manifest.yaml --dry-run to verify 3. swamp extension push ./stripe-models/manifest.yaml to publish 4. Team members install: swamp extension pull stripe-models