Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ jobs:
- run: pnpm run build:binary
- run: ./dist/sume --version
- run: ./dist/sume --json tools schema jobs.watch > /tmp/jobs-watch-schema.json
- run: ./dist/sume --json tools schema jobs.wait > /tmp/jobs-wait-schema.json
- run: ./dist/sume --json tools schema assets.create > /tmp/assets-create-schema.json
- run: ./dist/sume --json tools schema assets.upload_file > /tmp/assets-upload-file-schema.json
- run: ./dist/sume --json tools schema assets.get > /tmp/assets-get-schema.json
- run: ./dist/sume --json tools schema avatars.create > /tmp/avatars-create-schema.json
- run: ./dist/sume --json tools schema avatar-videos.create > /tmp/avatar-videos-create-schema.json
Expand All @@ -46,6 +44,8 @@ jobs:
- run: grep -q '"skills"' /tmp/root-metadata.json
- run: grep -q '"balance"' /tmp/root-metadata.json
- run: grep -q '"usage"' /tmp/root-metadata.json
- run: grep -q '"coming_soon"' /tmp/root-metadata.json
- run: grep -q '"mcp_status"' /tmp/root-metadata.json
- run: ./dist/sume balance --help > /tmp/balance-help.txt
- run: ./dist/sume usage get --help > /tmp/usage-help.txt
- run: |
Expand Down
8 changes: 2 additions & 6 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,7 @@ jobs:
BIN="./dist/sume.exe"
./dist/sume.exe --version
./dist/sume.exe --json tools schema jobs.watch > jobs-watch-schema.json
./dist/sume.exe --json tools schema jobs.wait > jobs-wait-schema.json
./dist/sume.exe --json tools schema assets.create > assets-create-schema.json
./dist/sume.exe --json tools schema assets.upload_file > assets-upload-file-schema.json
./dist/sume.exe --json tools schema assets.get > assets-get-schema.json
./dist/sume.exe --json tools schema avatars.create > avatars-create-schema.json
./dist/sume.exe --json tools schema avatar-videos.create > avatar-videos-create-schema.json
Expand All @@ -106,9 +104,7 @@ jobs:
BIN="./dist/sume"
./dist/sume --version
./dist/sume --json tools schema jobs.watch > jobs-watch-schema.json
./dist/sume --json tools schema jobs.wait > jobs-wait-schema.json
./dist/sume --json tools schema assets.create > assets-create-schema.json
./dist/sume --json tools schema assets.upload_file > assets-upload-file-schema.json
./dist/sume --json tools schema assets.get > assets-get-schema.json
./dist/sume --json tools schema avatars.create > avatars-create-schema.json
./dist/sume --json tools schema avatar-videos.create > avatar-videos-create-schema.json
Expand All @@ -118,6 +114,8 @@ jobs:
grep -q '"skills"' root-metadata.json
grep -q '"balance"' root-metadata.json
grep -q '"usage"' root-metadata.json
grep -q '"coming_soon"' root-metadata.json
grep -q '"mcp_status"' root-metadata.json
"$BIN" balance --help > balance-help.txt
"$BIN" usage get --help > usage-help.txt
if "$BIN" --json catalog > catalog-parent.out 2> catalog-parent.err; then
Expand All @@ -126,9 +124,7 @@ jobs:
fi
grep -q "missing_subcommand" catalog-parent.err
test -s jobs-watch-schema.json
test -s jobs-wait-schema.json
test -s assets-create-schema.json
test -s assets-upload-file-schema.json
test -s assets-get-schema.json
test -s avatars-create-schema.json
test -s avatar-videos-create-schema.json
Expand Down
133 changes: 11 additions & 122 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Sume CLI

Agent-first CLI and MCP tooling for the future `sume.com` public API platform.
Agent-first CLI tooling for the future `sume.com` public API platform.

This repository contains the public CLI for the `sume.com` developer platform.
It follows these product boundaries:

- thin CLI wrappers over public API endpoints;
- stable JSON for agents and scripts;
- explicit API-key configuration;
- MCP tools built from the same API/client boundary;
- no direct dependency on app internals, databases, queues, or provider APIs.

## Status
Expand Down Expand Up @@ -170,7 +169,6 @@ sume jobs events <job_id> --agent --json
sume jobs result <job_id> --agent --json
sume jobs download <job_id> --output-dir ./outputs --json
sume jobs cancel <job_id> --confirm-submit --agent --json
sume mcp
sume tools list --json
sume tools schema jobs.result --json
sume tools schema avatars.create_photo_url --json
Expand All @@ -192,11 +190,9 @@ API; it reports version, auth source, API base URL, safety gates, and tool
counts.

`sume tools list --json` and `sume tools schema <name> --json` expose the
current agent-facing command contracts, safety metadata, confirmation
requirements, and separate CLI/MCP input contracts. `input_schema` describes
CLI flags. `mcp_input_schema` describes the MCP tool payload; submit MCP tools
use `{ "payload": { ...apiBody }, "idempotency_key": "..." }`, with
`avatars.create` also accepting an optional public `model`.
current agent-facing CLI command contracts, safety metadata, confirmation
requirements, and launch status metadata. `input_schema` describes CLI flags.
MCP fields are reported as not launched yet in this public CLI release.

Supported API command groups call only current `api.sume.com` API routes:

Expand Down Expand Up @@ -289,126 +285,19 @@ sume skills install sume-assets --json
The bundled skills are current `api.sume.com` packs: `sume`, `sume-tools`,
`sume-assets`, `sume-avatar`, and `sume-avatar-video`. They document auth,
redaction, Avatar 1.0, Avatar Video 1.0, batch planning, jobs, balance, usage,
MCP setup, and advanced compatibility asset handling. They explicitly exclude
schema discovery, and advanced compatibility asset handling. They explicitly exclude
old `sume.so` Brand, Ads, Face Swap, generic generation, raw provider,
billing-write, and file workflows.

## MCP

Start the local stdio MCP server:
Sume MCP is coming soon and is not part of this public CLI launch release yet.
Use direct CLI commands today for auth, schema discovery, Avatar, Avatar Video,
jobs, balance, and usage workflows.

```bash
sume mcp
```

Set up a supported agent client with the default read-only MCP server:

```bash
sume setup agent --agent codex
sume setup agent --agent claude-code
sume setup agent --agent cursor
```

Install the read-only MCP server config for a supported client:

```bash
sume mcp install --agent codex
sume mcp install --agent claude-code
sume mcp install --agent cursor
```

Preview the generated config without writing files:

```bash
sume mcp install --agent codex --dry-run
sume mcp install --agent claude-code --dry-run
sume mcp install --agent cursor --dry-run
```

Check local MCP client readiness:

```bash
sume mcp doctor
sume mcp doctor --agent codex --json
```

The generated snippets run only `sume mcp`, which exposes the default read-only
toolset. They do not enable write or paid MCP tools.

The MCP toolset includes read-only inspection tools:

- `tools.list`
- `tools.schema`
- `health.service`
- `health.v1`
- `account.me`
- `catalog.list`
- `jobs.list`
- `jobs.get`
- `jobs.status`
- `jobs.events`
- `jobs.result`
- `jobs.wait`
- `avatars.list`
- `avatars.get`
- `avatars.wait`
- `avatar-videos.list`
- `avatar-videos.get`

Submit tools are not exposed by default. Advanced compatibility asset tools are
also not exposed by default because `/v1/assets/*` is hidden from the launch
OpenAPI/catalog. To expose asset registration for a deliberate internal or
agent session, opt into the asset toolset and the write gate:

```bash
sume mcp --toolsets account,catalog,jobs,assets --allow-write
```

That adds:

- `assets.create`
- `assets.upload_url`
- `assets.upload_file`
- `assets.complete`
- `jobs.cancel`

`assets.upload_file` is an MCP-only local workflow helper. It creates a signed
upload URL, PUTs the supplied local file bytes to that URL, completes the asset,
and returns only agent-redacted metadata. It does not return the signed upload
URL, storage headers, or the local absolute file path. MCP local file uploads
are capped at 512 MiB in this release; use the lower-level public API upload
URL flow when a host needs full control.

Paid generation avatar submit tools also require the paid gate:

```bash
sume mcp --toolsets account,catalog,jobs,avatars,avatar-videos --allow-write --allow-paid
```

That adds:

- `avatars.create`
- `avatars.create_prompt`
- `avatars.create_props`
- `avatars.create_photo_url`
- `avatar-videos.create`

The submit MCP tools are annotated as non-read-only, URL-returning, and
agent-redaction-required. Asset write helpers are advanced compatibility write
operations but not paid generation calls. Avatar and avatar-video submit tools use
`generation_runtime: sume_api`. `avatars.create` remains the
exact-payload escape hatch. The typed avatar helpers build common Avatar 1.0
prompt, profile, and public-photo URL requests, add normalized `avatar_summary`
fields for agent readback, and keep signed upload/download URLs internal. Use
`avatars.wait` to poll an avatar job and read grouped public artifact URLs when
available. Their `tools schema` entries also show the required
confirmation gates: CLI submit commands require `--confirm-submit` or
`--confirm-paid` for paid generation submits and `--confirm-submit` for asset
registration. MCP asset registration requires a session started with
`--allow-write`; paid generation submits require both `--allow-write` and
`--allow-paid`. Future file, billing-write, and unsupported generation tools
must remain behind explicit opt-in gates after public API contracts exist.
For a toolset-focused setup guide, see [docs/mcp-toolsets.md](docs/mcp-toolsets.md).
The open-source repository may contain MCP implementation code while the
capability is being prepared. Public MCP setup and server startup are not
launched yet, and the CLI does not write MCP client config in this release.

## Website

Expand Down
17 changes: 4 additions & 13 deletions agent/sume-assets/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ public HTTPS URLs directly.

```bash
sume tools schema assets.create --json
sume tools schema assets.upload_file --json
sume tools schema assets.upload_url --json
sume tools schema assets.complete --json
sume tools schema assets.download_url --json
```

Expand All @@ -34,18 +35,8 @@ echo the original source URL in readback.

## Direct Upload

For MCP, prefer:

```bash
sume mcp --toolsets assets --allow-write
```

Call `assets.upload_file` with a local path and content type. It performs
upload-url, signed PUT, and complete internally without returning the signed URL
or local absolute path.

For shell workflows, use `assets upload-url`, PUT bytes outside the CLI, then
`assets complete`. Never paste signed URLs into reports.
Use `assets upload-url`, PUT bytes outside the CLI, then `assets complete`.
Never paste signed URLs into reports.

## Download

Expand Down
4 changes: 2 additions & 2 deletions agent/sume-assets/references/media-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

- Signed upload URLs and headers are temporary credentials.
- Do not send Sume API auth headers to signed storage URLs.
- `assets.upload_file` and `sume assets upload-file` style helpers should keep
signed URLs internal and return only redacted asset metadata.
- Direct upload helpers should keep signed URLs internal and return only
redacted asset metadata.

## Download Safety

Expand Down
2 changes: 1 addition & 1 deletion agent/sume-avatar/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this skill for Avatar 1.0 creation and selection.
```bash
sume tools schema avatars.create --json
sume tools schema avatars.list --json
sume tools schema jobs.wait --json
sume tools schema jobs.watch --json
```

## Single Avatar
Expand Down
29 changes: 4 additions & 25 deletions agent/sume-tools/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
---
name: sume-tools
description: Configure Sume.com CLI/MCP for agents, discover tool schemas, install or export bundled Sume skills, inspect balance/usage, and choose safe public-api workflows.
description: Discover Sume.com CLI tool schemas, install or export bundled Sume skills, inspect balance/usage, and choose safe public-api workflows.
---

# Sume Tools

Use this skill for setup, MCP toolset selection, schema discovery, and local
skill maintenance.
Use this skill for schema discovery and local skill maintenance.

## Discovery

```bash
sume setup agent --agent codex
sume mcp doctor --json
sume doctor --agent --json
sume tools list --json
sume tools schema avatars.create --json
sume tools schema avatars.create_photo_url --json
sume tools schema avatar-videos.create --json
sume balance --json
sume usage get --json
Expand All @@ -36,25 +32,8 @@ Skills install into `.agents/skills/` when `.agents/` exists, otherwise

## MCP

Default MCP is read-only:

```bash
sume mcp
sume mcp install --agent codex
sume mcp doctor --agent codex --json
```

Use explicit gates only after approval:

```bash
sume mcp --toolsets jobs --allow-write
sume mcp --toolsets avatars,avatar-videos --allow-write --allow-paid
```

Paid MCP calls still require per-call `idempotency_key` and `max_spend_usd`.
Use `dry_run: true` before submitting.

Read `references/mcp-toolsets.md` before enabling non-default tools.
Sume MCP is coming soon and is not part of this public CLI launch release yet.
Use direct CLI commands today.

## Not For

Expand Down
51 changes: 9 additions & 42 deletions agent/sume-tools/references/mcp-toolsets.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,13 @@
# MCP Toolsets
# MCP Coming Soon

## Default

`sume mcp` exposes read-only, agent-redacted tools:

- `tools.list`, `tools.schema`
- `health.service`, `health.v1`
- `account.me`, `balance.get`, `usage.get`
- `catalog.list`
- `jobs.list`, `jobs.get`, `jobs.status`, `jobs.events`, `jobs.result`, `jobs.wait`
- `avatars.list`, `avatars.get`, `avatars.wait`
- `avatar-videos.list`, `avatar-videos.get`

## Write Gate

```bash
sume mcp --toolsets jobs --allow-write
```

Adds non-paid writes such as `jobs.cancel`.

Advanced compatibility asset tools are hidden from the launch OpenAPI/catalog
and are not part of default MCP. Use them only when explicitly requested:
Sume MCP is coming soon and is not part of this public CLI launch release yet.
Use direct CLI commands today for auth, schema discovery, Avatar, Avatar Video,
jobs, balance, and usage workflows.

```bash
sume mcp --toolsets assets --allow-write
sume login
sume doctor --agent --json
sume tools list --json
sume tools schema avatars.create --json
sume tools schema avatar-videos.create --json
```

This exposes `assets.create`, `assets.upload_url`, `assets.upload_file`,
`assets.complete`, and readback helpers.

## Paid Gate

```bash
sume mcp --toolsets avatars,avatar-videos --allow-write --allow-paid
```

Adds paid generation `avatars.create`, `avatars.create_prompt`,
`avatars.create_props`, `avatars.create_photo_url`, and `avatar-videos.create`.

Paid tool calls require per-call `idempotency_key` and `max_spend_usd`. Use
`dry_run: true` to run a non-submitting Sume cost/readiness preview without creating a job.

Use `jobs.wait` and `jobs.result` for readback. Do not ask MCP to reveal signed
URLs or private media URLs.
Loading
Loading