docs(#4781): add entity provider conventions to AGENTS.md - #4782
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add an "Entity Provider Conventions" section to the ai-integrations workspace AGENTS.md documenting seven patterns that new entity providers must follow: 1. Source-location annotation format — must use Backstage location-ref url: prefix (e.g. url:oci://), as enforced by collectOciErrors.ts in the extensions module. 2. Full-mutation error handling — guard against replacing catalog entities with an empty set when all item fetches fail but the index succeeds. 3. Per-request timeout — use AbortController with a 30-second timeout on individual HTTP requests. 4. Response size limits — buffer and check body size against MAX_ARTIFACT_BYTES before JSON parsing. 5. Pagination — list endpoints must handle pagination tokens. 6. Shared patterns — common helpers belong in catalog-ai-skills-common to stay under the SonarQube 3% duplication threshold. 7. Reference implementation — points to catalog-backend-module-model-catalog and its config.d.ts as the convention model. These conventions address the root causes of the bugs and review findings from PR #4779: the OCI source-location format mismatch, unsafe full-mutation semantics, and cross-provider inconsistencies in timeout/size-limit/pagination handling. Closes #4781
fullsend-ai-coder
Bot
requested review from
a team,
Lucifergene,
gabemontero,
johnmcollier,
karthikjeeyar and
rohitkrai03
as code owners
September 15, 2026 19:28
|
🤖 Finished Review · ✅ Success · Started 7:29 PM UTC · Completed 7:34 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Cost: $0.81 |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4782 +/- ##
=======================================
Coverage 63.02% 63.02%
=======================================
Files 2642 2642
Lines 105660 105660
Branches 29592 29592
=======================================
Hits 66588 66588
Misses 37256 37256
Partials 1816 1816
*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:
|
Review — approveScope: Documentation-only change — adds 163 lines to Verified claims
AssessmentThe documentation is well-structured, accurate, and properly scoped:
No blocking findings. The conventions provide clear, verifiable guidance grounded in existing codebase patterns. Labels: PR is a documentation-only change adding conventions to AGENTS.md |
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
fullsend-ai-review
Bot
added
ready-for-merge
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.
Add an "Entity Provider Conventions" section to the ai-integrations workspace AGENTS.md documenting seven patterns that new entity providers must follow:
location-ref url: prefix (e.g. url:oci://), as enforced
by collectOciErrors.ts in the extensions module.
catalog entities with an empty set when all item fetches
fail but the index succeeds.
timeout on individual HTTP requests.
MAX_ARTIFACT_BYTES before JSON parsing.
catalog-ai-skills-common to stay under the SonarQube 3%
duplication threshold.
catalog-backend-module-model-catalog and its config.d.ts
as the convention model.
These conventions address the root causes of the bugs and review findings from PR #4779: the OCI source-location format mismatch, unsafe full-mutation semantics, and cross-provider inconsistencies in timeout/size-limit/pagination handling.
Closes #4781
Post-script verification
agent/4781-entity-provider-conventions)2b31f6c223117b5865461ce7f12c976983ef1a49..HEAD)