Skip to main content

​
Use Docs With AI Tools

OmniCoreAgent docs are written for people and AI coding tools. Use this page when you want the docs inside your editor, chat session, or agent workflow.
AI tools are a faster way to navigate the docs. They do not replace source-code verification for production changes.

​
Ask AI In The Docs

Use the Ask AI action in the docs header to ask questions against the official OmniCoreAgent documentation. Good prompts:
Ask AI should answer with the docs as source context. If a feature is not documented, verify in the source code or open an issue.

​
Copy Or View A Page As Markdown

Use the contextual menu on any docs page to copy the page as Markdown or view the raw Markdown source. This is useful when you want to paste one exact docs page into ChatGPT, Claude, Perplexity, Cursor, or another coding agent. Best use cases:
  • explain one API surface
  • convert one example to your app
  • compare memory, workspace, and task-store behavior
  • ask for a migration checklist from a specific docs page

​
Use /llms.txt

Mintlify publishes an AI-readable docs index at:
Use this when an AI tool asks for a documentation index or when you want to give a coding agent the full docs map before it starts changing code. Example prompt:

​
Use The Hosted Docs MCP

Mintlify exposes the docs as an MCP server at:
Use this with an MCP-capable editor or agent when you want documentation search available as a tool instead of pasting pages manually. Ask your tool to search the docs MCP for exact topics:

​
Use Cursor Or VS Code

Use the contextual menu actions for Cursor or VS Code when you want the current docs page opened inside your editor context. Useful workflow:
  1. Open the docs page that matches your task.
  2. Send it to Cursor or VS Code from the contextual menu.
  3. Ask the editor agent to update your app using only that docs page and your local source files.
Example prompt:

​
Use ChatGPT, Claude, Or Perplexity

The contextual menu can open the current docs page in ChatGPT, Claude, or Perplexity. Use this when you want explanation, comparison, or planning around one specific docs page. Good prompts:

​
Where To Start

Quick Start

Run the smallest useful OmniCoreAgent.

Configuration

Find environment variables and runtime config.

Agent Harness

Understand what OmniCoreAgent adds around the model.

OmniServe

Serve an agent through REST and SSE.