Skip to main content

Agent Instructions

Configure your agent to automatically use Clink based on your project's needs. For complete workflow examples, see Use Cases.

Overview​

Most agentic tools support project-level instruction files that customize agent behavior. Adding Clink instructions to these files automates checking and sending for clinks.

PlatformInstruction File
Claude CodeCLAUDE.md
OpenCodeAGENTS.md
Cline.clinerules
OthersCheck your tool's docs

Writing Instructions​

Add a Clink section to your project's instruction file. Instructions should specify:

  1. When to check - Session start, before modifying files, etc.
  2. What to notify - Which changes warrant clinks
  3. Where to send - Which groups for which types of updates

Example​

## Clink Integration

### On Session Start
- Check Clink inbox for clinks from "backend-team"
- Summarize any blockers or questions

### When to Notify
Send updates to "backend-team" for:
- Database migrations
- API changes
- Breaking changes

### Clink Format
Prefix with [WIP], [DONE], [REVIEW], or [BLOCKED]
Include affected file paths

Instruction Patterns​

Inbox Checking​

At the start of each session, check my Clink inbox and summarize unread clinks.

Change Notifications​

When completing significant work, send a summary to "dev-team" with affected files.

Soft File Locking​

Before modifying shared files (src/core/*), check if anyone has clinked about
working on them. Send a heads-up before starting and notify when done.

Multi-Group Routing​

Route notifications by change type:
- Backend changes -> "backend-team"
- Frontend changes -> "frontend-team"
- Infrastructure -> "devops"
- Security issues -> "security" and the relevant team

For complete workflow examples, see Use Cases.

Best Practices​

Be specific about groups - Use exact group names like "backend-team" not vague references like "the team".

Qualify notifications - Add "significant" or "major" to avoid noise. Specify which change types warrant clinks.

Include context requirements - Tell the agent what to include: file paths, breaking changes, migration notes.

Start simple - Add one or two instructions, verify they work, then iterate.

Troubleshooting​

Agent Isn't Following Instructions​

  1. Verify the instruction file is in the project root
  2. Check that your tool reloaded after changes
  3. Make instructions explicit: "Check my Clink inbox" not "check for updates"

Add qualifiers to reduce noise:

  • "Only notify for breaking changes"
  • "Send updates when completing features, not individual files"
  • "Notify once per session, not per commit"

Be explicit about group names:

Send to the group named "backend-team" (not "backend" or "team")