docs(#4697): extend @visibility guidance to entity provider packages - #4700
docs(#4697): extend @visibility guidance to entity provider packages#4700fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add a "Config declarations in entity provider packages" subsection to the boost AGENTS.md, placed after the existing "Adding new config fields" section. This covers ogx-entity-provider and kagenti-entity-provider, which maintain their own config.d.ts files outside the centralized Zod schema system. The new guidance instructs agents to: 1. Declare every field the config reader reads in config.d.ts 2. Add @visibility backend/secret annotations on sensitive fields 3. Reuse utilities from boost-connector-utils instead of duplicating This addresses the gap where the code agent omitted @visibility annotations on security-sensitive fields in PR #4574 because the existing guidance was scoped only to boost-backend. Closes #4697 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4700 +/- ##
=======================================
Coverage 62.63% 62.63%
=======================================
Files 2635 2635
Lines 105225 105225
Branches 29539 29551 +12
=======================================
Hits 65909 65909
Misses 37462 37462
Partials 1854 1854
*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 · Commit: |
|
🤖 Finished Review · ✅ Success · Started 9:17 PM UTC · Completed 9:22 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Cost: $1.01 |
Review — approveScope: Documentation-only change — 19 lines added to What this PR doesAdds a "Config declarations in entity provider packages" subsection to the boost workspace AGENTS.md, placed after the existing "Adding new config fields" section. The new guidance instructs agents to:
This addresses a gap identified in issue #4697 where the code agent omitted Verification
Findings[low · docs-accuracy] Suggested rewording: "The This inaccuracy is non-blocking — the guidance is still directionally correct and valuable. An agent working on |
|
|
||
| When reviewing PRs that add or modify `boost.*` config keys, verify all five registration steps above were completed. | ||
|
|
||
| ### Config declarations in entity provider packages |
There was a problem hiding this comment.
[low] docs-accuracy
States kagenti-entity-provider maintains its own config.d.ts, but this package has no config.d.ts file. Only ogx-entity-provider has one. kagenti-entity-provider reads config fields (boost.entityProviders.kagenti.*) not declared in any config.d.ts within the package.
Suggested fix: Reword to: The ogx-entity-provider package maintains its own config.d.ts; kagenti-entity-provider should follow the same pattern (it currently lacks one).



Add a "Config declarations in entity provider packages" subsection to the boost AGENTS.md, placed after the existing "Adding new config fields" section. This covers ogx-entity-provider and kagenti-entity-provider, which maintain their own config.d.ts files outside the centralized Zod schema system.
The new guidance instructs agents to: 1. Declare every field the config reader reads in config.d.ts 2. Add @visibility backend/secret annotations on sensitive fields 3. Reuse utilities from boost-connector-utils instead of duplicating
This addresses the gap where the code agent omitted @visibility annotations on security-sensitive fields in PR #4574 because the existing guidance was scoped only to boost-backend.
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
Closes #4697
Post-script verification
agent/4697-extend-visibility-guidance)6199e863193f683e7175922f87c8124dd5502b20..HEAD)