Skip to content

docs: add agent-facing CLAUDE.md #3

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

Merged
vreshch merged 1 commit into from
Jul 5, 2026
Merged

docs: add agent-facing CLAUDE.md #3

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
21 changes: 21 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Agentage VS Code extension — CLAUDE.md

Editor extension (dir `vscode-memory`, **repo `vscode-agentage`**, published id `agentage.agentage`).
On activation it registers the cloud MCP server `memory.agentage.io/mcp` with the editor's AI
(Copilot / Cursor / Windsurf). **Stores no tokens, sends no data of its own** — the editor's
own MCP client runs OAuth and all memory access. Keep that boundary.

## Layout (src/)
- `extension.ts` — activate: register the MCP provider + the connect command.
- `mcp-provider.ts` — VS Code **MCP provider API** path (stable 1.99+; server appears on startup).
- `connect-editor.ts` — Cursor / Windsurf path: write their MCP config file (**merge, never overwrite**).
- `connect-core.ts` — shared registration logic behind both paths.
- `config.ts` — the `agentage.mcpUrl` setting (default `https://memory.agentage.io/mcp`).

## Rules
- Two registration paths: VS Code via the provider API, Cursor/Windsurf via config-file write. Both go through `connect-core`.
- Never persist tokens or telemetry. The only thing written is the server URL into the editor's MCP config.
- Min engine `vscode ^1.99.0` (MCP provider API stable from 1.99; authenticated MCP smoothest 1.101+).

## Build / publish
`npm run compile` (esbuild) · `npm run watch` (dev) · `npm run package` (vsix). Published to **VS Marketplace + Open VSX** (NOT npm) via CI — never local publish.
Loading