Documentation Index
Fetch the complete documentation index at: https://docs.animam.ai/llms.txt
Use this file to discover all available pages before exploring further.
Complete reference of tools available via the Animam MCP server.
Corpus
corpus_list
List corpus entries.
Parameters:
| Param | Type | Description |
|---|
segment | string | Filter by segment (optional) |
limit | number | Max count (default: 20) |
You: List entries in the pricing segment
Claude: [Calls corpus_list with segment="pricing"]
Here are the 3 entries in the "pricing" segment:
1. Monthly rates - "Starter: $29, Pro: $49..."
2. FAQ Pricing - "Payment is monthly..."
3. Annual discount - "Save 20%..."
corpus_add
Add an entry to the corpus.
Parameters:
| Param | Type | Required | Description |
|---|
title | string | Yes | Entry title |
content | string | Yes | Content |
segment | string | No | Associated segment |
priority | number | No | Priority 1-10 |
You: Add to corpus: title "Shipping", content "Free shipping over $50", segment "checkout"
Claude: [Calls corpus_add]
I've added the "Shipping" entry to the corpus in the "checkout" segment.
corpus_update
Modify an existing entry.
Parameters:
| Param | Type | Required | Description |
|---|
id | string | Yes | Entry ID |
title | string | No | New title |
content | string | No | New content |
segment | string | No | New segment |
priority | number | No | New priority |
corpus_delete
Delete an entry.
Parameters:
| Param | Type | Required |
|---|
id | string | Yes |
Conversations
conversations_list
List recent conversations.
Parameters:
| Param | Type | Description |
|---|
limit | number | Max count (default: 10) |
segment | string | Filter by segment |
You: Show the last 5 conversations
Claude: [Calls conversations_list with limit=5]
Recent conversations:
1. 2 hours ago - "What are your prices?" (segment: pricing)
2. 3 hours ago - "How do I return a product?" (segment: support)
...
conversations_get
Retrieve a complete conversation.
Parameters:
| Param | Type | Required |
|---|
id | string | Yes |
Chat
chat
Send a message to the chatbot.
Parameters:
| Param | Type | Required | Description |
|---|
message | string | Yes | Message to send |
segment | string | No | Segment to use |
You: Test the chatbot with "Hello, what are your hours?"
Claude: [Calls chat]
Chatbot response:
"Hello! We're open Monday to Friday, 9am to 6pm.
Saturday 10am to 4pm. How can I help you?"
Settings
settings_get
Retrieve tenant settings.
Example:
You: What are the current chatbot settings?
Claude: [Calls settings_get]
Current configuration:
- Name: Sophie
- Title: Sales Assistant
- Tone: Professional
- Formality: Formal
- Emojis: Disabled
- Color: #6366f1
settings_update
Modify settings.
Parameters:
| Param | Type | Description |
|---|
personality.name | string | Bot name |
personality.tone | string | Tone (professional, casual, friendly) |
personality.formality | string | formal or informal |
personality.emojis | boolean | Use emojis |
widget.primaryColor | string | Hex color |
You: Change the bot name to "Emma" and enable emojis
Claude: [Calls settings_update]
I've updated the settings:
- Name: Sophie -> Emma
- Emojis: Disabled -> Enabled
Common workflows
Update corpus from a doc
You: Read the FAQ.md file and add each Q&A to the corpus
Claude: [Reads file, then calls corpus_add multiple times]
I've added 12 entries to the corpus from FAQ.md.
Conversation analysis
You: What are the most frequent questions this week?
Claude: [Calls conversations_list, analyzes patterns]
Top 5 questions:
1. "What are your prices?" (23 times)
2. "International shipping?" (18 times)
...
Test and iterate
You: Test the chatbot on the pricing segment, then improve the pricing response
Claude: [Calls chat, then corpus_update]
Test completed. I've enriched the "Pricing" entry with more details about each plan's features.
