Token导航 LogoToken导航TokenDH.com
开发操作浏览器clawhub未标认证来源可访问clear审计提醒

opencode-apiopencode API 文档

Agent Skill

用于辅助 API 设计、接口文档、请求响应结构和服务集成说明。它适合让 Agent 梳理 endpoint、生成 OpenAPI 草稿、检查字段命名、整理错误码或辅助前后端联调。使用时需要确认真实业务语义、鉴权方式、分页和错误处理规则;涉及生成接口文档时,应避免凭空补字段,最好从现有代码、schema 或接口样例中提取事实。

总安装

4,896

周安装

202

GitHub Stars

公开资料未说明

下载量

1,582
OpenClaw

安装说明

本站只整理中文说明和来源信息,不托管安装包,也不代用户安装。

GitHub

来源数

2

许可证

MIT-0

最后核验

2026-05-01

来源状态

来源可访问

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:opencode-api(opencode API 文档)
来源仓库:https://github.com/jlin53882/opencode-api
安装命令:
openclaw skills install opencode-api
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 OpenClaw 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

ClawHubOpenClaw
openclaw skills install opencode-api

简介

opencode-api 通过 HTTP API 调用 OpenCode Server 执行代码审查与分析任务。

  • 适用于集成自定义工具链与格式化规则(如 ruff/biome)的场景。
  • 提供结构化输出与 SDK 支持。opencode-api 属于开发类 Skill,可作为该场景下的辅助能力补充。
  • 使用前需配置服务端地址与鉴权机制。
  • 建议查看原始文档确认 API 版本与字段映射关系。

SKILL.md

name
opencode-api
description
>
version
3.0.0
author
james53882
license
MIT
clawhub
https://clawhub.com/opencode-api
tags
category
workflow
department
coding
languages
models
recommended
compatible

OpenCode API Skill(完整版 v3.0)

透過 HTTP API 呼叫已啟動的 OpenCode Server,讓 OpenClaw 可以派工給 OpenCode 處理 code review、程式碼分析、編碼任務。


📚 目錄索引

需要哪個主題的詳細內容,請讀對應的 reference 檔案:

主題檔案說明
快速開始直接看下方第 1 節
Agents 系統references/agents.md四種內建代理 + 自訂代理 + 溫度/max_steps
SDK 完整 APIreferences/sdk.md端點表 + Python 對照 + 結構化輸出/事件監聽
Custom Toolsreferences/sdk.md → 見上方TypeScript 工具定義
Formatters + Keybinds + Sharereferences/formatters.md格式化器設定 + 快捷鍵 + 分享
Config 完整設定references/config.md所有 schema 欄位 + 變數替換
Permissions 權限references/permissions.md細粒度規則 + 預設值
Commands 自訂指令references/commands.mdMarkdown/JSON 格式 + 參數/Shell 輸出
Tools 內建工具references/tools.md14 種工具一覽 + question 工具用法
MCP 伺服器references/mcp.md本地/遠端 + OAuth + 常見設定範例
LSP 整合references/lsp.md內建 LSP + 設定方式
Providers 設定references/providers.mdLM Studio / Ollama / 自訂 Provider
Server 部署references/server.mdHTTP Server + 認證 + API 端點
派工範本直接看下方第 5 節Minecraft-translate 專用 prompt
強化 Code Review Checklistreferences/review-checklist.md必讀 — 每次 review 都要問的 6 大問題(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:\
def 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.pyPR Review 專用 wrapper直接 review GitHub PR

3. 模型速查

模型 ID名稱思考支援適合場景
minimax/MiniMax-M2.7MiniMax M2.7性價比 coding(預設)
minimax/MiniMax-M2.5MiniMax M2.5中等複雜度任務
minimax/MiniMax-M2.7-highspeedMiniMax M2.7 高速快速響應
big-pickle:highBig Pickle High✅ 16K tokens深度分析(免費)
big-pickle:maxBig Pickle Max✅ 32K tokens極深度推理(免費)

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


4. 思考深度(reasoning)

說明
none關閉
minimal / low輕量思考
medium標準(預設)
high深度分析
xhigh極深度推理

5. 派工上下文範本(Minecraft-translate 專用)

當派工給 OpenCode 時,必須在 prompt 裡附上:

專案基本資訊

項目內容
工作目錄C:\Users\admin\Desktop\minecraft_translator_flet
主要語言Python 3.12 + Flet 0.82.x
測試框架pytest(需用 .venv\Scripts\python.exe
Gitgh 已認證,可存取 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 進專案目錄,用 .venv\Scripts\python.exe -m pytest
「全域 Python 有套件」專案依賴(ftb_snbt_libpandas)只在 .venv
「直接用 python明確指定 .venv\Scripts\python.exe
「桌面是工作目錄」工作目錄是 minecraft_translator_flet
「PowerShell redirect 寫中文」會變成 UTF-16 截斷;改用 Python script 或 write tool

典型派工 prompt 範例

你是一個專業的 Python 開發者,幫我對以下 PR 進行 code review。

## 專案背景
- 工作目錄:`C:\Users\admin\Desktop\minecraft_translator_flet`
- 主要語言:Python 3.12 + Flet 0.82.x
- 測試:`cd` 進專案目錄後,用 `.venv\Scripts\python.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#xxxCLI: 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

适合场景

01

OpenClaw 用户查找和安装 Skill 时

02

用户想查找某类 Agent Skill 时

03

需要根据任务场景推荐可安装能力包时

04

需要对比不同来源的安装命令和来源信息时

能力概览

能力 1

按任务关键词查找相关 Skills

能力 2

展示可复制的安装命令

能力 3

保留来源站点、仓库和原始说明,方便继续核验

能力 4

补充不同宿主或平台的使用分布数据

能力 5

展示第三方安全扫描或审计结果

安装后应在对应宿主中按原始 README 的触发条件使用;具体调用方式请以来源页面和 README 为准。

平台分布

OpenClaw

86.1%
按下载量换算1,362

安全审计

VirusTotal

可疑

ClawScan

可疑

Static analysis

通过

权限和风险

操作浏览器

该 Skill 可能涉及浏览器控制能力,使用时可能读取或操作网页内容,需要在受控环境中确认权限边界。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。来源安全扫描存在 warning/failed 结果,不能写成本站确认安全。当前只有一个来源,正式发布前建议补源仓库或其他目录站核验。

来源信息

继续浏览同类 Skills