# OpenSora 2 Prompt MCP

A deterministic, read-only MCP server for designing video prompts and shot plans. It complements the independent resources at [OpenSora2.com](https://opensora2.com) and does not generate videos, call model providers, access accounts, or spend credits.

## Tools

- `build_video_prompt` turns a rough idea into a structured prompt pack.
- `plan_shots` creates a timed 1–6 shot sequence with continuity anchors.
- `diagnose_prompt` finds missing motion, camera, lighting, and continuity controls.
- `get_resources` returns canonical OpenSora2.com guides and workflow pages.

All tools are deterministic and declare read-only MCP annotations. No API key is required.

## Install

Run directly from GitHub:

```json
{
  "mcpServers": {
    "opensora2": {
      "command": "npx",
      "args": ["-y", "github:gpt-img-2/opensora2-prompt-mcp"]
    }
  }
}
```

Or clone and run locally:

```bash
pnpm install
pnpm build
node dist/index.js
```

Optional environment variable:

- `OPENSORA2_APP_BASE_URL`: changes the resource-link origin. Defaults to `https://opensora2.com`.

## Example inputs

Build a prompt:

```json
{
  "idea": "A red ceramic teapot steams on a rain-streaked cafe window",
  "workflow": "image-to-video",
  "camera": "slow 10 cm push-in",
  "motion": "steam curls upward while raindrops slide down the glass",
  "referenceConstraints": "teapot silhouette, glaze pattern, and window composition"
}
```

Plan shots:

```json
{
  "idea": "A trail shoe crosses wet rock and lands in a shallow stream",
  "shotCount": 3,
  "totalDurationSeconds": 9,
  "continuityAnchor": "shoe color, laces, runner wardrobe, and travel direction"
}
```

## OpenClaw Skill

The companion Skill is in [`openclaw/opensora-video-prompt-architect`](openclaw/opensora-video-prompt-architect/SKILL.md). It works as a text-only workflow without this MCP; connecting the MCP adds deterministic prompt-building and diagnostic tools.

## Development

```bash
pnpm validate
pnpm test:smoke
```

This project is an independent prompt-design utility and is not the official Open-Sora project or an official model implementation.

- [中文说明](README.zh-CN.md)
- [OpenSora 2 prompt guide](https://opensora2.com/blog/opensora-2-prompt-guide)
- [OpenSora 2 generator workspace](https://opensora2.com/generator)

## License

MIT