Set up your coding assistant#
A project rule is a short instruction file that your coding assistant reads at the start of a task. Add one for Storyteller to point your assistant at the docs for your platform.
Add the Storyteller rule#
Replace <platform> with ios, android, web, react-native, or flutter,
and <version> with the SDK version your app uses.
Add the rule to AGENTS.md; in Claude Code, put @AGENTS.md in CLAUDE.md.
## Storyteller
This app uses the Storyteller <platform> SDK, version <version>.
- Before you write or change Storyteller code, read
https://docs.getstoryteller.com/<platform>/ai/llms.txt
- For one topic, use the page file named by the bundle's `<PAGE: slug>`
marker: https://docs.getstoryteller.com/<platform>/ai/llms-<slug>.txt
For Android, the bundle contains the full docs; read the matching section.
- Use only the APIs, options, and defaults that the docs describe. If the
docs don't cover something, say so instead of guessing.
- When you finish, list the docs pages you used.
Download fallback#
If your assistant receives an access-code page instead of the docs, open the
bundle URL in your browser, enter your docs access code if asked, and save the
file in your project as .ai/storyteller-<platform>-docs.md. Replace the rule's
bundle URL with that local path. Download any page files needed for your task
in the same way, and point the rule at those local files too.
Check the setup#
Start a new chat in your project and ask:
Which Storyteller SDK and version does this project use, and which Storyteller
docs file are you following? Quote the first heading of that file.
The assistant should name your platform and version, and quote a heading that mentions Storyteller and "AI bundle" or "AI Context". If it quotes an access-code or sign-in page, follow the download fallback and try again.
When you upgrade the SDK, update the version in the rule and refresh any downloaded files. If your repository uses more than one Storyteller SDK, add one rule section per SDK.
{"slug": "ai-coding-assistants", "page_title": "Set Up Your Coding Assistant", "page_url": "ai/coding-assistants/", "canonical_url": "/ai/coding-assistants/", "markdown": "# Set up your coding assistant\n\nA project rule is a short instruction file that your coding assistant reads at\nthe start of a task. Add one for Storyteller to point your assistant at the\ndocs for your platform.\n\n## Add the Storyteller rule {#rule}\n\nReplace `<platform>` with `ios`, `android`, `web`, `react-native`, or `flutter`,\nand `<version>` with the SDK version your app uses.\n\nAdd the rule to `AGENTS.md`; in Claude Code, put `@AGENTS.md` in `CLAUDE.md`.\n\n```markdown\n## Storyteller\n\nThis app uses the Storyteller <platform> SDK, version <version>.\n\n- Before you write or change Storyteller code, read\n https://docs.getstoryteller.com/<platform>/ai/llms.txt\n- For one topic, use the page file named by the bundle's `<PAGE: slug>`\n marker: https://docs.getstoryteller.com/<platform>/ai/llms-<slug>.txt\n For Android, the bundle contains the full docs; read the matching section.\n- Use only the APIs, options, and defaults that the docs describe. If the\n docs don't cover something, say so instead of guessing.\n- When you finish, list the docs pages you used.\n```\n\n## Download fallback {#download}\n\nIf your assistant receives an access-code page instead of the docs, open the\nbundle URL in your browser, enter your docs access code if asked, and save the\nfile in your project as `.ai/storyteller-<platform>-docs.md`. Replace the rule's\nbundle URL with that local path. Download any page files needed for your task\nin the same way, and point the rule at those local files too.\n\n## Check the setup {#check}\n\nStart a new chat in your project and ask:\n\n```text\nWhich Storyteller SDK and version does this project use, and which Storyteller\ndocs file are you following? Quote the first heading of that file.\n```\n\nThe assistant should name your platform and version, and quote a heading that\nmentions Storyteller and \"AI bundle\" or \"AI Context\". If it quotes an access-code\nor sign-in page, follow the [download fallback](#download) and try again.\n\nWhen you upgrade the SDK, update the version in the rule and refresh any\ndownloaded files. If your repository uses more than one Storyteller SDK, add\none rule section per SDK.\n", "copy_markdown_include_header": false, "base_path": "", "ai_dir": "ai", "missing_payload_behavior": "empty"}