opencode-server-api Skill
✓ VerifiziertFühre Read-only-Abfragen gegen den OpenCode 2.x Server aus, um Sessions, den Nachrichtenverlauf, den MCP-Status, Skills und Agents zu inspizieren.
- GitHub Stars
- 13
- Dateien
- 1
- Letzter Commit
- 30. Okt. 2026
- Lizenz
- MIT
- Erlaubte Tools
- —
Was macht der opencode-server-api Skill?
Führe Read-only-Abfragen gegen den OpenCode 2.x Server aus, um Sessions, den Nachrichtenverlauf, den MCP-Status, Skills und Agents zu inspizieren.
Zusammenfassung erzeugt aus der SKILL.md des Skills.
Über den opencode-server-api skill
Dieser Skill ermöglicht es Entwicklern und AI Agents, den Zustand und den Verlauf deines OpenCode 2.x Servers zu inspizieren. Er bietet eine Read-only-Schnittstelle, um Serverinformationen, aktive Sessions, Nachrichtenverläufe und den Status verbundener MCP Server abzufragen. Ein Agent sollte dieses Tool laden, wenn ein User nach der aktuellen Session, verfügbaren Skills, verbundenen Tools oder ausstehenden Permission-Anfragen fragt.
User interagieren mit dem Server via GET-Requests unter Verwendung von HTTP Basic Authentication mit einem Passwort, das in der Umgebungsvariablen OPENCODE_SERVER_PASSWORD gespeichert ist. Der Skill basiert darauf, eine Live-OpenAPI-Spec vom Server abzurufen, um sicherzustellen, dass alle Route- und Parameter-Aufrufe korrekt sind. Er kann spezifische Details wie Session-Ergebnisse, Nachrichtentypen und sogar eine Todo-Liste abrufen, indem er den Input des aktuellsten todowrite Tool-Aufrufs im Nachrichtenverlauf parst. Er ist strikt auf Read-only-Operationen beschränkt und kann nicht verwendet werden, um den Serverzustand zu ändern, Formulare zu beantworten oder auf rohe Config-Dateien zuzugreifen.
Was ein agent damit machen kann
- 1Aktive Todo-Listen abrufenFinde die aktuelle Liste ausstehender Aufgaben, indem du den neuesten todowrite Tool-Aufruf inspizierst.
Geschrieben basierend auf dem SKILL.md des skills. Jeder use case wurde gegen ein zitat daraus geprüft.
So installierst du den opencode-server-api Skill
Jeder Befehl kopiert den Skill-Ordner in das Skills-Verzeichnis des Clients. Starte den Client neu oder beginne eine neue Session, um ihn zu laden.Den opencode-server-api Skill in Claude Code installieren
~/.claude/skills/opencode-server-api/SKILL.md
$ npx degit kevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api ~/.claude/skills/opencode-server-apiDen opencode-server-api Skill in Claude Code (project) installieren
.claude/skills/opencode-server-api/SKILL.md
$ npx degit kevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api .claude/skills/opencode-server-apiDen opencode-server-api Skill in Codex installieren
~/.agents/skills/opencode-server-api/SKILL.md
$ npx degit kevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api ~/.agents/skills/opencode-server-apiDen opencode-server-api Skill in Gemini CLI installieren
~/.gemini/skills/opencode-server-api/SKILL.md
$ npx degit kevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api ~/.gemini/skills/opencode-server-apiDen opencode-server-api Skill in Claude.ai installieren
npx degit kevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api opencode-server-api && zip -r opencode-server-api.zip opencode-server-api # claude.ai → Customize → Skills → + → Create skill → Upload a skill → opencode-server-api.zip
Automatisierte Checks
Geluften am 16. Nov. 2026Vollständiger Bericht →Hat unsere automatischen Prüfungen bestanden. Das ist kein Sicherheitsaudit: Lesen Sie die Skripte, bevor ein Agent sie ausführt. Wie die Checks funktionieren
- Source Repository verknüpft und erreichbarkevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api is public and reachablegithub.com/kevinlin/cowork-z/tree/HEAD/src-tauri/resources/s ↗Bestanden
- Open Source Lizenz (OSI)MITspdx.org/licenses/MIT.html ↗Bestanden
- Commit oder Release im letzten JahrLast commit 2026-10-30github.com/kevinlin/cowork-z/commits ↗Bestanden
- Keine Download-und-Ausführen-Muster oder Zugangsdatendiebstahl in SkriptenNo scripts in the skill folderBestanden
- Keine versteckten Anweisungen in SKILL.mdNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/kevinlin/cowork-z/blob/HEAD/src-tauri/resources/s ↗Bestanden
- Vorab erlaubte Tools sind eingeschränktNo pre-approved tools; the agent asks before using onegithub.com/kevinlin/cowork-z/blob/HEAD/src-tauri/resources/s ↗Bestanden
- SKILL.md folgt dem Agent-Skills-FormatValid name and description; says when to use it; 91 linesgithub.com/kevinlin/cowork-z/blob/HEAD/src-tauri/resources/s ↗Bestanden
SKILL.md
Auf GitHub ansehenOpenCode Server API
This skill lets you inspect the OpenCode server you run on — server info, sessions, message history (including your todo lists), pending permission and question requests, MCP status, skills and agents. It is read-only: use GET requests only.
Authentication
The server port is in your system prompt, inside the <server-access> block. The basic-auth password is already in your shell environment as OPENCODE_SERVER_PASSWORD; your shell expands it locally. Every request needs HTTP basic auth:
curl -s -u "opencode:$OPENCODE_SERVER_PASSWORD" http://localhost:$PORT/<endpoint>
Replace $PORT with the port from your system prompt. Use $OPENCODE_SERVER_PASSWORD exactly as written (PowerShell: $env:OPENCODE_SERVER_PASSWORD).
NEVER print, echo, log, or write the password's value anywhere — not to the chat, not to files, not to command output. Only reference it as a shell variable inside commands.
IMPORTANT: Fetch the API Spec First
Before calling ANY endpoint, fetch the live OpenAPI spec. It is the source of truth for routes, parameters and response shapes, and it may be newer than this skill.
curl -s -u "opencode:$OPENCODE_SERVER_PASSWORD" http://localhost:$PORT/openapi.json
Do not guess from the examples below; verify against the spec first.
Conventions
- All API routes live under
/api/. Answers are wrapped:{"data": ...}, plus"location"on location-scoped routes. - Location-scoped routes (
/api/mcp,/api/skill,/api/agent) take the workspace folder as alocation[directory]query parameter. The brackets break plain curl URLs, so pass it with-G --data-urlencode:
curl -s -G -u "opencode:$OPENCODE_SERVER_PASSWORD" \
--data-urlencode "location[directory]=<workspace path>" \
http://localhost:$PORT/api/mcp
The workspace path is given in your system prompt (<workspace-conventions>). Session routes need no location.
Endpoints (all GET)
| Route | Returns |
|---|---|
/api/info |
Server version, pid, urls. Use it as the health check. |
/api/session |
{data: [session]} — your sessions. Optional directory, limit, search. |
/api/session/{id} |
{data: session} — id, model, outcome, time, location, permissions. |
/api/session/{id}/message |
{data: [message], cursor} — history. Pass order=desc for newest first, order=asc for oldest first. |
/api/session/{id}/permission |
{data: [request]} — permission requests waiting for an answer. |
/api/session/{id}/form |
{data: [form]} — questions waiting for an answer. |
/api/mcp |
{data: [{name, status: {status, error?}}]} — MCP servers. |
/api/skill |
{data: [{id, name, path, content}]} — available skills. |
/api/agent |
{data: [agent]} — available agents and their models. |
Find your own session in /api/session (filter with directory=<workspace path>).
/api/session/{id}/message
Messages have a type (user, assistant, idle, …). An assistant message has a content array of text, reasoning and tool items. A tool item is {type: "tool", name, state: {status, input, content}}.
Your todo list is the input.todos of your newest todowrite call: read the history newest first (order=desc), find the first tool item named todowrite and take state.input.todos ([{content, status}], status pending, in_progress or completed). There is no todo route.
curl -s -u "opencode:$OPENCODE_SERVER_PASSWORD" "http://localhost:$PORT/api/session/ses_abc123/message?order=desc"
/api/mcp
status.status is one of connected, pending (still connecting), disabled, failed or needs_auth; error is set on the last two. The list also includes servers from the user's global OpenCode config.
/api/session/{id}/permission and /form
Pending permission request: {id, action, resources, metadata, message?}. Pending form: {id, title, fields: [{key, type, options?}]}. Both are empty when nothing is waiting.
Out of scope
Do not call routes that change state (creating or deleting sessions, prompting, interrupting, answering permissions or forms, editing config or MCP servers). The user decides those in the app. Do not call any route that handles credentials or provider sign-in either; they are not part of this skill. Do not call /api/config: it returns the user's raw config files, which can hold API keys.
Usage Guidance
- Check health (
/api/info) before other calls when the server seems unresponsive. - Review your own work (
/api/session/{id}/message) to see what you have said and done. - Check todos by reading your newest
todowritecall from the message history. - List skills (
/api/skill) when asked about your capabilities. - Check MCP status (
/api/mcp) when asked about connected tools or servers. - List agents (
/api/agent) to understand your current setup.
Dateien in diesem Skill
1opencode-server-api Skill-Fragen
Wie installiere ich den opencode-server-api Skill in Claude Code?
Führe npx degit kevinlin/cowork-z/src-tauri/resources/skills/opencode-server-api ~/.claude/skills/opencode-server-api aus. Claude Code lädt Skills aus ~/.claude/skills (alle Projekte) oder .claude/skills (ein Projekt) und nutzt einen Skill, wenn seine Beschreibung zur Aufgabe passt.
Welche Clients können den opencode-server-api Skill nutzen?
Jeder Client, der das Agent Skills-Format liest: Claude Code, Codex, Gemini CLI und claude.ai (als ZIP hochladen). Skripte im Skill laufen nur dort, wo der Client Codeausführung erlaubt.
Wie kann ich den Status des OpenCode Servers prüfen?
Du kannst den /api/info Endpoint nutzen, um die Serverversion, die PID und URLs abzurufen, was als Health Check dient.
Wie greife ich über die API auf meine Todo-Liste zu?
Es gibt keine dedizierte Todo-Route; stattdessen musst du den Nachrichtenverlauf in absteigender Reihenfolge lesen, das erste 'todowrite' Tool-Item finden und das Feld 'state.input.todos' extrahieren.
Was sollte ich tun, bevor ich einen API-Endpoint aufrufe?
Du solltest immer zuerst die Live-OpenAPI-Spec abrufen, um sicherzustellen, dass du die korrekten Routes, Parameter und Response-Formate hast.