mirror of
https://github.com/pocketpaw/pocketpaw.git
synced 2026-05-18 16:06:22 +00:00
57b807c117
Comprehensive SEO optimization across 80 documentation pages: Title optimization (all pages): - Replaced generic titles like "Architecture", "Discord", "Slack" with search-intent titles like "PocketPaw Architecture: Event-Driven Message Bus", "Discord Bot Setup: Add PocketPaw to Your Server" - All titles now 50-70 characters with qualifying keywords Meta descriptions: - Expanded 7 short descriptions (under 145 chars) to 150-160 chars - Roadmap description expanded from 76 to 196 chars - Troubleshooting, Codex CLI, OpenCode, WebMCP all expanded H1 heading fixes: - Ensured single H1 per page matching the frontmatter title - All H1 headings updated to match new optimized titles Internal cross-links: - Added Related CardGroup sections to 60+ individual pages - Each links to 2-3 related pages within and across sections - Channels link to channel guides, backends link to Ollama guide, etc. Em dash cleanup: - Replaced em dashes with colons, periods, or double hyphens across multiple files in tools/, channels/, integrations/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
90 lines
3.0 KiB
Plaintext
90 lines
3.0 KiB
Plaintext
---
|
|
title: "OpenCode: External Server Backend via REST"
|
|
description: "The OpenCode backend connects to an external OpenCode server via REST API. A lightweight, thin-client option for teams already running OpenCode as a separate service."
|
|
section: Agent Backends
|
|
ogType: article
|
|
keywords: ["opencode", "rest api", "external server", "code agent"]
|
|
tags: ["backends", "opencode"]
|
|
---
|
|
|
|
# OpenCode: External Server Backend via REST
|
|
|
|
The OpenCode backend connects to an external **OpenCode server** via REST API. It's a lightweight option for teams that already run OpenCode as a separate service.
|
|
|
|
## Overview
|
|
|
|
- **Status**: Beta
|
|
- **Provider support**: External server (model managed by OpenCode)
|
|
- **Built-in tools**: Server-managed (no PocketPaw-side tool definitions)
|
|
- **MCP support**: No
|
|
- **Architecture**: HTTP client — communicates with a running OpenCode server
|
|
|
|
## Prerequisites
|
|
|
|
Install and start the OpenCode server:
|
|
|
|
```bash
|
|
# Install the OpenCode Go binary
|
|
go install github.com/opencode-ai/opencode@latest
|
|
|
|
# Start in server mode
|
|
opencode --server
|
|
```
|
|
|
|
The server runs on `http://localhost:4096` by default.
|
|
|
|
## Configuration
|
|
|
|
```bash
|
|
export POCKETPAW_AGENT_BACKEND="opencode"
|
|
```
|
|
|
|
### Backend-Specific Settings
|
|
|
|
| Setting | Env Variable | Default | Description |
|
|
|---------|-------------|---------|-------------|
|
|
| `opencode_base_url` | `POCKETPAW_OPENCODE_BASE_URL` | `"http://localhost:4096"` | OpenCode server URL |
|
|
| `opencode_model` | `POCKETPAW_OPENCODE_MODEL` | `""` (server default) | Model override |
|
|
| `opencode_max_turns` | `POCKETPAW_OPENCODE_MAX_TURNS` | `0` (unlimited) | Max turns per query |
|
|
|
|
## How It Works
|
|
|
|
1. PocketPaw creates a session via `POST /session` → receives a session ID
|
|
2. Messages are sent via `POST /session/{id}/message`
|
|
3. Responses stream as NDJSON (newline-delimited JSON)
|
|
4. PocketPaw parses the NDJSON stream into `AgentEvent` objects
|
|
5. A health check (`GET /`) verifies the server is reachable before each request
|
|
|
|
## API Endpoints Used
|
|
|
|
| Method | Endpoint | Purpose |
|
|
|--------|----------|---------|
|
|
| `POST` | `/session` | Create a new session |
|
|
| `POST` | `/session/{id}/message` | Send a message and stream response |
|
|
| `GET` | `/` | Health check |
|
|
|
|
## When to Use
|
|
|
|
Choose OpenCode when:
|
|
|
|
- You already run OpenCode as a separate service
|
|
- You want a backend where the model and tools are managed externally
|
|
- You prefer a thin client architecture with PocketPaw as the frontend
|
|
|
|
## Related
|
|
|
|
<CardGroup>
|
|
<Card title="Claude Agent SDK" icon="lucide:sparkles" href="/backends/claude-sdk">
|
|
The recommended backend with native tools and MCP integration.
|
|
</Card>
|
|
<Card title="Copilot SDK" icon="lucide:github" href="/backends/copilot-sdk">
|
|
Another multi-provider backend with built-in git tools.
|
|
</Card>
|
|
<Card title="All Agent Backends" icon="lucide:layers" href="/backends">
|
|
Compare all six backends side by side with capability badges.
|
|
</Card>
|
|
<Card title="Self-Host PocketPaw" icon="lucide:server" href="/guides/self-host-ai-agent">
|
|
Deploy PocketPaw on your own infrastructure.
|
|
</Card>
|
|
</CardGroup>
|