OpenCode HTTP API

Polar Sponsor
爱发电 赞助
.NET 9.0

Through the HTTP API, call the OpenCode Server to perform code review, code analysis, and coding tasks. Topics covered include: - Agents (4 modes + custom agents) - Custom Tools (TypeScript) - Formatters (ruff/biome) - Skills (loading skills) -

OpenCode API Skill(完整版 v3.0)

功能概述

OpenCode API Skill(完整版 v3.0)是一项面向实际任务的技能,主要用于通过 HTTP API 调用已启动的 OpenCode Server,使 OpenClaw 能够向 OpenCode 分配 code review、代码分析、编码任务;📚 目录索引;

核心要点

  • 如需了解某一主题的详细内容,请查阅对应的 reference 文件;
  • 请直接参阅下方第 1 节;
  • Agents 系统;

使用与执行

references/agen。该技能将相关步骤、工具调用及结果整理方式统一整合至标准化流程中,帮助用户更高效地达成目标,并减少重复性操作。从功能定位来看,本技能强调将分散的操作需求归纳为清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式,并获取结构化输出。实际使用前,应首先确认任务范围、数据来源、运行环境、必要权限及关键参数,再依据技能说明逐步执行;

结果检查与注意事项

若输入条件不完整,应优先补全信息或采用保守配置,避免因错误假设导致结果偏离预期。执行过程中需重点关注工具调用是否成功、接口或依赖服务是否可用、输出格式是否符合预期,并对异常提示、缺失字段及边界情况做好处理;涉及批量任务时,还应保存执行进度,防止中断后重复操作。该技能适用于一次性任务,也可接入自动化工作流,与其他技能或上层代理协同完成更完整的业务链路;在组合使用时,应明确定义每一步的输入与输出关系,并避免不同步骤之间出现参数冲突。

OpenCode API Skill(完整版 v3.0)

通过 HTTP API 调用已启动的 OpenCode Server,使 OpenClaw 可向 OpenCode 分配 code review、代码分析、编码任务等工单。

📚 目录索引

如需了解某一主题的详细内容,请查阅对应的 reference 文件:

主题 文件 说明
快速开始 — 直接查看下方第 1 节
Agents 系统 references/agents.md 四种内置代理 + 自定义代理 + 温度/max_steps 设置
SDK 完整 API references/sdk.md 端点列表 + Python 对照示例 + 结构化输出/事件监听
Custom Tools references/sdk.md → 见上方 TypeScript 工具定义
Formatters + Keybinds + Share references/formatters.md 格式化器配置 + 快捷键 + 分享功能
Config 完整配置 references/config.md 所有 schema 字段 + 变量替换支持
Permissions 权限 references/permissions.md 细粒度规则 + 默认值
Commands 自定义指令 references/commands.md Markdown/JSON 格式 + 参数/Shell 输出
Tools 内置工具 references/tools.md 14 种工具一览 + question 工具用法
MCP 服务器 references/mcp.md 本地/远程 + OAuth + 常见配置示例
LSP 整合 references/lsp.md 内置 LSP + 配置方式
Providers 配置 references/providers.md LM Studio / Ollama / 自定义 Provider
Server 部署 references/server.md HTTP Server + 认证 + API 端点
派工模板 直接查看下方第 5 节 Minecraft-translate 专用 prompt
强化 Code Review Checklist references/review-checklist.md 必读 — 每次 review 都需提出的六大问题(Schema 对应实作、Pattern 边界、常数清理、改动范围、Error logging、向后兼容)

1. 快速开始

Sub-agent import(推荐)

import sys
sys.path.insert(0, "C:/Users/admin/.openclaw/workspace/skills/opencode-api/scripts")
from opencode_task import run_opencode_task, OpenCodeAPI

# 单次任务
result = run_opencode_task(
    prompt="请用繁体中文对以下代码进行 code review:ndef foo(): pass",
    model="minimax/MiniMax-M2.7",
    reasoning="high",
)
print(result.text)
print(result.session_id)
print(result.ok)

# 多轮对话
client = OpenCodeAPI(auto_start=True)
sid = client.create_session(title="PR Review")
r1 = client.send_message("请 review...", session_id=sid, model="minimax/MiniMax-M2.7")
r2 = client.send_message("第三点再详细点", session_id=sid)

CLI

python scripts/opencode_task.py --prompt "请帮我分析这个函数" --model minimax/MiniMax-M2.7 --reasoning high

2. Scripts 总览

文件 用途 推荐场景
opencode_task.py 简洁的任务封装(推荐) 单次/多轮对话、sub-agent import
opencode_client.py 完整 HTTP client 需精细控制 API 底层,含 SDK 进阶功能
opencode_review.py PR Review 专用 wrapper 直接 review GitHub PR

3. 模型速查

模型 ID 名称 思考支援 适合场景
minimax/MiniMax-M2.7 MiniMax M2.7 ✅ 性价比 coding(默认)
minimax/MiniMax-M2.5 MiniMax M2.5 ✅ 中等复杂度任务
minimax/MiniMax-M2.7-highspeed MiniMax M2.7 高速 ✅ 快速响应
big-pickle:high Big Pickle High ✅ 16K tokens 深度分析(免费)
big-pickle:max Big Pickle Max ✅ 32K tokens 极深度推理(免费)

查询可用模型:client.get_providers()

4. 思考深度(reasoning)

值 说明
none 关闭
minimal / low 轻量思考
medium 标准(默认)
high 深度分析
xhigh 极深度推理

5. 派工上下文模板(Minecraft-translate 专用)

当向 OpenCode 派工时,必须在 prompt 中附上以下内容:

项目基本信息

项目 内容
工作目录 C:UsersadminDesktopminecraft_translator_flet
主要语言 Python 3.12 + Flet 0.82.x
测试框架 pytest(需使用 .venvScriptspython.exe)
Git gh 已认证,可访问 jlin53882/Minecraft-translate

重要文件夹对照

minecraft_translator_flet/
├── app/                          # Flet UI 主程序
│   ├── views/                    # View 组件
│   ├── icon_reader.py            # ZIP icon reader(含 LRU cache)
│   └── icon_index.py             # Icon 索引建立
├── translation_tool/             # 核心 CLI 工具
│   ├── core/                     # 翻译引擎(lm_translator, kubejs, ftb...)
│   ├── plugins/                  # 插件(ftbquests, kubejs, md...)
│   └── utils/                    # 共用工具(jar_browser.py, cache_shards.py...)
├── tests/                        # pytest 测试(需 venv)
├── docs/                          # 开发文档(SOP、AI_WORKFLOW_MANUAL...)
├── .icon_cache/                  # JAR icon 缓存
└── .venv/                        # Python 虚拟环境(依赖在此)

禁止假设

❌ 错误假设 ✅ 正确做法
「pytest 直接跑」 必须先 cd 进入项目目录,使用 .venvScriptspython.exe -m pytest
「全局 Python 有套件」 项目依赖(ftb_snbt_lib、pandas)仅存在于 .venv 中
「直接用 python」 明确指定 .venvScriptspython.exe
「桌面是工作目录」 工作目录是 minecraft_translator_flet
「PowerShell redirect 写中文」 会导致 UTF-16 截断;改用 Python script 或 write tool

典型派工 prompt 示例

你是一个专业的 Python 开发者,帮我对此 PR 进行 code review。

## 项目背景
- 工作目录:`C:UsersadminDesktopminecraft_translator_flet`
- 主要语言:Python 3.12 + Flet 0.82.x
- 测试:`cd` 进入项目目录后,用 `.venvScriptspython.exe -m pytest` 执行

## 任务
请用繁体中文 review 此 PR 的变更:
[此处粘贴 PR 内容或 diff]

## 审查重点
1. 是否有破坏性变更未告知
2. 测试覆盖是否足够
3. 错误处理是否完整
4. 代码风格是否一致(建议使用 ruff formatter)
5. 是否存在安全疑虑
6. **Schema 新增字段 → 确认有对应实作读取**(见 `references/review-checklist.md`)
7. **Pattern matching 函数 → 提供边界条件测试**(见 `references/review-checklist.md`)
8. **常量/函数定义 → 确认没有被取代后遗留**(见 `references/review-checklist.md`)
9. **改动范围 → 只涵盖需修改的部分,无关代码不受影响**

## 输出格式
最后列出:
- ✅ 建议保留的优点
- ⚠️ 需要修改的问题(附文件:行号)
- 💡 改进建议

请用繁体中文回复,并在结尾列出你修改了哪些文件。

6. 触发关键字对照

关键字 对应行为
用 OpenCode review PR#xxx CLI: opencode_task.py --prompt "review PR#xxx"
用 OpenCode 分析这个文件 client.analyze_file()
用 OpenCode 多轮对话 import OpenCodeAPI + 多轮交互
OpenCode 用高思考 --reasoning high
用 OpenCode 探索项目 agent="explore"
用 OpenCode 做规划 agent="plan"
用 OpenCode 结构化输出 outputFormat=json_schema
用 OpenCode 中止任务 client.abort_session(id)

依赖

# opencode_task.py:无外部依赖(标准库)
# opencode_client.py:pip install requests
# SDK 进阶功能(如 event subscribe):pip install requests sseclient

相关专题

更多
Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

0

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

0

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

0

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

0

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

0

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

0

15

Golangci-lint安装与入门教程
Golangci-lint安装与入门教程

本专题讲解Golangci-lint的安装、初始化、基础命令和首次代码检查,覆盖本地环境、Docker及多平台用法,帮助Go开发者快速上手。

2026.10.22

0

15

PHP2Shell高危漏洞修复教程
PHP2Shell高危漏洞修复教程

PHP2Shell漏洞是什么,哪些PHP版本和运行环境会受到影响,服务器应该如何检测与修复?本专题提供版本自查脚本、Linux与Docker升级命令、PHP-FPM和Apache排查步骤,以及修复验证、临时缓解和应急响应方案。

2026.10.22

0

12

剧云人物设定与关系管理教程
剧云人物设定与关系管理教程

本专题介绍剧云人物设定与关系管理,讲解角色小传、性格职业、人物目标、背景资料和关系网络的创建及维护方法。

2026.10.22

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习