mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d45477d10f
* Improve SEO metadata across docs Generated-By: mintlify-agent * revert api/* changes * Update components/cards.mdx * Update components/visibility.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
45 lines
2.3 KiB
Plaintext
45 lines
2.3 KiB
Plaintext
---
|
|
title: "Customize assistant behavior"
|
|
description: "Customize the AI assistant by adding an Assistant.md file with system instructions that shape its tone, persona, focus areas, and response behavior."
|
|
keywords: ["assistant", "custom instructions", "Assistant.md", "system prompt", "persona"]
|
|
---
|
|
|
|
Add a `.mintlify/Assistant.md` file at the root of your documentation project to give the assistant custom instructions that shape how it responds (`ASSISTANT.md` is also an accepted filename). The assistant uses these instructions as system-level context for every response.
|
|
|
|
<Warning>
|
|
Place your `Assistant.md` file inside the `.mintlify/` directory, not at the root of your project. If you store the file at the root of your project, your custom instructions are publicly accessible by the `/assistant.md` path. The `.mintlify/` directory is not served publicly so your `Assistant.md` file is not accessible when in that directory.
|
|
|
|
If you must store your `Assistant.md` file at the root of your project or any other directory, add it to your [`.mintignore`](/organize/mintignore) file to exclude it from your documentation site.
|
|
</Warning>
|
|
|
|
Instructions in an `Assistant.md` file add to the assistant's system prompt. They do not replace or override the assistant's default instructions.
|
|
|
|
To remove the custom instructions, remove the `Assistant.md` file.
|
|
|
|
Use `Assistant.md` to:
|
|
|
|
- Adjust the assistant's persona and tone
|
|
- Provide product-specific context
|
|
- Define support escalation paths
|
|
- Specify terminology preferences
|
|
- Restrict or scope the assistant's focus areas
|
|
- Provide version-specific guidance
|
|
|
|
## Example `Assistant.md` file
|
|
|
|
```markdown .mintlify/Assistant.md
|
|
You are a helpful assistant for Acme Corp's developer platform.
|
|
|
|
## Tone
|
|
- Be concise and direct. Getting to the point helps people more than being exhaustive.
|
|
- Use technical language appropriate for software developers. Most people asking you questions are familiar with Acme's products.
|
|
|
|
## Product context
|
|
- Acme SDK v3 is the current stable release. v2 is deprecated. If people ask about v2, remind them it's deprecated but answer their questions.
|
|
- Direct billing questions to support@acme.com.
|
|
|
|
## Terminology
|
|
- Use "workspace" instead of "project" or "organization".
|
|
- Use "access token" instead of "API key".
|
|
```
|