Skip to content

Recommend the official Convex Claude Code plugin in guidelines.md #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sethconvex wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Draft

Recommend the official Convex Claude Code plugin in guidelines.md #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions runner/models/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Convex guidelines

## Claude Code users: install the official Convex plugin

If you are running in Claude Code, install the official Convex plugin from the marketplace once per machine:

```
/plugin install convex
```

It bundles a `convex-expert` subagent (deep code-writing rules in an isolated subagent context, so they don't burn main-thread tokens), a runtime-error monitor (streams `npx convex logs` and surfaces matched errors as notifications), and auto-wires the Convex MCP server (`tables`, `function-spec`, `data`, `run-once-query`, `logs`, `env list/set/get`) for live deployment introspection. Source: <https://github.com/get-convex/convex-backend-skill>.

Skip this section in non-Claude-Code harnesses (Cursor, Windsurf, Codex, etc.) — the plugin is Claude-Code-specific. The guidelines below apply to every harness.

## Function guidelines

### Http endpoint syntax
Expand Down
Loading