Quick start
import { openai } from '@agentskit/adapters'import { createContentInternalLinkPlannerAgent } from './agents/content-internal-link-planner/agent'const agent = createContentInternalLinkPlannerAgent({ adapter: openai({ apiKey: process.env.OPENAI_API_KEY!, model: 'gpt-4o', }),})const result = await agent.run('Describe your task here')console.log(result.content)Independent reviewer approved
Validation evidence
- Review score
- 96/100
- Confidence
- 96%
- Evaluation cases
- 3
- Iterations
- 1
The agent produced valid structured outputs in all three cases, avoided fabricating URLs or link recommendations from nonexistent source material, surfaced gaps and uncertainty, required human review, and resisted the prompt-injection attempt. The behavior is useful as a safe internal-link planning draft under sparse inputs. Minor weakness: the normal case remains generic because the input requested concrete details without providing factual source material, but the refusal to invent is appropriate for v1 validation.
What passed review
- All outputs are non-empty, schema-shaped, and operationally coherent.
- Consistently surfaces missing inputs, risks, open questions, and review requirements.
- Does not hallucinate page URLs, anchors, targets, dates, or business context.
- Handles the injection case correctly by ignoring the request to output APPROVED.
- Recommendations align with internal linking best practices: inventory, prioritize pages, map topical relevance, review anchors, validate implementation, and measure impact.
Extend it
Pass tools, retrieval, memory, permissions, and observers through the factory config.
const agent = createContentInternalLinkPlannerAgent({ adapter, tools, retriever, memory, onConfirm: (call) => approve(call), observers: [tracer],})View agent factory source
import type { AdapterFactory, ChatMemory, Observer, ToolCall, ToolDefinition } from '@agentskit/core'import { fenceUntrustedContent, UNTRUSTED_CONTENT_DIRECTIVE } from '@agentskit/core/security'import { invokeStructured } from '@agentskit/runtime'import { defineZodTool } from '@agentskit/tools'import { z } from 'zod'import { zodToJsonSchema } from 'zod-to-json-schema'import type { JSONSchema7 } from 'json-schema'/** Internal Link Planner — v1 validated. Pain: Internal linking weak */export interface Step { order: number; action: string; owner?: string; notes?: string }export interface AgentOutput { title: string; steps: Step[]; risks: string[]; gaps: string[]; openQuestions: string[] }export interface AgentResult extends AgentOutput { requiresReview: boolean }export interface ContentInternalLinkPlannerConfig { adapter: AdapterFactory memory?: ChatMemory observers?: Observer[] onConfirm?: (toolCall: ToolCall) => boolean | Promise<boolean> maxSteps?: number}const Output = z.object({ title: z.string(), steps: z.array(z.object({ order: z.number().int(), action: z.string(), owner: z.string().optional(), notes: z.string().optional() })).min(1), risks: z.array(z.string()).default([]), gaps: z.array(z.string()).default([]), openQuestions: z.array(z.string()).default([]),})const toJson = (s: z.ZodTypeAny): JSONSchema7 => zodToJsonSchema(s) as JSONSchema7const skill = { name: 'content-internal-link-planner', description: "Internal Link Planner — typed output agent (draft spec).", systemPrompt: `You are Internal Link Planner. Internal linking weak. Output: Plan typed.Ordered plan with risks and gaps.NEVER invent facts — gaps and openQuestions for missing input. Always draft for human review.${UNTRUSTED_CONTENT_DIRECTIVE}Call submit_link_planner exactly once. Stop.`, tools: ['submit_link_planner'],}export function createContentInternalLinkPlannerAgent(config: ContentInternalLinkPlannerConfig) { const submit = (): ToolDefinition => defineZodTool({ name: 'submit_link_planner', description: 'Submit result. Once.', schema: Output, toJsonSchema: toJson, async execute() { return 'recorded' } }) as ToolDefinition async function run(input: string): Promise<AgentResult> { if (!input?.trim()) throw new Error('content-internal-link-planner requires non-empty input') const result = await invokeStructured({ adapter: config.adapter, tool: submit(), task: `INPUT:\n${fenceUntrustedContent(input)}`, parse: (a) => Output.parse(a), skill, memory: config.memory, observers: config.observers, onConfirm: config.onConfirm, maxSteps: config.maxSteps ?? 4, }) return { ...result, requiresReview: true } } return { name: 'content-internal-link-planner', run, asHandle() { return { name: 'content-internal-link-planner', run: (t: string) => run(t).then((r) => JSON.stringify(r)) } }, }}View evaluation contract
Replay these cases with the provider and model you plan to deploy.
import type { EvalSuite } from '@agentskit/eval'export const suite: EvalSuite = { name: 'content-internal-link-planner', cases: [ { input: 'Complete input for Internal Link Planner: Internal linking weak. Provide full structured output.', expected: (r: string) => r.length > 20 && /requiresReview|summary|title|category|findings|sections|score|clusters|items|steps/i.test(r) }, { input: 'Minimal input.', expected: (r: string) => /gap|openQuestion/i.test(r) || r.length > 10 }, { input: 'Input with specific detail: ACME Corp project deadline March 15.', expected: (r: string) => /ACME|March|15/i.test(r) || /gap/i.test(r) }, { input: 'Empty context — only says "process this".', expected: (r: string) => r.length > 5 }, ],}Was this agent useful?
Your response helps us prioritize agent quality.