|
1 | | -# Claude Code plugin for Val Town |
| 1 | +# Agent plugins for Val Town |
2 | 2 |
|
3 | | -Installs the Val Town MCP server and skills for Claude Code. |
| 3 | +Installs the Val Town MCP server and Skills for Claude Code, Codex, and Cursor. |
4 | 4 |
|
5 | | -Contains platform guidance for building on [Val Town](https://val.town) — the |
6 | | -single source of truth for the "how to write a val" knowledge used by Val Town's |
7 | | -own tools (Townie, the MCP server) and by AI coding tools like Claude Code. |
8 | | - |
9 | | -Each skill is a short markdown guide covering one platform topic (HTTP vals, |
10 | | -cron/intervals, SQLite, email, OAuth, React UI, third-party integrations, |
11 | | -templates). |
| 5 | +Skills are markdown files with platform guidance for building on [Val Town](https://val.town). |
| 6 | +Used by Val Town's own tools (Townie, the MCP server) and by AI coding agents. |
| 7 | +Skills include HTTP vals, crons, SQLite, email, OAuth, frontend, and API integrations. |
12 | 8 |
|
13 | 9 | ## Install |
14 | 10 |
|
15 | | -Start a `claude` session, then run: |
| 11 | +Installing the plugin makes platform skills available to your agent and registers |
| 12 | +the hosted Val Town MCP server (`https://api.val.town/v3/mcp`). On first use of |
| 13 | +an MCP tool, the agent runs the OAuth flow in your browser. |
| 14 | + |
| 15 | +1. [Claude Code](#claude-code) |
| 16 | +2. [Codex](#codex) |
| 17 | +3. [Cursor](#cursor) |
| 18 | + |
| 19 | +### Claude Code |
| 20 | + |
| 21 | +Install the Val Town plugin by running: |
16 | 22 |
|
17 | 23 | ``` |
18 | | -/plugin marketplace add val-town/plugins |
| 24 | +claude plugin install valtown@claude-plugins-official |
19 | 25 | ``` |
20 | 26 |
|
21 | | -Then run: |
| 27 | +### Codex |
| 28 | + |
| 29 | +#### `codex` CLI |
| 30 | + |
| 31 | +First, run: |
22 | 32 |
|
23 | 33 | ``` |
24 | | -/plugin install vals@valtown |
| 34 | +codex plugin marketplace add val-town/plugins |
25 | 35 | ``` |
26 | 36 |
|
27 | | -This makes the platform skills available to Claude and registers the hosted |
28 | | -Val Town MCP server (`https://api.val.town/v3/mcp`). On first use of an MCP tool, |
29 | | -Claude Code runs the OAuth flow in your browser. |
| 37 | +Then fire up `codex` and run: |
| 38 | + |
| 39 | +``` |
| 40 | +/plugins |
| 41 | +``` |
| 42 | + |
| 43 | +Search for Val Town, hit install, and it'll take you through the OAuth path. |
| 44 | + |
| 45 | +#### Codex desktop app |
| 46 | + |
| 47 | +1. Click "Plugins" in the sidebar |
| 48 | +2. In the dropdown that says "Built by OpenAI" click "Add more +" |
| 49 | +3. Copy-paste `https://github.com/val-town/plugins` and select "Add marketplace" |
| 50 | + |
| 51 | +### Cursor |
| 52 | + |
| 53 | +In Cursor, run: |
| 54 | + |
| 55 | +``` |
| 56 | +/add-plugin valtown |
| 57 | +``` |
| 58 | + |
| 59 | +Or in Cursor Settings, copy-paste `https://github.com/val-town/plugins` in the search box and select "Add to Cursor." |
30 | 60 |
|
31 | 61 | ## Contributing |
32 | 62 |
|
@@ -84,3 +114,18 @@ for publishing. See their documentation for more information. |
84 | 114 | - Each change in that directory will prompt the `release.yml` GitHub action |
85 | 115 | to create a new release PR. |
86 | 116 | - Merging a release PR will automatically publish a new version of this module. |
| 117 | + |
| 118 | +### Configuration |
| 119 | + |
| 120 | +#### Claude Code |
| 121 | + |
| 122 | +The official Claude plugin marketplace pulls from [`.plugins/marketplace.json`](./.plugins/marketplace.json). |
| 123 | + |
| 124 | +#### Codex |
| 125 | + |
| 126 | +Codex reads the native marketplace at `.agents/plugins/marketplace.json` (and |
| 127 | +falls back to the Claude `.claude-plugin/marketplace.json` for compatibility). |
| 128 | + |
| 129 | +#### Cursor |
| 130 | + |
| 131 | +Cursor reads `.cursor-plugin/marketplace.json` and the per-plugin `plugin/.cursor-plugin/plugin.json`. |
0 commit comments