docs(#4340): add entity provider schema contracts to boost AGENTS.md - #4341
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#4340): add entity provider schema contracts to boost AGENTS.md#4341fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Document upstream AiResource/agent and AiModelServerAPI/ai-model-server schema requirements in the boost workspace AGENTS.md. This closes a documentation gap that caused rework on PR #4260, where a human reviewer had to flag missing spec.instructions and spec.handoffs fields because neither the issue spec nor AGENTS.md documented the upstream entity schema contracts. The new section lists schema-required fields (type, lifecycle, owner for AiResource; plus serverType and serverUrl for AiModelServerAPI) and key optional fields that entity providers should populate (instructions, handoffs, handoffDescription, model, tools, modelSettings for agents; models.available, models.default, requiresApiKey for model servers). Cross-references the canonical JSON schema files in the ai-integrations workspace and notes the AiResourceAgentProcessor's runtime type validation via collectAgentErrors. Note: prettier could not run in sandbox (missing @backstage/cli dependency). Manual formatting verified. Closes #4340
fullsend-ai-coder
Bot
requested review from
a team,
gabemontero,
johnmcollier,
jordigilh,
mareklibra and
rohitkrai03
as code owners
August 16, 2026 22:21
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4341 +/- ##
=======================================
Coverage 61.36% 61.36%
=======================================
Files 2520 2520
Lines 100978 100978
Branches 28295 28295
=======================================
Hits 61965 61965
Misses 38462 38462
Partials 551 551
*This pull request uses carry forward flags. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
Document upstream AiResource/agent and AiModelServerAPI/ai-model-server schema requirements in the boost workspace AGENTS.md. This closes a documentation gap that caused rework on PR #4260, where a human reviewer had to flag missing spec.instructions and spec.handoffs fields because neither the issue spec nor AGENTS.md documented the upstream entity schema contracts.
The new section lists schema-required fields (type, lifecycle, owner for AiResource; plus serverType and serverUrl for AiModelServerAPI) and key optional fields that entity providers should populate (instructions, handoffs, handoffDescription, model, tools, modelSettings for agents; models.available, models.default, requiresApiKey for model servers). Cross-references the canonical JSON schema files in the ai-integrations workspace and notes the AiResourceAgentProcessor's runtime type validation via collectAgentErrors.
Note: prettier could not run in sandbox (missing @backstage/cli dependency). Manual formatting verified.
Closes #4340
Post-script verification
agent/4340-add-entity-schema-docs)887e675df7939b79648353ce9001dc9cc7ed09d3..HEAD)