agentation
- Repo stars 3,717
- Author repo agentation
- Domain
- AI
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @benjitaylor · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- macOS · Linux · Windows
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Env read
- Network behavior
- Local-only
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Agentation Setup
Set up the Agentation annotation toolbar in this project.
## Steps
1. **Check if already installed**
- Look for `agentation` in package.json dependencies
- If not found, run `npm install agentation` (or pnpm/yarn based on lockfile)
2. **Check if already configured**
- Search for `<Agentation` or `import { Agentation }` in src/ or app/
- If found, report that Agentation is already set up and exit
3. **Detect framework**
- Next.js App Router: has `app/layout.tsx` or `app/layout.js`
- Next.js Pages Router: has `pages/_app.tsx` or `pages/_app.js`
4. **Add the component**
For Next.js App Router, add to the root layout:
```tsx
import { Agentation } from "agentation";
// Add inside the body, after children:
{process.env.NODE_ENV === "development" && <Agentation />}
```
For Next.js Pages Router, add to _app:
```tsx
import { Agentation } from "agentation";
// Add after Component:
{process.env.NODE_ENV === "development" && <Agentation />}
```
5. **Confirm component setup**
- Tell the user the Agentation toolbar component is configured
6. **Recommend MCP server setup**
- Explain that for real-time annotation syncing with AI agents, they should also set up the MCP server
- Recommend one of the following approaches:
- **Universal (supports 9+ agents including Claude Code, Cursor, Codex, Windsurf, etc.):**
See [add-mcp](https://github.com/neondatabase/add-mcp) — run `npx add-mcp` and follow the prompts to add `agentation-mcp` as an MCP server
- **Claude Code only (interactive wizard):**
Run `agentation-mcp init` after installing the package
- Tell user to restart their coding agent after MCP setup to load the server
- Explain that once configured, annotations will sync to the agent automatically
## Notes
- The `NODE_ENV` check ensures Agentation only loads in development
- Agentation requires React 18
- The MCP server runs on port 4747 by default for the HTTP server
- MCP server exposes tools like `agentation_get_all_pending`, `agentation_resolve`, and `agentation_watch_annotations`
- Run `agentation-mcp doctor` to verify setup after installing
Sections and files
Listed in source order.
sections -> Steps → Notes
terms -> Check if already installed · Check if already configured · Detect framework · Add the component · Confirm component setup · Recommend MCP server setup · Claude Code only (interactive wizard)
files/cmd -> agentation · npm install agentation · <Agentation · import { Agentation } · app/layout.tsx · app/layout.js · pages/_app.tsx · pages/_app.js
body sha256 -> 8f232ddbe1e3
Steps
Check if already installed Look for
agentationin package.json dependencies If not found, runnpm install agentation(or pnpm/yarn based on lockfile) Check if already configured Search for<Agentationorimport { Agentation }in src/ or app/Notes
The
NODE_ENVcheck ensures Agentation only loads in development Agentation requires React 18 The MCP server runs on port 4747 by default for the HTTP server MCP server exposes tools likeagentation_get_all_pending,agentation_resolve, andagentation_watch_annotationsRunagentation-mcp doctorto verify setup after installing