Skip to main content

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.

​
Requirements

  • Claude account on Pro, Max, Team, or Enterprise (Custom Connectors require a paid plan)
  • An Audity Personal Access Token (aky_...), see Authentication

​
Claude Desktop / claude.ai

1

Open Connectors

Settings → Connectors → Add Custom Connector.
2

Enter the URL

https://docs.auditynow.com/mcp
3

Configure auth

The connector needs Authorization: Bearer aky_<your-token> on every request to the Audity backend.
  • If Claude shows an “Authorization header” or “API key” field on the connector setup screen: paste Bearer aky_<your-token> (the full string including Bearer , since Claude does not auto-prefix in this flow).
  • If Claude redirects you through an OAuth approval first: approve the redirect, Mintlify is the OAuth provider for the docs surface. After approval, you’ll still get a prompt for your Audity API key. Paste your aky_<your-token> (this time without Bearer , the connector wraps it).
The exact UX depends on Claude Desktop’s current connector flow, which Anthropic iterates on. If you see something unexpected, reach for the troubleshooting section.
4

Test

Start a new chat. Ask:
List my Audity projects.
Claude should call listProjects and return your real projects. If it asks for permission first, approve.

​
Claude Code (CLI)

In your project’s .claude/mcp_servers.json (or via claude mcp add): 
{
  "mcpServers": {
    "audity": {
      "url": "https://docs.auditynow.com/mcp",
      "headers": {
        "Authorization": "Bearer aky_..."
      }
    }
  }
}
Then either restart Claude Code or run claude mcp reload. The Audity tools appear in your tool palette; reference them as mcp__audity__<toolName> (Claude Code auto-prefixes with the server name).

​
What you get

The connector exposes Audity’s full agent surface as Claude tools, 28 operations across projects, leads, Nucleus, and account. Tool names match the operationId in the OpenAPI spec:
  • getCurrentUser, getCurrentTier, getCredits
  • listProjects, createProject, getProject, patchProject
  • triggerAuditAnalysis, getAuditAnalysis
  • listOpportunities, getDeliverables
  • listLeads, getLead, convertLead
  • listMemories, createMemory, deleteMemory
  • listCaptures, createCaptureNote, getCapture, reprocessCapture, deleteCapture
  • listContacts, createContact, updateContact, deleteContact
  • listInsights, getSuggestions
Plus the docs themselves are searchable as context, Claude can answer “how do I X with Audity” by reading the docs page directly without calling an API.

​
Common prompts

List my Audity projects.

Search my Audity Nucleus memories for {topic}.

Start a new audit for {client}, {industry}, {size}. Run the analysis. Tell me when it's done.

Convert my top 3 Audity leads from this week into projects, after confirming with me.

Pull the deliverables for project {id}. Format the executive summary as a client-ready brief.

​
Tips for agent prompts

  • Tell Claude to confirm before spending credits. Audit analysis costs credits, lead conversion costs 1,000 each. Without explicit confirmation in the prompt, Claude will sometimes fire off a batch you didn’t intend.
  • Ask Claude to cite IDs. When summarizing opportunities or memories, have Claude include the id field in its output. That way you can drill into a specific item and verify Claude isn’t confabulating.
  • Use the confidence field on memories. Tell Claude to flag any memory under 0.8 confidence as a hypothesis rather than a fact. Detected patterns are AI-generated; treat them accordingly.

​
Troubleshooting

Check the connector status in Settings → Connectors. If it’s red, re-authorize. If your PAT was revoked or expired, generate a new one and update the connector.
Open https://docs.auditynow.com/authed/mcp/oauth/token in a browser to confirm Mintlify is reachable. If the page errors, try again in 5 minutes, Mintlify occasionally has brief OAuth provider hiccups.
Token format is wrong. Most common cause: the connector double-prefixed Bearer Bearer aky_.... Edit the connector auth and remove one Bearer , or paste only aky_... (depends on which UX field you’re filling, see Step 3 above).
Token lacks write scope. Generate a new token with both read and write scopes, then update the connector.
Your tier doesn’t include agent access. Solo / Scout are read-only, Starter or higher unlocks writes. Check GET /api/user/tier.
See Authentication → Rate limits. The 5-per-minute limit on triggerAuditAnalysis is the most common ceiling for batch workflows.
triggerAuditAnalysis runs synchronously for 60–300 seconds. If Claude reports a timeout, the call may have succeeded server-side. Verify with getAuditAnalysis before re-triggering, re-triggering an in-flight analysis wastes credits.

​
What’s next