> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Sora MCP 對接指南

> sora MCP 服务器集成

[MCP（Model Context Protocol）](https://modelcontextprotocol.io) 是由 Anthropic 推出的模型上下文協議，允許 AI 模型（如 Claude、GPT 等）通過標準化接口調用外部工具。通過 XHuoAPI 提供的 Sora MCP Server，你可以在 Claude Desktop、VS Code、Cursor 等 AI 客戶端中直接使用 OpenAI Sora 生成 AI 視頻。

## 功能概覽

Sora MCP Server 提供以下核心功能：

* **文本生成視頻** — 通過文本提示詞生成高質量視頻
* **圖片生成視頻** — 以圖片為基礎生成視頻
* **角色一致性視頻** — 使用參考圖保持角色一致性
* **異步生成** — 支持異步任務提交和結果查詢
* **多種畫面方向** — 支持橫屏（landscape）和豎屏（portrait）
* **任務查詢** — 監控生成進度並獲取結果

## 前置準備

使用前，你需要獲取 XHuoAPI API Token：

1. 註冊或登錄 [XHuoAPI 平台](https://api.xhuoapi.ai)
2. 前往 [Sora Videos API](https://api.xhuoapi.ai/documents/sora-videos) 頁面
3. 點擊「Acquire」獲取 API Token（首次申請贈送免費額度）

## 安裝配置

### 方式一：pip 安裝（推薦）

```bash theme={null}
pip install mcp-sora
```

### 方式二：源碼安裝

```bash theme={null}
git clone https://github.com/XHuoAPI/SoraMCP.git
cd SoraMCP
pip install -e .
```

安裝完成後，即可使用 `mcp-sora` 命令啟動服務。

## 在 Claude Desktop 中使用

編輯 Claude Desktop 配置文件：

* **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
* **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

添加以下配置：

```json theme={null}
{
  "mcpServers": {
    "sora": {
      "command": "mcp-sora",
      "env": {
        "XHuoAPI_API_TOKEN": "你的API Token"
      }
    }
  }
}
```

如果使用 `uvx`（無需提前安裝包）：

```json theme={null}
{
  "mcpServers": {
    "sora": {
      "command": "uvx",
      "args": ["mcp-sora"],
      "env": {
        "XHuoAPI_API_TOKEN": "你的API Token"
      }
    }
  }
}
```

保存配置後重啟 Claude Desktop，即可在對話中使用 Sora 相關工具。

## 在 VS Code / Cursor 中使用

在項目根目錄創建 `.vscode/mcp.json`：

```json theme={null}
{
  "servers": {
    "sora": {
      "command": "mcp-sora",
      "env": {
        "XHuoAPI_API_TOKEN": "你的API Token"
      }
    }
  }
}
```

或者使用 `uvx`：

```json theme={null}
{
  "servers": {
    "sora": {
      "command": "uvx",
      "args": ["mcp-sora"],
      "env": {
        "XHuoAPI_API_TOKEN": "你的API Token"
      }
    }
  }
}
```

## 可用工具列表

| 工具名                                  | 說明             |
| ------------------------------------ | -------------- |
| `sora_generate_video`                | 通過文本提示詞生成視頻    |
| `sora_generate_video_from_image`     | 以圖片為基礎生成視頻     |
| `sora_generate_video_with_character` | 使用參考角色圖生成一致性視頻 |
| `sora_generate_video_async`          | 異步提交視頻生成任務     |
| `sora_get_task`                      | 查詢單個任務狀態       |
| `sora_get_tasks_batch`               | 批量查詢任務狀態       |

## 使用示例

配置完成後，你可以在 AI 客戶端中直接用自然語言調用這些功能，例如：

* 「幫我用 Sora 生成一段貓咪在草地上奔跑的視頻」
* 「用這張人物照片生成一段視頻，保持角色一致」
* 「生成一段豎屏的視頻，內容是城市日出」
* 「異步生成一段視頻並稍後查詢結果」

## 更多信息

* GitHub 倉庫：[XHuoAPI/SoraMCP](https://github.com/XHuoAPI/SoraMCP)
* PyPI 包：[mcp-sora](https://pypi.org/project/mcp-sora/)
* API 文檔：[Sora 視頻生成 API](https://api.xhuoapi.ai/documents/sora)
