Back to Directory/Media & Images

ImageStep

The image pipeline for agents: presets, assets and jobs. Answers with asset ids and stable URLs.

Media & ImagesJavaScriptv0.1.0

ImageStep SDK

The client side of ImageStep, the image step for your automations: generate, edit, remove backgrounds, upscale, convert and read metadata as one reliable step in your code, an n8n workflow or an AI agent.

Everything that runs on your side of the API lives here:

DirectoryPackageWhat it is
sdk/jsimagestep on npmJavaScript SDK for Node 20+, Deno, Bun and edge runtimes. Zero runtime dependencies, ESM + CommonJS, typed
sdk/pythonimagestep on PyPIPython SDK for Python 3.10+, with a sync and an async client
apps/cliimagestep-cli on npmThe command-line client, binary imagestep
packages/mcp@imagestep/mcp on npmMCP server: presets, assets and jobs as tools for agents. Also hosted at https://mcp.imagestep.dev/mcp
packages/n8n-nodes-imagestepn8n-nodes-imagestep on npmn8n community node and trigger
skills/imagestep—Agent skill for Claude Code, Codex or Cursor: npx skills add imagestep/imagestep-sdk
recipes—Complete pipelines to copy: a JS SDK script, an n8n template and a README each

Each directory has its own README. The documentation is at imagestep.dev/docs, and the API reference at imagestep.dev/docs/api.

Quick start

Create an API key at imagestep.dev/keys, then:

npm install imagestep
import { ImageStep } from "imagestep";

const client = new ImageStep({ apiKey: process.env.IMAGESTEP_API_KEY });

const asset = await client.assets.upload("./product.jpg");
const job = await client.ops.removeBg(asset.id, { wait: true });
const [cutout] = await client.jobs.outputs(job);
const [published] = await client.assets.publish(cutout.id);
console.log(published.publicUrl);

How this repository works

The code here is exported from ImageStep's main repository, where the API and its clients change together, in one commit. Each commit here is a snapshot of that export, and releases are tagged here: a v* tag publishes every package whose version is not on npm or PyPI yet, with provenance, from this repository's GitHub Actions.

Issues and pull requests are welcome; see CONTRIBUTING.md. To report a vulnerability, see SECURITY.md.

Development

pnpm install          # Node 22.19+ for the workspace (the CLI's floor); pnpm is pinned by packageManager
pnpm check            # lint + format
pnpm test             # every JavaScript package's unit tests
pnpm test:python      # the Python SDK's tests (needs uv)

License

MIT, see LICENSE. Every package carries its own LICENSE and THIRD-PARTY-NOTICES.md.

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
npx -y @imagestep/mcp

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "dev-imagestep-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@imagestep/mcp"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

@imagestep/mcpnpm

Compatible MCP Clients

ImageStep works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More