Point your tool at these docs
Use any of these entry points:/llms.txt— a machine-readable index at the site root./llms-full.txtcontains the full documentation in one file.- Any page as Markdown — append
.mdto a page’s URL to get its raw source. - MCP server — available at
/mcpfor tools that can search documentation through MCP. - The contextual menu on every page (top right) copies the page as Markdown or opens it directly in Claude, ChatGPT, or Cursor.
The instrumentation prompt
Paste this prompt into your coding agent with the repository open. It includes the rules from What to capture. Also provide this site’s URL or/llms-full.txt if the agent needs the full SDK reference.
After the agent finishes
Review the diff before running it. Pay particular attention to event usefulness, data safety, and delivery:- Read the event list. Each event should help explain an individual customer’s experience. There is no fixed target count. Names should read like
Report exported, not log identifiers. See the event naming guidance. - Check the coverage. Look for activation milestones, value consumed, explicit feedback, friction, and lifecycle changes. Remove raw clickstream and background-process noise.
- Check the properties. They should be small and bounded, with no credentials, customer-authored content, search text, arbitrary errors, or stack traces.
- Check every exit path. A serverless handler that tracks must
await glyph.flush()before responding. A script must callclose(). A shorter flush interval is not a replacement. See The process exited before flushing. - Check authority. Payments, subscriptions, and completed server workflows should be tracked where the server confirms the outcome, not from a browser success screen.
glyph_test_... key and trigger each instrumented action. Check the resulting timelines in the test environment before configuring the live key.