Skip to content

QUA-1518: Enhance Agent Q page#1071

Open
RafaelOsiro wants to merge 7 commits intomainfrom
qua-1518-enhance-agent-q-page
Open

QUA-1518: Enhance Agent Q page#1071
RafaelOsiro wants to merge 7 commits intomainfrom
qua-1518-enhance-agent-q-page

Conversation

@RafaelOsiro
Copy link
Contributor

@RafaelOsiro RafaelOsiro commented Mar 16, 2026

Overview

This PR restructures and significantly expands the AI & Agents documentation section of the Qualytics User Guide. The old ai/ pages (3 files) have been replaced by a comprehensive, multi-layered section under ai-and-agents/ with 20 content pages, 51 screenshots, updated navigation, and redirects to preserve all existing URLs.

Key Changes

  • New Overview page: Entry point for the AI & Agents section — covers Agent Q capabilities, interaction methods (Full-Page Chat, Floating Chat, REST API, External MCP Clients), built-in intelligence features, and navigation tables linking to all reference and managing pages.

  • Deep Dive section (6 pages):

    • MCP: What is the Model Context Protocol, how it works, and key concepts.
    • Agent Q in Action: MCP endpoint, authentication, all available tools (Exploration, Quality Checks, Data Transformation, Anomalies, Insights, Operations, Guided Workflows), and Tool Step Labels.
    • Conversations, Responses & Context (new): How to write prompts, Smart Suggestions, Understanding Responses, Context-Aware Conversations, Long Conversations & Memory (compression details), Background Streaming, Session Persistence, and Example Conversations.
    • Best Practices (new): Prompt design, cost management, dynamic tool loading, topic guardrail behavior, rate limits, and async operation patterns.
    • Agent Q Limits (expanded): All enforced limits with exact values — rate limits, token budgets (per-execution and per-call), timeouts (3 layers), tool output truncation strategy, conversation compression parameters, SQL constraints, scope constraints, discovery/listing limits, input limits, and error reference.
    • Agentic API: Building custom applications with the REST-based Agentic API.
    • Removed legacy screenshots: docs/assets/integrations/ai/chatgpt/auth-prompt.png and mcp-app-creation.png removed — both migrated to docs/assets/integrations/ai-and-agents/managing/add-agent-q-integration/.
  • API reference page: Full REST API reference for Agent Q — chat, sessions, specialized endpoints, and LLM configuration management.

  • FAQ page (expanded): Covers setup, usage, security, cost, and troubleshooting — including new questions on what happens when Agent Q makes a mistake, cost management, conversation sharing/storage, language support, LLM provider changes, empty smart suggestions, and off-topic request handling.

  • Managing section (11 pages): Step-by-step guides with screenshots for every user-facing action:

    • Add / Update / Remove LLM Integration
    • Start / Resume / Rename / Archive / Restore / Delete a Conversation
    • Search Conversations
    • Chat Interface Tips (refresh, collapse/expand sidebar, expand floating chat, stop a response, paste large content, prompt suggestions)
  • Screenshots: 51 new screenshots organized per page under docs/assets/integrations/ai-and-agents/.

  • Navigation & redirects: mkdocs.yml updated with the full new nav tree. Redirects added for all old URLs (ai/mcp.md, ai/agentic.md, ai/mcp-quickstart.md, and previously renamed managing pages) to prevent 404s.

  • Removed legacy pages: ai/mcp.md, ai/agentic.md, ai/mcp-quickstart.md — content migrated and expanded into the new structure.

Screenshots

… overview

- Replaced old ai/ nav entries (mcp, agentic, mcp-quickstart) with the new
  ai-and-agents/ structure: Overview, API, FAQ, Deep Dive, and Managing sections
- Updated integrations/overview.md links to point to the new paths
- Added redirects for all renamed/removed pages to prevent 404s
Deleted mcp.md, agentic.md, and mcp-quickstart.md from the legacy
ai/ folder — content migrated and expanded under the new ai-and-agents/ structure.
Added all screenshots for the new ai-and-agents/ documentation structure,
covering add/update/remove integration, all conversation management flows
(start, resume, rename, archive, restore, delete, search), and chat interface tips.
New section covering Agent Q and MCP integration with full content across
three layers:

- Overview: entry point with capabilities, interaction methods, and navigation
- Deep Dive: MCP concepts, Agent Q in Action, Conversations & Context,
  Best Practices, Limits, and Agentic API
- Managing: step-by-step guides for add/update/remove integration and all
  conversation management flows (start, resume, rename, archive, restore,
  delete, search, chat interface tips)
- API reference and FAQ pages
@RafaelOsiro RafaelOsiro self-assigned this Mar 16, 2026
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Mar 16, 2026
Deleted auth-prompt.png and mcp-app-creation.png from the old ai/chatgpt/
folder — both images have been migrated to the new ai-and-agents/ structure.
@RafaelOsiro RafaelOsiro marked this pull request as ready for review March 16, 2026 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant