@andreprado/agentkit 0.1.0-alpha.10

package/src/templates/support.ts

@@ -0,0 +1,401 @@
+import type { AgentTemplate } from ".";
+
+export const supportTemplate: AgentTemplate = {
+  name: "support",
+  files(projectName: string, context = {}) {
+    return [
+      {
+        path: "package.json",
+        contents: `${JSON.stringify(
+          {
+            name: projectName,
+            private: true,
+            type: "module",
+            scripts: {
+              agentkit: "agentkit",
+              dev: "agentkit dev",
+              chat: "agentkit chat",
+              eval: "agentkit eval run",
+              typecheck: "tsc --noEmit",
+            },
+            dependencies: {
+              "@andreprado/agentkit": context.agentkitDependency ?? "workspace:*",
+            },
+            devDependencies: {
+              "@types/node": "^24.12.4",
+              typescript: "^5.9.3",
+            },
+          },
+          null,
+          2,
+        )}
+`,
+      },
+      {
+        path: "tsconfig.json",
+        contents: `${JSON.stringify(
+          {
+            compilerOptions: {
+              target: "ES2022",
+              module: "ESNext",
+              moduleResolution: "Bundler",
+              strict: true,
+              skipLibCheck: true,
+              noEmit: true,
+              types: ["node"],
+            },
+            include: ["**/*.ts"],
+          },
+          null,
+          2,
+        )}
+`,
+      },
+      {
+        path: ".gitignore",
+        contents: `.env
+.agentkit/
+node_modules/
+`,
+      },
+      {
+        path: ".env.schema",
+        contents: `# Optional: add real provider keys after switching away from test/fake.
+OPENAI_API_KEY=
+ANTHROPIC_API_KEY=
+OPENROUTER_API_KEY=
+`,
+      },
+      {
+        path: "agentkit.config.ts",
+        contents: `import { defineAgent } from "@andreprado/agentkit";
+import { lookupOrder } from "./tools/lookup-order";
+
+export default defineAgent({
+  name: "${projectName}",
+  runtime: "edge",
+  provider: {
+    name: "test",
+    model: "fake",
+  },
+  instructions: "./prompts/instructions.md",
+  secrets: [],
+  tools: [lookupOrder],
+  access: {
+    mode: "private",
+  },
+  storage: {
+    driver: "agentkit",
+    path: ".agentkit/agentkit.db",
+    database: {
+      driver: "turso",
+      schema: "./schema.sql",
+    },
+  },
+});
+`,
+      },
+      {
+        path: "schema.sql",
+        contents: `CREATE TABLE IF NOT EXISTS support_notes (
+  id TEXT PRIMARY KEY,
+  body TEXT NOT NULL,
+  created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+`,
+      },
+      {
+        path: "src/agent.ts",
+        contents: `export { default } from "../agentkit.config";
+`,
+      },
+      {
+        path: "tools/lookup-order.ts",
+        contents: `const orders: Record<string, { status: string; eta: string }> = {
+  A100: { status: "preparing", eta: "today" },
+  B200: { status: "shipped", eta: "tomorrow" },
+};
+
+export const lookupOrder = {
+  name: "lookup_order",
+  description: "Looks up a demo support order by order id.",
+  visibility: "user",
+  inputSchema: {
+    type: "object",
+    properties: {
+      orderId: { type: "string" },
+    },
+    required: ["orderId"],
+    additionalProperties: false,
+  },
+  outputSchema: {
+    type: "object",
+    properties: {
+      orderId: { type: "string" },
+      found: { type: "boolean" },
+      status: { type: "string" },
+      eta: { type: "string" },
+    },
+    required: ["orderId", "found", "status", "eta"],
+  },
+  execute(input: { orderId: string }) {
+    const order = orders[input.orderId];
+
+    if (!order) {
+      return {
+        orderId: input.orderId,
+        found: false,
+        status: "unknown",
+        eta: "unknown",
+      };
+    }
+
+    return {
+      orderId: input.orderId,
+      found: true,
+      status: order.status,
+      eta: order.eta,
+    };
+  },
+};
+`,
+      },
+      {
+        path: "prompts/instructions.md",
+        contents: `You are ${projectName}, a focused support agent.
+
+Help users with clear answers. When order status is needed, use the lookup_order tool.
+`,
+      },
+      {
+        path: "evals/smoke.eval.ts",
+        contents: `export default {
+  name: "smoke",
+  input: "Say hello as a support agent.",
+  expect: {
+    contains: "hello",
+  },
+};
+`,
+      },
+      {
+        path: "AGENTS.md",
+        contents: `# ${projectName}
+
+This is an AgentKit support Agent Capsule.
+
+## Coding Agent Workflow
+
+When the owner opens this folder in Codex, Claude Code, or another coding agent and asks for a specific support agent, treat that request as the product brief.
+
+Start building immediately:
+
+- Start with \`skills/agentkit-capsule/SKILL.md\`, then use \`npm run agentkit -- docs llms\` as the docs router.
+- Create or update \`AGENT_SPEC.md\` from the owner's request with \`npm run agentkit -- spec init --brief "<owner request>"\`; the owner should not fill this file by hand before work starts.
+- Infer the first useful version from the owner's request.
+- Edit \`prompts/instructions.md\` for support behavior.
+- Edit \`agentkit.config.ts\` for provider, tools, secrets, access, and storage.
+- Add or replace TypeScript tools under \`tools/\` when the requested support agent needs actions or external data.
+- Add \`sync.ts\`, \`seed.sql\`, and ordered \`migrations/*.sql\` when the support agent depends on external catalogs or production-shaped data changes.
+- Do not wait for a wizard or recipe. AgentKit provides the scaffold and contract; you decide the implementation from the owner's brief.
+- Ask follow-up questions only when missing information blocks a safe local implementation.
+- State assumptions in the final response.
+
+## Local Commands
+
+- \`npm install\`: restore capsule dependencies if this capsule used \`--no-install\`, install failed, or \`node_modules\` was deleted.
+- \`npm run chat -- --message "hello"\`: send one local chat message.
+- \`npm run agentkit -- tool lookup_order --input '{"orderId":"A100"}'\`: test the example tool directly.
+- \`npm run eval\`: run agent evals.
+- \`npm run agentkit -- spec check\`: verify the local agent implementation contract exists.
+- \`npm run agentkit -- eval from-conversation <conversation-id>\`: turn a real conversation into a regression eval.
+- \`npm run agentkit -- conversations trace <conversation-id>\`: inspect messages, runs, tool calls, inputs, outputs, rendered output, and final responses.
+- \`npm run dev\`: run the local Agent Capsule runtime.
+- \`npm run agentkit -- inspect\`: print machine-readable capsule state.
+- \`printf %s "$VALUE" | npm run agentkit -- env set <NAME> --stdin\`: write a local secret value to ignored \`.env\` without putting it in shell history.
+- \`npm run agentkit -- env list\`: list local secret names without printing values.
+- \`npm run agentkit -- docs llms\`: print the lightweight AgentKit docs router.
+- \`npm run agentkit -- docs full\`: print the full AgentKit contract path only when a skill asks for it.
+
+## Testing With A UI
+
+- Local UI: run \`npm run dev\`, open the printed \`Chat:\` URL, and tell the owner the exact URL.
+- Hosted UI: after \`npm run agentkit -- deploy\`, run \`npm run agentkit -- chat-ui --deploy\`, open the printed \`Chat:\` URL, and tell the owner it is connected to the hosted deploy.
+- \`test/fake\` is deterministic. It is useful for scaffold checks, direct tool checks, and fake-provider evals, but it does not validate natural conversation quality.
+- Before claiming real conversation behavior is tested, ask the owner which provider to use: OpenRouter, OpenAI, Anthropic, or another supported provider. Do not choose for them.
+
+## Hosted Deploy
+
+- Local scaffold, chat, eval, dev, inspect, tool, and build commands are token-free.
+- Hosted deploy requires an invited AgentKit Cloud alpha token. If no token is stored yet, ask the owner for one and run \`npm run agentkit -- login --token <token>\`.
+- Put production secret values into managed secrets with \`npm run agentkit -- secret set <NAME> --from-local-env\`, \`--from-env\`, or \`--stdin\`, not into committed files or shell history.
+- Deploy with \`npm run agentkit -- deploy\`, then check \`npm run agentkit -- deploy status\`.
+- Hosted deploy writes the local chat/UI deploy access token to \`.agentkit/chat-access-token.json\`. Create extra client-facing tokens with \`npm run agentkit -- access token create <name> --out <path>\` when a separate website or app needs its own credential.
+- Use \`npm run agentkit -- deploy --smoke "hello"\` or \`npm run agentkit -- deploy smoke --message "hello"\` for an official hosted chat smoke check.
+- Do not run operator/admin commands from a user capsule.
+
+## Files
+
+- \`agentkit.config.ts\`: agent contract and tool registry.
+- \`tools/lookup-order.ts\`: example TypeScript tool.
+- \`prompts/instructions.md\`: support agent instructions.
+- \`.agentkit/\`: local runtime state.
+
+## Rules
+
+- Keep required local secret names in \`.env.schema\` and values in ignored \`.env\`. AgentKit local commands load \`.env\` directly.
+- Do not commit \`.env\` or \`.agentkit/\`.
+`,
+      },
+      {
+        path: "AGENTKIT.md",
+        contents: `# AgentKit Docs
+
+This folder is an AgentKit support Agent Capsule.
+
+## Start Here
+
+If the owner asks you to build an agent in natural language, that request is the brief. Do not ask them to fill another file first.
+
+Example owner request:
+
+> Develop an appointment and intake agent for an ophthalmology office.
+
+Turn the request into a working local capsule:
+
+- Update \`prompts/instructions.md\` with domain-specific behavior, boundaries, intake questions, and escalation rules.
+- Create or update \`AGENT_SPEC.md\` with \`npm run agentkit -- spec init --brief "<owner request>"\`. The owner gives the general idea; the coding agent turns it into the structured contract.
+- Update \`agentkit.config.ts\` when tools, secrets, provider, or access rules change.
+- Add, replace, or remove TypeScript tools under \`tools/\` for real actions or external data.
+- Use \`npm run agentkit -- sync init\` when the agent needs catalog sync, fixture seed data, or ordered migrations.
+- Keep the first version runnable with \`test/fake\` unless the owner explicitly asks for a real provider.
+- Do not use a wizard or recipe. Build the capsule directly from the scaffold, the AgentKit contract, and the owner's brief.
+- Make practical assumptions and list them in your final response.
+- Ask follow-up questions only when missing information blocks a safe local implementation.
+
+## Local Commands
+
+\`\`\`sh
+npm run typecheck
+npm run agentkit -- inspect
+npm run agentkit -- tool lookup_order --input '{"orderId":"A100"}'
+npm run eval
+\`\`\`
+
+\`test/fake\` proves the scaffold and deterministic tool paths. It does not prove natural conversation quality.
+
+\`agentkit new\` installs dependencies by default. Run \`npm install\` only if the capsule was created with \`--no-install\`, install failed, or \`node_modules\` was deleted.
+
+Set local development secrets without opening code:
+
+\`\`\`sh
+printf %s "$OPENAI_API_KEY" | npm run agentkit -- env set OPENAI_API_KEY --stdin
+npm run agentkit -- inspect
+npm run chat -- --message "hello"
+\`\`\`
+
+## Testing With A UI
+
+Local UI:
+
+\`\`\`sh
+npm run dev
+\`\`\`
+
+Open the printed \`Chat:\` URL and tell the owner the exact URL.
+
+Hosted deploy UI:
+
+\`\`\`sh
+npm run agentkit -- deploy
+npm run agentkit -- chat-ui --deploy
+\`\`\`
+
+Open the printed \`Chat:\` URL and tell the owner this local UI is connected to the hosted deploy.
+
+Before claiming real conversation behavior has been tested, ask the owner which provider to use: OpenRouter, OpenAI, Anthropic, or another supported provider. Do not choose for them. After they choose, update \`agentkit.config.ts\`, \`.env.schema\`, local secrets, hosted secrets if deploying, then rerun chat/UI checks.
+
+If you add a tool, also run a fake-provider tool smoke test:
+
+\`\`\`sh
+npm run agentkit -- tool tool_name --input '{}'
+\`\`\`
+
+For the lightweight docs router, read the path printed by:
+
+\`\`\`sh
+npm run agentkit -- docs llms
+\`\`\`
+
+Read the full framework contract with \`npm run agentkit -- docs full\` only when a skill asks for it.
+
+## Database Tools
+
+Tools that need agent-owned tables should use canonical \`ctx.db\` from the tool context. \`ctx.database\` and \`ctx.storage.sql\` are aliases. Do not import local database drivers or Node-only APIs in a tool.
+
+The recommended dual-storage pattern is:
+
+1. Add tables to \`schema.sql\`.
+2. Keep \`storage.driver: "agentkit"\` for deploy-ready capsules.
+3. Run \`npm run agentkit -- tool ...\` or \`npm run chat ...\` locally. AgentKit applies \`schema.sql\` to local development storage.
+4. Use \`npm run agentkit -- db migrate\`, \`db reset --yes\`, \`db seed\`, and \`db shell\` for local database setup and inspection.
+5. Run \`npm run agentkit -- deploy\`. AgentKit migrates/provisions hosted storage internally.
+
+\`schema.sql\` is an idempotent bootstrap file in v1. Use \`CREATE TABLE IF NOT EXISTS\`, \`CREATE INDEX IF NOT EXISTS\`, and safe additive changes. AgentKit does not run destructive schema changes or ordered \`migrations/*.sql\` automatically yet.
+
+## Hosted Deploy
+
+This capsule is deploy-ready by default.
+
+1. Keep tools edge-safe and use \`ctx.db\` instead of importing database drivers.
+2. Run \`npm run agentkit -- build\` only when you want to validate the artifact locally.
+3. If the owner has not logged in yet, ask for an invited AgentKit Cloud alpha token and run \`npm run agentkit -- login --token <token>\`.
+4. Put production secrets into managed secrets with \`npm run agentkit -- secret set <NAME> --from-local-env\`, \`--from-env\`, or \`--stdin\`.
+5. Run \`npm run agentkit -- deploy\`.
+6. Run \`npm run agentkit -- chat-ui --deploy\` to test the hosted agent through a local UI using the auto-created \`.agentkit/chat-access-token.json\`. Create extra client-facing deploy access tokens with \`npm run agentkit -- access token create <name> --out <path>\` when a separate website or app needs its own credential.
+7. Use \`npm run agentkit -- deploy --smoke "hello"\` during deploy or \`npm run agentkit -- deploy smoke --message "hello"\` afterward for an official hosted smoke check.
+
+AgentKit owns hosted infrastructure and production secrets. Do not put production secret values in this capsule. Do not run operator/admin commands from a user capsule.
+`,
+      },
+      {
+        path: "CLAUDE.md",
+        contents: `# ${projectName}
+
+Use AgentKit conventions when editing this support capsule.
+
+- The agent contract lives in \`agentkit.config.ts\`.
+- The example tool lives in \`tools/lookup-order.ts\`.
+- The default provider is \`test/fake\`, which can call tools from JSON messages during local tests.
+- Ask the owner which real provider to use before switching from \`test/fake\`; do not choose OpenRouter, OpenAI, or Anthropic automatically.
+- Keep required local secret names in \`.env.schema\` and values in ignored \`.env\`. AgentKit local commands load \`.env\` directly.
+- Treat the owner's natural-language request as the brief and start implementing inside this capsule.
+- Start with \`skills/agentkit-capsule/SKILL.md\` when the task is not obvious.
+`,
+      },
+      {
+        path: "README.md",
+        contents: `# ${projectName}
+
+Generated by AgentKit as a support Agent Capsule.
+
+## Setup
+
+\`\`\`sh
+npm run chat -- --message "hello"
+npm run agentkit -- tool lookup_order --input '{"orderId":"A100"}'
+npm run eval
+npm run dev
+\`\`\`
+
+\`agentkit new\` installs dependencies by default. Run \`npm install\` only if this capsule was created with \`--no-install\`, install failed, or \`node_modules\` was deleted.
+
+The support template includes a local \`lookup_order\` TypeScript tool and uses \`test/fake\` by default.
+\`test/fake\` does not validate real conversation quality. The owner must choose OpenRouter, OpenAI, Anthropic, or another supported provider before real model behavior is tested.
+
+For UI testing, run \`npm run dev\` and open the printed \`Chat:\` URL. After hosted deploy, run \`npm run agentkit -- chat-ui --deploy\` and open its printed \`Chat:\` URL.
+`,
+      },
+    ];
+  },
+};