TRAITS

describe-model-visible-tool-parameters

For tools defined with effect/ai, every model-visible tool parameter field must have a concise schema description explaining its purpose and any non-obvious constraints or interactions: approved: S.Boolean.pipe(S.optional).annotate({ description: "Set true only after approval of the exact replacement." }), not an undescribed approved field. This rule applies only to effect/ai tools, not other tool frameworks or internal helper parameters.

Applies when
defining model-visible parameter schemas for effect/ai tools.
File types
  • TypeScript
  • TSX
ID
53c1b1d8-2dfb-494c-957a-9403366e69ef
Source
.agents/traits/describe-model-visible-tool-parameters-53c1b1d8-2dfb-494c-957a-9403366e69ef.md

Skipping this trait

Add this comment before any code to skip the trait for a whole file. A reason is required.

File header
// traits-ignore-file 53c1b1d8-2dfb-494c-957a-9403366e69ef: <reason>