The Open Framework for Building Agents
fix(eve): scope AGENTS.md scaffold docs guidance (#2242)
Colton Padden075dc1f52aa8
diff --git a/.changeset/focused-instructions-guidance.md b/.changeset/focused-instructions-guidance.mdnew file mode 100644index 000000000..6af6de232--- /dev/null+++ b/.changeset/focused-instructions-guidance.md@@ -0,0 +1,5 @@+---+"eve": patch+---++Tell coding agents that content-only instruction edits do not require reading the framework docs, while preserving docs-first guidance for eve framework changes.diff --git a/packages/eve/src/setup/scaffold/create/project.ts b/packages/eve/src/setup/scaffold/create/project.tsindex cda6e4071..0a3a42dfa 100644--- a/packages/eve/src/setup/scaffold/create/project.ts+++ b/packages/eve/src/setup/scaffold/create/project.ts@@ -293,11 +293,19 @@ dist`,"AGENTS.md": `# eve Agent App-This project uses the eve framework. Before writing code, read the relevant guide-from the installed eve package docs. In most installs, those docs are at-\`node_modules/eve/docs/\`. In workspaces or local package installs, resolve the-installed \`eve\` package location first and read its \`docs/\` directory. If-package docs are unavailable, use https://eve.dev/docs as a fallback.+This project uses the eve framework. For a content-only change to the root agent's+identity, purpose, tone, or response guidelines, edit its existing authored+instructions. Fresh projects use \`agent/instructions.md\`; a project may instead+use \`agent/instructions.ts\` or files under \`agent/instructions/\`. You do not+need to read the framework docs for a content-only instructions change.++Before adding or changing eve framework features such as tools, connections,+channels, skills, subagents, schedules, authentication, or deployment, read the+relevant guide from the installed eve package docs. In most installs, those docs+are at \`node_modules/eve/docs/\`. In workspaces or local package installs,+resolve the installed \`eve\` package location first and read its \`docs/\`+directory. If package docs are unavailable, use https://eve.dev/docs as a+fallback.## Adding integrationsdiff --git a/packages/eve/src/setup/scaffold/index.integration.test.ts b/packages/eve/src/setup/scaffold/index.integration.test.tsindex 7ebca5fc1..37565abc4 100644--- a/packages/eve/src/setup/scaffold/index.integration.test.ts+++ b/packages/eve/src/setup/scaffold/index.integration.test.ts@@ -984,9 +984,13 @@ describe("scaffoldBaseProject", () => {PNPM_WORKSPACE_CONTENT,);const agentsMd = await readFile(join(projectRoot, "AGENTS.md"), "utf8");+ expect(agentsMd).toContain("content-only change to the root agent's");+ expect(agentsMd).toContain("You do not\nneed to read the framework docs");+ expect(agentsMd).toContain("`agent/instructions.ts` or files under `agent/instructions/`");+ expect(agentsMd).toContain("Before adding or changing eve framework features");expect(agentsMd).toContain("installed eve package docs");expect(agentsMd).toContain("node_modules/eve/docs/");- expect(agentsMd).toContain("resolve the\ninstalled `eve` package location");+ expect(agentsMd).toContain("resolve the installed `eve` package location");expect(agentsMd).toContain("eve registry search <query> --json");expect(agentsMd).toContain("eve registry view <item>");expect(agentsMd).toContain("eve add <item> --non-interactive");