bcquality/community/knowledge/agents/set-instructions-as-secrettext.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Validate frontmatter and structure / validate (push) Has been cancelled
Improve partner onboarding and documentation navigation (#174)
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.2 KiB

bc-version domain keywords technologies countries application-area
27..
agents
setinstructions
secrettext
instructions
per-instance
resource
al
w1
all

Set agent instructions as SecretText on the instance

Description

Instructions are instance data, not an enum caption. Agent.SetInstructions takes SecretText so the payload is not logged or copied as ordinary text. A Label or plaintext Text on the agent type is the wrong store: it leaks into telemetry-friendly strings and cannot vary per instance or company.

Best Practice

Load instruction text from a resource or builder into a SecretText variable and call Agent.SetInstructions(AgentUserSecurityId, Instructions) after Create. Keep one instruction document per instance.

See sample: set-instructions-as-secrettext.good.al.

Anti Pattern

Passing a Label or Text to SetInstructions, storing instructions in a setup Text field without wrapping as SecretText, or putting the prompt only in a code comment. Detection signal: SetInstructions with a non-SecretText argument, or no SetInstructions after Create.

See sample: set-instructions-as-secrettext.bad.al.