Skip to content

Commit 463e615

Browse files
jpicklykclaude
andcommitted
docs: restructure Quick Start with explicit docker pull step
Pull image first (Step 1) so MCP client connects instantly instead of hanging silently on first launch. Register options become Step 2 sub-options (A/B/C). Remove redundant docker pull from Option C. Plugin install is Step 3. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent f062dc4 commit 463e615

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,19 @@ Task Orchestrator implements **industry-recommended patterns** from Anthropic's
5252

5353
**Prerequisite**: [Docker](https://www.docker.com/products/docker-desktop/) must be installed and running.
5454

55-
### Option A: Claude Code (CLI — recommended)
55+
### Step 1: Pull the image
56+
57+
```bash
58+
docker pull ghcr.io/jpicklyk/task-orchestrator:latest
59+
```
60+
61+
This is a one-time step — Docker caches the image locally. Pulling first ensures your MCP client connects instantly rather than waiting silently on first launch.
62+
63+
### Step 2: Register with your MCP client
64+
65+
Choose the option that matches your setup:
66+
67+
#### Option A: Claude Code (CLI — recommended)
5668

5769
Register the server once from your terminal:
5870

@@ -71,7 +83,7 @@ claude mcp add-json mcp-task-orchestrator '{
7183

7284
Restart Claude Code, then run `/mcp` to confirm `mcp-task-orchestrator` is connected.
7385

74-
### Option B: Project `.mcp.json`
86+
#### Option B: Project `.mcp.json`
7587

7688
Add to `.mcp.json` in your project root (checked into source control so teammates get it automatically):
7789

@@ -94,15 +106,11 @@ Add to `.mcp.json` in your project root (checked into source control so teammate
94106

95107
The `mcp-task-data` Docker volume persists the SQLite database across container restarts. The server auto-initializes its schema on first run — no additional setup required.
96108

97-
### Option C: Other MCP Clients
98-
99-
```bash
100-
docker pull ghcr.io/jpicklyk/task-orchestrator:latest
101-
```
109+
#### Option C: Other MCP Clients
102110

103-
Configure your client with the same JSON above. STDIO transport works with any MCP-compatible client.
111+
Configure your client with the same JSON as Option A above. STDIO transport works with any MCP-compatible client.
104112

105-
### Claude Code Plugin (optional)
113+
### Step 3: Claude Code Plugin (optional)
106114

107115
Install the plugin for workflow skills, session-start hooks, and an orchestrator output style:
108116

0 commit comments

Comments
 (0)