Modify doc scripts to copy agent-api reference#931
Merged
heypoom merged 1 commit intometabase:masterfrom Feb 4, 2026
Merged
Conversation
heypoom
approved these changes
Feb 4, 2026
| # These huge files are used by AI tools like Cursor for RAG chunking and indexing. | ||
| # Add more sections to let AI agents understand Metabase better. | ||
| LLMS_FULL_TO_GENERATE = ['embedding'].freeze | ||
| LLMS_FULL_TO_GENERATE = ['embedding', 'agent-api'].freeze |
Member
There was a problem hiding this comment.
I'm not 100% sure if this should be included in LLMS_FULL_TO_GENERATE since this is only a single static llms.txt file for the agent API feature for now.
This will generate only the fully concatenated https://metabase.com/docs/llms-agent-api-full.md variation of the llm file. It is fine if the agent-api/ references are not too long and in Markdown format. If there are lots of content for agent-api/, I suggest creating a https://metabase.com/docs/llms-agent-api.txt instead where it is directories of links.
Reason is that the full context usually bloats the context window, and it's not going to be able to focus as much compared to fetching only a few documents as needed.
alexyarosh
approved these changes
Feb 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Modifies our doc generation scripts to include
docs/agent-apias a path that gets picked up for generating documentation and referenced from the rootllms.txtfile. Anagent-api/reference.mdfile is added to the Metabase repo in metabase/metabase#68914I'm not 100% sure if this should be included in
LLMS_FULL_TO_GENERATEsince this is only a single static llms.txt file for the agent API feature for now. But in the future (e.g. if the API surface area expands) it may make sense to separate it out into multiple files, so maybe a special carve-out isn't needed here?