Agent Guide is Birkly's admin home for Guide · Tools · Publish. This page covers the Guide tab — Birkly's structured context layer for AI systems and connected agents. It sits on top of your existing CMS content, Media library, and other canonical sources — it does not replace them. You declare sources of truth first, then build concise summaries (identity, offerings, claims, voice), and publish a versioned, machine-readable snapshot on your public site domain so agents, crawlers, and integrations can discover and use it responsibly.
AI app connections (Claude, ChatGPT, Cursor, built-in assistant keys) live under Settings → AI — not as an Agent Guide tab.
Works for individuals, teams, enterprises, nonprofits, and any site that wants a single authoritative guide for automated assistants.
Product promise: Publish an authoritative, structured, evidence-aware representation that is easier for AI systems to discover and use. This is not a guarantee that every AI model will ingest your guide, and it is not a chatbot builder.
The Agent Guide hub (three tabs)
Agent Guide answers Guide / Tools / Publish. CMS AI connections are not a hub tab — they live under Settings → AI.
| Tab | Question it answers | Where it actually lives |
|---|---|---|
| Guide | "What should AI say about us?" | Public JSON on your site domain (/.well-known/agent-guide.json) — covered by this doc |
| Tools | "What can an AI helper do on our website while someone is visiting?" | The WebMCP runtime, running in the visitor's browser — off by default |
| Publish | "Where do Guide / Tools actually work, given how my site is hosted?" | Mode-aware summary + hosting checklist |
A compact status strip at the top of the page links into each tab (and may deep-link to Settings → AI for connector status).
- Tools (WebMCP) — see Website tools (WebMCP) for the full catalog, safety model, and how to enable it.
- AI connections — personal connector / service agents / built-in assistant keys: MCP connections and AI connections under Settings → AI.
- Publish — see What gets published and Related Birkly features below; the tab is hosting-mode aware ("On Birkly"
project/vs. "External" vs. "None") and never shows a public URL Birkly can't actually serve for your site's hosting mode.
What problem does it solve?
When someone asks an assistant “What does this organization do?” or “Is their offering a good fit for small teams?”, the answer often comes from scattered pages, outdated summaries, or guesswork. Agent Guide gives you one place to:
- Declare sources of truth — CMS entries, websites, documents, media, marketplaces — where agents should read first.
- Curate the story you want AI to tell (identity, positioning, products, voice).
- Ground that story in evidence (URLs, certifications, review pages, CMS refs).
- Publish a versioned JSON snapshot agents can read without scraping your whole site.
- Link summaries to deeper sources so agents know where to verify details.
Think of Agent Guide as the index and authority map — not the full encyclopedia.
Mental model
┌─────────────────────────────────────────────────────────────┐
│ Sources of truth (registry) │
│ CMS entries/collections · websites · documents · media │
└───────────────────────────┬─────────────────────────────────┘
│ ground summaries & AI Assist
▼
┌─────────────────────────────────────────────────────────────┐
│ CMS Content & Media (underlying content) │
│ About pages, product entries, images, blog posts │
└───────────────────────────┬─────────────────────────────────┘
│ references (IDs, slugs, URLs)
▼
┌─────────────────────────────────────────────────────────────┐
│ Agent Guide (draft → publish) │
│ Context · products · claims · evidence · cross-links │
└───────────────────────────┬─────────────────────────────────┘
│ publish
▼
┌─────────────────────────────────────────────────────────────┐
│ Public export (on your site domain) │
│ /.well-known/agent-guide.json │
│ /llms.txt (Markdown discovery map) │
│ /api/public/ai_presence.php │
│ Optional JSON-LD · MCP tools · graph views │
└─────────────────────────────────────────────────────────────┘
Draft vs published: All edits save to a draft. Public endpoints serve the published snapshot only until you publish again. Iterate safely without affecting what agents see.
Recommended workflow
Follow the admin workflow strip on the Overview tab:
- Sources — Declare where agents should read the truth (start here).
- Context — Identity, positioning, terminology, relationships.
- Products & Services — Structured catalog with source links.
- Claims & Evidence — Factual statements and proof.
- Publish — Enable endpoints, preview, go live (hub Publish tab).
Summaries in Context and Products should reflect your declared sources — not invent parallel truth.
Once your Guide is published, consider the other hub tabs: turn on Tools if you want visitor-facing AI helpers to use your public forms (or Commerce/Events actions), and open Settings → AI if you haven't already connected an AI app to your Birkly CMS.
Where to find it
Admin sidebar → Agent Guide (between Media and Marketplace).
URLs: /admin/?page=agent-guide (legacy alias: ?page=ai-presence). Deep-link a specific hub tab with &zone=guide|tools|publish (e.g. ?page=agent-guide&zone=tools); the default is guide. AI app connections are Settings → AI (?page=settings&tab=ai), not an Agent Guide zone.
Permissions:
| Action | Permission |
|---|---|
| View Agent Guide | read |
| Edit, publish | manage_settings |
Guide tab: Essentials vs Advanced
The Guide tab has a view-mode toggle:
- Essentials (default) — a condensed one-page view of Who we are, Sources, Key messages, and Key claims, each with a Manage all link into the matching Advanced tab. A compact publish status card links into the Publish hub tab.
- Advanced — the full tabbed editor below, for anyone who wants direct access to every field.
Guide → Advanced tabs (at a glance)
| Tab | Purpose |
|---|---|
| Overview | Completeness score, source health, CMS sync drift, link checks, public URLs |
| Sources | sources_of_truth[] registry — CMS, websites, documents, media, marketplaces |
| Context | Identity, positioning, terminology, relationships |
| Products & Services | Structured catalog with typed source links |
| Claims & Evidence | Factual statements, proof sources, review workflow |
| Media | Per-asset context (what it represents, intended use, restrictions) |
Full publish controls (enable publishing, version history, staleness warnings, AI preview) live one level up, in the hub's Publish tab — see The Agent Guide hub.
AI Assist sidebar
The sticky save bar and right-hand AI Assist panel help you fill gaps without auto-saving:
- Auto-fill / Fill gaps / Fill 100% — AI suggestions you approve one-by-one or in bulk
- Suggest sources / cross-links — Propose
sources_of_truthentries, product→CMS links, evidence URLs - Guide Studio (Advanced) — Multi-collection wizard from CMS sources
- Per-field Generate on Context fields — Targeted suggestions applied directly to the field
Suggestions are never auto-saved until you accept them. AI Assist prefers declared sources of truth before inferring.
Documentation map
| Doc | Audience | Contents |
|---|---|---|
| Getting started | Beginners | First publish in ~30 minutes |
| Workflows | Editors | Tab-by-tab how-to |
| Claims, evidence & cross-links | Editors + strategists | Proof, marketplace/review links, source roles |
| AI Assist | Power users | Copilot modes, Guide Studio, field AI |
| Best practices | Everyone | Quality, governance, what not to do |
| Data model | Developers | Schema, storage, completeness scoring |
| Public API | Integrators | Endpoints, views, graph, caching |
| MCP & agents | Developers | MCP tools, resources, agent patterns |
| Website tools (WebMCP) | Everyone | The Tools hub tab — what visitor AI helpers can do, tool catalog, safety, hosting |
| MCP connections | Everyone | Settings → AI — how AI apps connect to Birkly |
Quick start (5 steps)
- Sources — Add at least one narrative source of truth (CMS entry, website, or document).
- Context — Official name, short description; link summaries to sources via
derived_fromwhere helpful. - Products — Add at least one product/service with a canonical source link (CMS entry or public URL).
- Claims — Add 2–3 factual claims; attach evidence with verifiable URLs; mark reviewed claims as Supported.
- Publish — Enable publishing, click Publish, verify
/.well-known/agent-guide.jsonon your public domain.
Full walkthrough: Getting started.
What gets published
Published JSON (agent_guide.v1; legacy exports may show ai_presence.v1) includes:
sources_of_truth[]— Resolved registry of canonical sourcesguide_meta— Product marker and summary-layer hints- identity, positioning, communication_guidance
- products_services[] with resolved
sources[](public URLs) - claims[] with evidence and optional direct sources[]
- media_context, relationships
usage_hints— Guidance for AI consumers (authoritative vs marketing fields; follow sources of truth)identity.derived_from— Which sources ground summary fields- Optional
json_ld— Schema.org graph (Organization, Product/Service, Claim) /llms.txt— Markdown discovery map (links to well-known JSON, API views, and key public pages) when publishing is enabled
Legacy field connected_content[] is migrated into sources_of_truth[] on save.
Discovery aids on published sites: Birkly may inject <link rel="alternate" type="application/json" title="Agent Guide" href="…/agent-guide.json"> into project/ pages when the guide is published, so crawlers and tools can find the JSON without guessing the path.
Related Birkly features
- Agent Guide → Tools — Website tools (WebMCP); what visitor-facing AI helpers can do on your live site. See Website tools (WebMCP).
- Settings → AI — How AI apps and the built-in assistant connect to your Birkly CMS. See MCP connections and AI connections.
- Settings → Site delivery — Public site URL where well-known and API are served
- MCP connections — Inbound agents can read published guide context via MCP tools
- Admin AI chat — Complementary; Agent Guide is structured publish, not conversational UI
FAQ
Does Agent Guide replace my About page or product CMS entries? No. Content stays in Content; Agent Guide references and summarizes for agents.
Why sources of truth first? Agents need a declared reading order. Summaries without sources invite hallucination; the registry tells consumers where to verify.
Will ChatGPT automatically use my guide? Not guaranteed. You make discovery easier via well-known JSON, public API, and JSON-LD. Adoption depends on crawlers, integrations, and MCP-connected tools.
Can I hide draft work from the public? Yes. Only published snapshots are public. Disable publishing or don’t publish until ready.
Do I need AI connections configured? No. Rule-based suggestions and manual editing work without AI. Connecting a provider under Settings → AI unlocks Copilot, Fill 100%, and smarter suggestions.
Do I need a vector database? No. Agent Guide is curated truth + evidence + source links — the right model for “what is officially true about our brand?” Vector search helps fuzzy search over huge unstructured archives (e.g. support tickets). That is a different product problem; optional semantic search could be a future plugin, not core CMS.
Does publishing my Guide turn on website tools? No. Publishing the Guide only makes your fact-sheet JSON public. Website tools (the Tools tab / WebMCP) is a separate, off-by-default switch — see Website tools (WebMCP).
Where do I connect Claude / ChatGPT / Cursor? Settings → AI — not an Agent Guide tab. Agent Guide is Guide · Tools · Publish only.
Legacy paths and tools? /.well-known/brand-context.json, MCP get_brand_context, and admin ?page=ai-presence remain supported as aliases.