> ## Documentation Index
> Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Audity User Guide

> Drive your Audity workspace from any HTTP client, automation tool, or AI assistant.

## What this is

Audity exposes a single agent-ready surface so your AI assistant (Claude, ChatGPT, Cursor, n8n, anything that speaks MCP) can act on your Audity workspace the same way you can in the app: create projects, trigger audit synthesis, fetch deliverables, search your Nucleus memories, and convert leads into projects.

There is one URL to remember:

```text theme={null}
https://docs.auditynow.com/mcp
```

Drop that into any MCP-compatible client. Authenticate with a Personal Access Token (PAT) from your Audity settings. You're done.

## What you can do today

| Capability               | Example                                                                                     |
| ------------------------ | ------------------------------------------------------------------------------------------- |
| List and create projects | "Start a new audit for Acme Corp, mid-market, healthcare."                                  |
| Run audit synthesis      | "Run the audit analysis for the Initech project and summarize the top three opportunities." |
| Fetch deliverables       | "Pull the latest deliverable for Pied Piper and email me the executive summary."            |
| Search Nucleus memories  | "What do you remember about Acme's stakeholder concerns?"                                   |
| Convert leads            | "Convert the latest lead from my readiness ReadyLink into a full audit."                    |
| Capture notes            | "Add this meeting transcript to the Initech project as a capture."                          |

## How it works

```text theme={null}
┌──────────────────────────────────────────────────────────────────┐
│  Your AI assistant (Claude, ChatGPT, Cursor, n8n, AIOS)         │
└────────────────────────┬─────────────────────────────────────────┘
                         │ MCP (Mintlify-generated)
                         ▼
┌──────────────────────────────────────────────────────────────────┐
│  docs.auditynow.com/mcp  +  docs.auditynow.com/llms.txt                 │
└────────────────────────┬─────────────────────────────────────────┘
                         │ HTTPS + Bearer PAT
                         ▼
┌──────────────────────────────────────────────────────────────────┐
│  Audity API                                                      │
│  PAT resolves to your Clerk identity → tier + RLS gates apply   │
└──────────────────────────────────────────────────────────────────┘
```

Every agent call goes through the same permission stack that protects the web app:

* Your PAT proves you are you
* Your **subscription tier** (`solo`, `starter`, `growth`, `agency`) gates which features are callable
* **Supabase Row-Level Security** ensures the agent can only see data you own
* **Credit deductions** apply normally (creating a project costs credits, just like in the app)

## What you can't do (yet)

We're shipping the v1 surface deliberately small. These are intentional v1 exclusions:

* Document file uploads (multipart), coming in v2; for now upload via the web app
* Real-time Nucleus co-pilot (`/live`), requires a UI
* Admin-only routes
* Stakeholder CRUD (low agent leverage in v1)

If you need any of these sooner, [tell us](mailto:support@auditynow.com).

## Two ways to connect

<CardGroup cols={2}>
  <Card title="Claude" icon="anthropic" href="/guides/claude">
    Add Audity as a remote MCP connector inside Claude.
  </Card>

  <Card title="ChatGPT" icon="openai" href="/guides/chatgpt">
    Install the Audity App from the ChatGPT App Store.
  </Card>
</CardGroup>

## What's under the hood

If you're a developer or just curious:

* The full API is documented as **OpenAPI 3.1**, see the [API Reference](/api-reference/openapi.json)
* The MCP server is auto-generated by Mintlify from the spec
* Auth is **Bearer token** (`aky_...`) issued from your Audity settings page
* All write operations are audit-logged in `nucleus_actions`

Ready? [Start with the quickstart →](/quickstart)
