mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
cdxker
239cc73a77
* Update agent/index.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update agent/index.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
47 lines
2.3 KiB
Plaintext
47 lines
2.3 KiB
Plaintext
---
|
|
title: "What is the agent?"
|
|
description: "Automate documentation updates with the agent. Create updates from Slack messages, PRs, or API calls."
|
|
keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"]
|
|
---
|
|
|
|
<Info>
|
|
The agent is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard.
|
|
</Info>
|
|
|
|
The agent creates pull requests with proposed changes to your documentation based on your prompts. When you send a request to the agent, it references your documentation, connected repositories, and Slack messages to create content that follows technical writing best practices and adheres to the Mintlify schema.
|
|
|
|
## What you can do with the agent
|
|
|
|
Use the agent to:
|
|
|
|
- Write new content based on your prompts, links to pull requests, or Slack threads.
|
|
- Revise outdated code examples and API references.
|
|
- Search and update existing content.
|
|
- Answer questions about your docs and technical writing topics.
|
|
- Capture knowledge from Slack conversations and pull requests before it gets lost.
|
|
|
|
## Where you can use the agent
|
|
|
|
- **Dashboard**: From any page in your dashboard, use the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) to open the agent panel. Or click **Ask agent** on the [Overview](https://dashboard.mintlify.com/) page.
|
|
<Frame>
|
|
<img src="/images/agent/dashboard-light.png" alt="The agent panel open in the dashboard." className="block dark:hidden" />
|
|
<img src="/images/agent/dashboard-dark.png" alt="The agent panel open in the dashboard." className="hidden dark:block" />
|
|
</Frame>
|
|
- **Slack**: Add the agent to your Slack workspace and mention `@mintlify` to prompt it.
|
|
- **API**: Embed the agent in custom applications using the [agent endpoints](/api-reference/agent/create-agent-job)
|
|
|
|
## Next steps
|
|
|
|
<Card title="Quickstart" horizontal icon="rocket" href="/agent/quickstart">
|
|
Start using the agent in your dashboard.
|
|
</Card>
|
|
<Card title="Connect Slack" horizontal icon="slack" href="/agent/slack">
|
|
Add the agent to your Slack workspace.
|
|
</Card>
|
|
<Card title="Customize behavior" horizontal icon="wrench" href="/agent/customize">
|
|
Configure the agent with an `AGENTS.md` file.
|
|
</Card>
|
|
<Card title="Write effective prompts" horizontal icon="pen" href="/agent/effective-prompts">
|
|
Get better results with focused prompts.
|
|
</Card>
|