feat(v1_0): inline catalog instructions and remove instructions.md#1590
Open
gspencergoog wants to merge 4 commits into
Open
feat(v1_0): inline catalog instructions and remove instructions.md#1590gspencergoog wants to merge 4 commits into
gspencergoog wants to merge 4 commits into
Conversation
Modify the Catalog schema definition in client_capabilities.json to accept plain Markdown strings for instructions instead of requiring relative file URIs. Inline the basic catalog layout instructions directly into catalog.json and delete the external instructions.md file entirely. Update the evaluation harness and protocol documentation to reflect that catalog instructions are inlined Markdown strings. This addresses feedback from PR a2ui-project#1522 discussing the drawbacks of URI references inside catalog definitions sent to LLMs.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
jgindin
reviewed
Jun 9, 2026
jgindin
left a comment
jgindin
left a comment
Collaborator
There was a problem hiding this comment.
What about the changes to tools/build_catalog/assemble_catalog.py ?
…tructions in assembler Define strict TypeScript interfaces (CatalogSchema, JsonSchema, ProtocolSchemas) in types.ts to describe protocol and catalog schema structures. Replace loose Record<string, any> and any type annotations across the evaluation script (index.ts, validator.ts, generator.ts, evaluator.ts, test_validator.ts) with ProtocolSchemas. Update Genkit flow input schemas in generation_flow.ts and evaluation_flow.ts to use z.custom<ProtocolSchemas>(). Update tools/build_catalog/assemble_catalog.py to support preserving inline Markdown instructions across source catalogs and configure --instructions with action="extend" to inject external instruction files. Add unit test in test_assemble_catalog.py to verify instructions accumulation across catalogs and CLI files. This addresses code review feedback on PR a2ui-project#1590 requesting strict typing for schema structures and ensures robust assembler support for inline instructions.
Collaborator
Author
Good point, I was just focusing on the spec. I've updated the |
gspencergoog
force-pushed
the
inline_instructions
branch
from
f5ac1aa to
d1e0d40
Compare
jacobsimionato
approved these changes
Jun 9, 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
3 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.
Description
This addresses feedback from PR #1522 discussing the drawbacks of URI references inside catalog definitions sent to LLMs.
client_capabilities.jsonto accept plain Markdown strings for instructions instead of requiring relative file URIs.catalog.jsonand delete the externalinstructions.mdfile entirely.