feat(documentation): added llms.txt, examples and referenced these artifacts via README#748
Merged
feat(documentation): added llms.txt, examples and referenced these artifacts via README#748
Conversation
sid-rl
approved these changes
Mar 2, 2026
Contributor
sid-rl
left a comment
sid-rl
left a comment
There was a problem hiding this comment.
some minor code duplication concerns but looks good otherwise! make sure example scripts are runnable before merging
| return result.skipped or has_failed_checks or len(result.cleanup_status.failed) > 0 | ||
|
|
||
|
|
||
| def wrap_recipe( |
Contributor
There was a problem hiding this comment.
basically a duplicate of wrap_recipe_with_options right? could we clean up/refactor?
examples/mcp_github_tools.py
Outdated
| from .example_types import ExampleCheck, RecipeOutput, RecipeContext | ||
|
|
||
|
|
||
| def unique_name(prefix: str) -> str: |
Contributor
There was a problem hiding this comment.
defined in both example files, maybe can just be implemented in _harness.py?
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
2 participants
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.
This adds a generator for a consolidated, short list of recipes that external agents can reference using
EXAMPLES.md. Also adds anllms.txtand updates theREADME.mdto reference the new artifacts.This puts the python client in approx parity with the ts client.
The purpose of this entire change is to create recipe-style examples that LLMs can look at to improve their performance when using our SDKs and APIs.