Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions agent/effective-prompts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,34 @@
- `@mintlify Find and fix all typos in the docs`
- `@mintlify change all unordered lists to use * instead of -`

## Reference files and folders with `@` mentions

When you prompt the agent from the dashboard agent panel, type `@` to open an autocomplete menu of files and folders from your documentation. Selecting an item attaches it to your message as context, so the agent knows exactly which content you want it to use or update.

Use `@` mentions to:

- Point the agent at a specific page when a description would be ambiguous.
- Scope a broad task to a single folder, such as a product area or section.
- Combine multiple files in one prompt without describing each path in prose.

To attach a file or folder:

1. In the agent panel composer, type `@` followed by the name of the file or folder you want to reference.
2. Use the arrow keys to highlight an item in the autocomplete list.
3. Press <kbd>Enter</kbd> or <kbd>Tab</kbd> to attach it. Press <kbd>Esc</kbd> to dismiss the menu.

The attached file or folder appears as a chip above the composer. You can attach multiple items in the same message and remove any chip before sending.

Check warning on line 41 in agent/effective-prompts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/effective-prompts.mdx#L41

Use 'preceding' instead of 'above'.

Attached items are passed to the agent as labeled context with their paths, so you can reference them naturally in your prompt:

Check warning on line 43 in agent/effective-prompts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/effective-prompts.mdx#L43

In general, use active voice instead of passive voice ('are passed').

- `Update @quickstart with the new collaborator invite flow`
- `Review every page in @api-reference for outdated response examples`
- `Move @authentication into the new @security folder and update internal links`

<Tip>
`@` mentions are available in the agent panel composer in the dashboard. In Slack, attach context by replying in a thread, sharing pull request links, or uploading files directly to your message.
</Tip>

## Specify a domain name for multi-site organizations

If you have multiple documentation sites, include the `subdomain` parameter in your message to specify which documentation set the agent should work on.
Expand Down
1 change: 1 addition & 0 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Use the agent to:
- Address code review feedback to maintain documentation quality.
- Capture knowledge from Slack conversations and pull requests before it gets lost.
- Navigate and coordinate changes across multiple files and directories efficiently.
- Reference specific files and folders with `@` mentions in the dashboard agent panel to scope requests precisely.

## Connect your GitHub account

Expand Down
Loading