Skip to content

docs: bring the llms.txt and llms-full.txt headers in line with the CLI setup - #667

Open
zantvoort wants to merge 1 commit into
mainfrom
docs/llms-txt-cli-setup
Open

zantvoort wants to merge 1 commit into
mainfrom
docs/llms-txt-cli-setup

Conversation

@zantvoort

Copy link
Copy Markdown
Collaborator

Summary

Follow-up to #666: aligns the agent-facing summaries in llms.txt and the llms-full.txt header with what the CLI does and how it is set up.

  • An existing rules file (such as CLAUDE.md) keeps its content; Storm adds its own marked block.
  • The MCP server runs locally and is read-only: schema metadata only, never the database credentials, row data only when the user enables it.
  • init and demo are marked as interactive commands for the user to run in a terminal (Node.js 18+), so an agent reading the file does not try to run them itself.
  • Adds the global install (npm install -g @storm-orm/cli), the storm init / storm demo forms, and storm update as the non-interactive refresh.

Verification

  • bash website/scripts/generate-llms-full.sh regenerates llms-full.txt with the new header.

@codecov

codecov Bot commented Oct 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant