Skip to content

Conversation

@bryantgillespie
Copy link
Member

This PR adds documentation for our upcoming AI chat feature.


This pull request introduces comprehensive documentation for the new AI Chat feature in Directus. It adds a full set of guides covering overview, setup, usage, available tools, tips, and best practices, aimed at helping both administrators and users understand and utilize the AI Chat assistant. The documentation details supported models, configuration steps, tool permissions and approval modes, cost management, and practical usage scenarios.

New AI Chat Documentation

  • Feature Overview and Capabilities: Introduces the AI Chat assistant, describes what it can do (content management, schema operations, flows, data exploration), lists supported AI models from OpenAI and Anthropic, and highlights key features like tool approval and security.
  • Setup and Configuration: Provides step-by-step instructions for administrators to obtain API keys, configure them in Directus, customize system prompts, and manage costs. Includes details on requirements and security of API keys.
  • User Guide and Usage Instructions: Explains how to access AI Chat, select models, interact via conversation, understand responses, manage tool approvals, and handle conversation history and permissions.
  • Tool Reference and Approval Modes: Documents all available tools, differentiates between system and admin-only tools, explains page context tools, and describes how to configure tool approval settings to balance safety and convenience.
  • Tips, Best Practices, and Example Prompts: Offers actionable advice for effective use, cost management, prompt examples for common use cases, and cautions about permissions and destructive actions.

Navigation Update

  • Adds navigation metadata to support the new AI Chat documentation section.

@bryantgillespie bryantgillespie requested a review from a team as a code owner December 3, 2025 22:58
@vercel
Copy link

vercel bot commented Dec 3, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Dec 5, 2025 5:05pm

@bryantgillespie bryantgillespie requested review from alexchopin and Copilot and removed request for a team December 3, 2025 22:58
Copilot finished reviewing on behalf of bryantgillespie December 3, 2025 22:59
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request introduces comprehensive documentation for Directus's new AI Chat feature. The PR adds two PNG screenshot images for visual guidance and navigation metadata files to organize the new documentation structure within the guides section.

Key Changes:

  • Adds two screenshot images for the AI Chat interface (model selector and tool menu)
  • Creates navigation structure for AI Chat and MCP Server documentation under the AI guides section
  • Establishes a hierarchical documentation organization with proper metadata files

Reviewed changes

Copilot reviewed 7 out of 29 changed files in this pull request and generated no comments.

File Description
public/img/ai-chat-model-selector-cropped.png Screenshot showing the AI Chat model selection interface
public/img/ai-chat-tool-menu-open-cropped.png Screenshot displaying the AI Chat tool menu in open state
content/guides/10.ai/2.mcp/.navigation.yml Navigation metadata for MCP Server documentation section
content/guides/10.ai/2.mcp/7.local-mcp/.navigation.yml Navigation metadata for Local MCP subsection

Note: The navigation files follow a consistent structure with title and headline fields. The binary image files cannot be reviewed for content accuracy but appear to be properly formatted PNG files based on the diff metadata. No issues were identified in the reviewed navigation metadata files.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

bryantgillespie and others added 4 commits December 5, 2025 11:59
Co-authored-by: James White <jwhite@conduktor.io>
Co-authored-by: James White <jwhite@conduktor.io>
Co-authored-by: James White <jwhite@conduktor.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants