# Markup AI ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.markup.ai/_mcp/server ## Docs - [Markup AI Overview](https://docs.markup.ai/overview.md): Everything you need to get started with Markup AI - [App Directory](https://docs.markup.ai/apps.md): Bring Markup AI's content checks, scores, and rewrites into the tools where your team already writes — Google Docs, Word, PowerPoint, VS Code, Contentful, AEM Guides, Oxygen XML, XMetaL Author, MadCap Flare, MadCap Flare Online, MadCap IXIA CCMS, Heretto CCMS, and Figma. - [Google Docs with Markup AI Chrome Extension](https://docs.markup.ai/apps/google-docs.md): Check, score, and fix your content without leaving Google Docs using the Markup AI Chrome extension. - [Markup AI for Microsoft Word — Integration Guide](https://docs.markup.ai/apps/m365-word.md): Install, configure, and use the Markup AI add-in inside Microsoft Word to check, score, and rewrite content without leaving Word. - [Markup AI for Microsoft PowerPoint — Integration Guide](https://docs.markup.ai/apps/m365-powerpoint.md): Install, configure, and use the Markup AI add-in inside Microsoft PowerPoint to check, score, and rewrite slide content without leaving your deck. - [Markup AI for Contentful — Integration Guide](https://docs.markup.ai/contentful/install.md): Install, configure, and use the Markup AI app inside Contentful to check and resolve content issues without leaving the entry editor. - [Markup AI for AEM Guides — Integration Guide](https://docs.markup.ai/apps/aem-guides.md): Install, configure, and use the Markup AI integration inside AEM Guides to check and score structured DITA content without leaving the editor. - [Markup AI for Figma — Integration Guide](https://docs.markup.ai/apps/figma.md): Install, configure, and use the Markup AI integration inside Figma to check text layers in your designs against your style, terminology, and brand guidelines. - [Markup AI for Oxygen XML — Integration Guide](https://docs.markup.ai/apps/oxygen.md): Integration Guide - [Markup AI for Oxygen XML in Eclipse — Integration Guide](https://docs.markup.ai/apps/oxygen-eclipse.md): Integration Guide - [Markup AI for XMetaL Author — Integration Guide](https://docs.markup.ai/apps/xmetal.md): Install, configure, and use the Markup AI plugin inside XMetaL Author to check, score, and rewrite your XML documents without leaving the editor. - [Markup AI for MadCap Flare — Integration Guide](https://docs.markup.ai/apps/madcap-flare.md): Install, configure, and use the Markup AI plugin inside MadCap Flare to check, score, and rewrite your topics without leaving the editor. - [MadCap Flare Online with Markup AI Chrome Extension](https://docs.markup.ai/apps/madcap-flare-online.md): Check, score, and fix content without leaving MadCap Flare Online using the Markup AI Chrome extension. - [MadCap IXIA CCMS with Markup AI Chrome Extension](https://docs.markup.ai/apps/ixiasoft.md): Check, score, and fix DITA content without leaving MadCap IXIA CCMS using the Markup AI Chrome extension. - [Heretto CCMS with Markup AI Chrome Extension](https://docs.markup.ai/apps/heretto.md): Check, score, and fix DITA topics without leaving Heretto CCMS using the Markup AI Chrome extension. - [Markup AI for VS Code — Integration Guide](https://docs.markup.ai/apps/vscode.md): Install, configure, and use the Markup AI extension inside Visual Studio Code to check, score, and fix content without leaving your editor. - [Markup AI Lint for VS Code — Integration Guide](https://docs.markup.ai/apps/vscode-lint.md): Install, configure, and use the Markup AI Lint extension in Visual Studio Code to check content as you write, with inline diagnostics, one-click fixes, and batch folder checking. - [Recipe Gallery](https://docs.markup.ai/recipes.md): Automate content checks, rewrites, and scoring with step-by-step guides for Zapier, MCP, n8n, and GitHub Actions. - [Automated Content Quality with Zapier](https://docs.markup.ai/recipes/zapier.md): Run the Markup AI Style Agent on text from any Zapier-connected app and act on the results without writing code. - [About MCP](https://docs.markup.ai/mcp.md): Connect Claude, Cursor, or any MCP client to Markup AI's hosted Model Context Protocol server at api.markup.ai/mcp/ and review content with three tools — markupai_review, markupai_run_agents, and markupai_capabilities_and_configs. - [Claude Desktop with Markup AI MCP](https://docs.markup.ai/mcp/claude-desktop-mcp.md): Connect Markup AI from Claude's connector directory and run content agents in your chats. - [ChatGPT with Markup AI MCP](https://docs.markup.ai/mcp/chatgpt-mcp.md): Install the Markup AI plugin from ChatGPT's Plugins directory and run content agents in your chats. - [LibreChat with Markup AI MCP](https://docs.markup.ai/mcp/librechat-mcp.md): Connect LibreChat to the hosted Markup AI MCP server at api.markup.ai/mcp/ by adding it to librechat.yaml. - [Claude Code with Markup AI MCP](https://docs.markup.ai/mcp/claude-code-mcp.md): Connect Claude Code to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents from the Claude CLI. - [Codex with Markup AI MCP](https://docs.markup.ai/mcp/codex-mcp.md): Connect the OpenAI Codex CLI to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents from Codex. - [Cursor with Markup AI MCP](https://docs.markup.ai/mcp/cursor-mcp.md): Connect Cursor to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents inline in your editor. - [Kiro with Markup AI MCP](https://docs.markup.ai/mcp/kiro-mcp.md): Connect Kiro to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents in your workflow. - [VSCode with Markup AI MCP](https://docs.markup.ai/mcp/vscode-mcp.md): Connect Visual Studio Code to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents with your AI assistant. - [Windsurf with Markup AI MCP](https://docs.markup.ai/mcp/windsurf-mcp.md): Connect Windsurf to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents in your coding workflow. - [Zed with Markup AI MCP](https://docs.markup.ai/mcp/zed-mcp.md): Connect Zed to the hosted Markup AI MCP server at api.markup.ai/mcp/ and run content agents directly in the editor. - [Automated Content Quality Check with GitHub Actions](https://docs.markup.ai/github-action.md): Run the Markup AI Style Agent on your repository's content during pull requests, pushes, and scheduled runs — with risk-based feedback posted right inside GitHub. - [Automated Content Quality with n8n](https://docs.markup.ai/recipes/n8n.md): Run the Markup AI Style Agent on text from any node in n8n and act on the results inside your workflows. - [How Agents Work](https://docs.markup.ai/agents.md): Markup AI's content agents — specialized checks for brand, clarity, accuracy, and AI visibility that apply your organization's standards automatically. - [AI Voice](https://docs.markup.ai/agents/ai-voice-detector.md): Make AI-assisted drafts sound like you wrote them. - [Brand Terms](https://docs.markup.ai/agents/terminology.md): Keep every word on the approved list. - [Brand Voice](https://docs.markup.ai/agents/brand-voice.md): Sound like your brand, everywhere. - [Claims](https://docs.markup.ai/agents/generic-claims.md): Catch risky claims before compliance does. - [Date & Time Accuracy](https://docs.markup.ai/agents/date-time-accuracy.md): Catch dates and times that can't be right. - [Fluff](https://docs.markup.ai/agents/focus-agent.md): Get to the point — and stay on it. - [Freshness](https://docs.markup.ai/agents/freshness.md): Never publish stale facts again. - [Key Takeaways](https://docs.markup.ai/agents/key-takeaways.md): Put your key takeaways where readers — and AI — look first. - [Link Integrity](https://docs.markup.ai/agents/link-integrity.md): Every link goes where it says it goes. - [Persona](https://docs.markup.ai/agents/persona.md): Read your content through your buyer's eyes. - [Q&A Optimization](https://docs.markup.ai/agents/answer-authority.md): Headings that answer the question. - [Sentence Clarity](https://docs.markup.ai/agents/sentence-clarity.md): Make every sentence easy to read. - [Snippet Readiness](https://docs.markup.ai/agents/snippet-readiness.md): Write sections that survive being quoted. - [Source Authority](https://docs.markup.ai/agents/source-authority.md): Give every claim a source AI search trusts. - [Style](https://docs.markup.ai/agents/style-agent.md): Your whole style guide, applied in one pass. - [Users](https://docs.markup.ai/admin/users.md): Invite people to your Markup AI workspace and manage their access — roles on every plan, groups on Enterprise. - [Groups](https://docs.markup.ai/admin/groups.md): Define groups, choose their permissions, manage their members, and map them to your identity provider. - [Style Agent Visibility](https://docs.markup.ai/admin/style-agent.md): For organizations with the Style Agent — control which style guides each group can see and set the default a check uses. - [Roles & Permissions](https://docs.markup.ai/admin/roles-and-permissions.md): The Administrator and Member roles on the Starter and Business plans, and the fine-grained permissions that replace them on the Enterprise plan. - [Set Up SSO](https://docs.markup.ai/admin/sso-setup.md): Connect your identity provider to Markup AI with SAML or OIDC. Self-service, no Markup AI engineer required. - [Attribute Mapping](https://docs.markup.ai/admin/attribute-mapping.md): Turn the group claims your identity provider sends into Markup AI groups, regardless of how your IdP names or formats them. - [SCIM Provisioning](https://docs.markup.ai/admin/scim.md): Push users and groups from your identity provider into Markup AI ahead of first login, and keep them in sync. - [API Keys](https://docs.markup.ai/admin/api-keys.md): Create and manage the API keys your integrations use to authenticate with Markup AI. - [Plans & Trials](https://docs.markup.ai/admin/billing/plans.md): The free trial, the Starter and Business plans, Enterprise, and how word allowances work. - [Manage Your Subscription](https://docs.markup.ai/admin/billing/manage.md): Subscribe to a plan, update payment details, change or cancel your plan, and fix payment issues. - [Quickstart](https://docs.markup.ai/quickstart.md): Markup AI API quickstart - [Running Agents](https://docs.markup.ai/developer/agents.md): Discover, run, and track Markup AI content agents via the REST API. - [AI Voice](https://docs.markup.ai/developer/agents/ai-voice-detector.md): Run the AI Voice agent (ai_voice_detector) via the Markup AI API. - [Brand Terms](https://docs.markup.ai/developer/agents/terminology.md): Run the Brand Terms agent (terminology) via the Markup AI API. - [Brand Voice](https://docs.markup.ai/developer/agents/brand-voice.md): Run the Brand Voice agent (brand_voice) via the Markup AI API. - [Claims](https://docs.markup.ai/developer/agents/generic-claims.md): Run the Claims agent (generic_claims) via the Markup AI API. - [Date & Time Accuracy](https://docs.markup.ai/developer/agents/date-time-accuracy.md): Run the Date & Time Accuracy agent (date_time_accuracy) via the Markup AI API. - [Fluff](https://docs.markup.ai/developer/agents/focus-agent.md): Run the Fluff agent (focus_agent) via the Markup AI API. - [Freshness](https://docs.markup.ai/developer/agents/freshness.md): Run the Freshness agent (freshness) via the Markup AI API. - [Key Takeaways](https://docs.markup.ai/developer/agents/key-takeaways.md): Run the Key Takeaways agent (key_takeaways) via the Markup AI API. - [Link Integrity](https://docs.markup.ai/developer/agents/link-integrity.md): Run the Link Integrity agent (link_integrity) via the Markup AI API. - [Persona](https://docs.markup.ai/developer/agents/persona.md): Run the Persona agent (persona) via the Markup AI API. - [Q&A Optimization](https://docs.markup.ai/developer/agents/answer-authority.md): Run the Q&A Optimization agent (answer_authority) via the Markup AI API. - [Sentence Clarity](https://docs.markup.ai/developer/agents/sentence-clarity.md): Run the Sentence Clarity agent (sentence_clarity) via the Markup AI API. - [Snippet Readiness](https://docs.markup.ai/developer/agents/snippet-readiness.md): Run the Snippet Readiness agent (snippet_readiness) via the Markup AI API. - [Source Authority](https://docs.markup.ai/developer/agents/source-authority.md): Run the Source Authority agent (source_authority) via the Markup AI API. - [Style](https://docs.markup.ai/developer/agents/style-agent.md): Run the Style agent (style_agent) via the Markup AI API. ## API Docs - API Reference > Brand Terms [Import terminology from CSV or ACTIF XML](https://docs.markup.ai/developer-reference/api-reference/brand-terms/import-terminology.md) - API Reference > Brand Terms [Export terminology to CSV](https://docs.markup.ai/developer-reference/api-reference/brand-terms/export-terminology-csv.md) - API Reference > Brand Terms [Export terminology to ACTIF](https://docs.markup.ai/developer-reference/api-reference/brand-terms/export-terminology-actif.md) - API Reference > Brand Terms [Search Terminology](https://docs.markup.ai/developer-reference/api-reference/brand-terms/search-terminology.md) - API Reference > Brand Terms [List Term Sets](https://docs.markup.ai/developer-reference/api-reference/brand-terms/list-term-sets.md) - API Reference > Brand Terms [Create Term Set](https://docs.markup.ai/developer-reference/api-reference/brand-terms/create-term-set.md) - API Reference > Brand Terms [Get Term Set](https://docs.markup.ai/developer-reference/api-reference/brand-terms/get-term-set.md) - API Reference > Brand Terms [Delete Term Set](https://docs.markup.ai/developer-reference/api-reference/brand-terms/delete-term-set.md) - API Reference > Brand Terms [Update Term Set](https://docs.markup.ai/developer-reference/api-reference/brand-terms/update-term-set.md) - API Reference > Brand Terms [Create Term](https://docs.markup.ai/developer-reference/api-reference/brand-terms/create-term.md) - API Reference > Brand Terms [Get Term](https://docs.markup.ai/developer-reference/api-reference/brand-terms/get-term.md) - API Reference > Brand Terms [Update Term](https://docs.markup.ai/developer-reference/api-reference/brand-terms/update-term.md) - API Reference > Brand Terms [Delete Term](https://docs.markup.ai/developer-reference/api-reference/brand-terms/delete-term.md) - API Reference > Brand Terms [List Domains](https://docs.markup.ai/developer-reference/api-reference/brand-terms/list-domains.md) - API Reference > Brand Terms [Create Domain](https://docs.markup.ai/developer-reference/api-reference/brand-terms/create-domain.md) - API Reference > Brand Terms [Get Domain](https://docs.markup.ai/developer-reference/api-reference/brand-terms/get-domain.md) - API Reference > Brand Terms [Delete Domain](https://docs.markup.ai/developer-reference/api-reference/brand-terms/delete-domain.md) - API Reference > Brand Terms [Update Domain](https://docs.markup.ai/developer-reference/api-reference/brand-terms/update-domain.md) - API Reference > Style Agent [Get Style Agent Config](https://docs.markup.ai/developer-reference/api-reference/style-agent/get-style-agent-config.md) - API Reference > Style Agent [List Style Agent Targets](https://docs.markup.ai/developer-reference/api-reference/style-agent/list-style-agent-targets.md) - API Reference > Style Agent [Get Style Agent Target](https://docs.markup.ai/developer-reference/api-reference/style-agent/get-style-agent-target.md) - API Reference > Style Agent [List Style Guides](https://docs.markup.ai/developer-reference/api-reference/style-agent/list-style-guides.md) - API Reference > Style Agent [Get Style Guide](https://docs.markup.ai/developer-reference/api-reference/style-agent/get-style-guide.md) - API Reference > Style Agent [List Style Agent Content Profiles](https://docs.markup.ai/developer-reference/api-reference/style-agent/list-style-agent-content-profiles.md) - API Reference > Style Agent [Run Style Agent](https://docs.markup.ai/developer-reference/api-reference/style-agent/run-style-agent.md) - API Reference > Style Agent [Run Style Agent File](https://docs.markup.ai/developer-reference/api-reference/style-agent/run-style-agent-file.md) - API Reference > Style Agent [Get Style Agent Workflow](https://docs.markup.ai/developer-reference/api-reference/style-agent/get-style-agent-workflow.md) - API Reference > Style Agent [List Style Agent Batches](https://docs.markup.ai/developer-reference/api-reference/style-agent/list-style-agent-batches.md) - API Reference > Style Agent [Create Style Agent Batch](https://docs.markup.ai/developer-reference/api-reference/style-agent/create-style-agent-batch.md) - API Reference > Style Agent [Append Style Agent Batch Items](https://docs.markup.ai/developer-reference/api-reference/style-agent/append-style-agent-batch-items.md) - API Reference > Style Agent [Get Style Agent Batch](https://docs.markup.ai/developer-reference/api-reference/style-agent/get-style-agent-batch.md) - API Reference > Agent Workflows [List Workflows](https://docs.markup.ai/developer-reference/api-reference/agent-workflows/list-workflows.md) - API Reference > Agent Workflows [Get Workflow Status](https://docs.markup.ai/developer-reference/api-reference/agent-workflows/get-workflow-status.md) - API Reference > Agent Workflows [Cancel Workflow](https://docs.markup.ai/developer-reference/api-reference/agent-workflows/cancel-workflow.md) - API Reference > Agent Workflows [Stream Workflow Events](https://docs.markup.ai/developer-reference/api-reference/agent-workflows/stream-workflow-events.md) - API Reference > Agents [List Agents](https://docs.markup.ai/developer-reference/api-reference/agents/list-agents.md) - API Reference > Agents [List Categories](https://docs.markup.ai/developer-reference/api-reference/agents/list-categories.md) - API Reference > Agents [Get Agent](https://docs.markup.ai/developer-reference/api-reference/agents/get-agent.md) - API Reference > Agents [Run Agent](https://docs.markup.ai/developer-reference/api-reference/agents/run-agent.md) - API Reference > Personas [List Personas](https://docs.markup.ai/developer-reference/api-reference/personas/list-personas.md) - API Reference > Personas [Get Persona](https://docs.markup.ai/developer-reference/api-reference/personas/get-persona.md) - API Reference > Brand Voice Profiles [List Profiles](https://docs.markup.ai/developer-reference/api-reference/brand-voice-profiles/list-profiles.md) - API Reference > Brand Voice Profiles [Get Profile](https://docs.markup.ai/developer-reference/api-reference/brand-voice-profiles/get-profile.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.markup.ai/openapi.json) - [OpenAPI YAML](https://docs.markup.ai/openapi.yaml)