YaparAI MCP Server
Enables posting to Facebook, managing inbox messages, and AI-generated replies through YaparAI's social media enterprise tools.
Provides access to Flux image generation models for text-to-image and image-to-image creation through YaparAI's content generation platform.
Provides tools for posting to Instagram, managing inbox/DMs, generating captions and hashtags, and AI-suggested replies through YaparAI's social media platform.
Integrates with Suno v4 for AI music generation, enabling creation of full songs with vocals and instrumentals through YaparAI's content generation tools.
Allows posting to TikTok and managing social media content through YaparAI's enterprise social media tools.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@YaparAI MCP Servergenerate an image of a sunset over Istanbul"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
YaparAI MCP Server
All-in-one AI content creation + enterprise social media, CRM & competitor intel — directly from Claude Desktop, Cursor, Windsurf, and other MCP-compatible AI assistants.
What is YaparAI?
YaparAI is an all-in-one AI platform with 43 tools across content generation, e-commerce, and enterprise operations:
Image Generation — Flux, SDXL, Imagen 4 (text-to-image, image-to-image)
Video Generation — Veo 3.1, Kling (text-to-video, image-to-video)
Music Generation — Suno v4 (full songs with vocals, instrumentals)
Image Editing — Background removal, face swap, style transfer
E-commerce — Virtual try-on, AI mannequin for product photos
448+ Templates — Pre-built ComfyUI workflows (logos, ads, product photos...)
AI Text & Vision — Gemini-powered text generation and image analysis
Chatbots — Interact with AI chatbots via API
Social Media — Post, caption, hashtag, inbox, AI auto-reply, quota (Enterprise)
CRM — Customer management, AI info extraction, shipping, bulk messaging (Enterprise)
Competitor Analysis — Track competitors, compare KPIs, SWOT snapshots (Enterprise, v0.5.0)
Product Catalog — Org product CRUD, stock management (Enterprise, v0.5.0)
Related MCP server: social-neuron
Quick Start
1. Install
pip install yaparai2. Get your API Key
Sign up at yaparai.com (100 free credits)
Go to Settings > API Anahtarları
Choose scope:
Personal — your credits, your data (default)
Enterprise — if you're a member of an organization, select it to enable competitor/product/inbox/CRM tools scoped to that org
Create the key and copy it (shown only once!)
3. Configure Claude Desktop
Edit your Claude Desktop config (Settings > Developer > Edit Config):
{
"mcpServers": {
"yaparai": {
"command": "yaparai",
"env": {
"YAPARAI_API_KEY": "yap_live_your_key_here"
}
}
}
}Org-bound keys (v0.5.0+) — if your key is bound to an organization during creation, enterprise tools (competitors, products, inbox, CRM) automatically use that org. The old
YAPARAI_ORG_IDenv var is optional — only needed if you want to override the bound org or use a personal key for enterprise actions.
4. Use it!
> "Generate an image of a sunset over Istanbul"
> "List available templates for logo design"
> "Which competitors have the lowest PageSpeed score?"
> "Add a new product to our catalog: Summer T-Shirt, 149 TL"
> "Show me unread DMs on Instagram"
> "Send shipping info to customer #123 — Yurtiçi, tracking ABC456"Available Tools (43)
Content Generation (4)
Tool | Description | Cost |
| Flux / SDXL / Imagen 4 ( | ~6 credits |
| Veo 3.1 or Kling (text-to-video, image-to-video) | ~350 credits |
| Suno v4 (vocals or instrumental) | ~14 credits |
| Music + video combined | ~364 credits |
Image Editing (3)
Tool | Description | Cost |
| Image-to-image style transfer | ~6 credits |
|
| ~2 credits |
| Face swap — | ~6 credits |
E-commerce (2)
Tool | Description | Cost |
| Virtual clothing try-on | ~6 credits |
| AI mannequin for product photos | ~6 credits |
Avatar (1)
Tool | Description | Cost |
| Talking avatar from photo | ~14 credits |
Templates (3)
Tool | Description | Cost |
| Browse 448+ templates | Free |
| Get template inputs/details | Free |
| Run template (supports | Varies |
AI Tools (2)
Tool | Description | Cost |
| Gemini text generation (scripts, lyrics, storyboard) | ~2 credits |
| Gemini Vision image analysis | ~2 credits |
Chatbot (2)
Tool | Description | Cost |
| List available chatbots | Free |
| Chat with a YaparAI chatbot | Varies |
Enterprise: Social Media (10)
Requires an enterprise API key (org-bound) or YAPARAI_ORG_ID.
Tool | Description | Cost |
| List connected social accounts | Free |
| Post to Instagram/Facebook/TikTok/X (supports | Free |
| v0.4.0 — list published & scheduled posts | Free |
| v0.4.0 — check platform quota & usage | Free |
| AI-generate post caption | Free |
| AI-generate hashtags | Free |
| Read social media inbox/DMs | Free |
| Read conversation messages | Free |
| Reply to a DM/message | Free |
| Get AI-suggested reply | Free |
Enterprise: CRM (6)
Tool | Description | Cost |
| Browse CRM customers (filter by platform/tag) | Free |
| Get customer details | Free |
| AI-extract info from conversations | Free |
| Send tracking notification | Free |
| Mass message — supports | Free |
| Import customers from inbox | Free |
Enterprise: Competitor Analysis — v0.5.0 (3)
Tool | Description | Cost |
| List tracked competitors (PageSpeed, followers, product count) | Free |
| Get detailed competitor info | Free |
| Compare 2–4 competitors — KPI snapshot for SWOT analysis | Free |
Enterprise: Product Catalog — v0.5.0 (3)
Tool | Description | Cost |
| List org products with SKU, price, category, stock | Free |
| Add new product to catalog | Free |
| Toggle | Free |
Utility (4)
Tool | Description | Cost |
| List your organizations | Free |
| Check credit balance | Free |
| List models and costs | Free |
| Check job status | Free |
Configuration
Env Variable | Description | Default |
| Your API key (required) | — |
| Organization ID — optional if your key is org-bound | — |
| API base URL |
|
Which key should I create?
Scenario | Scope |
Just me, for generation/editing | Personal — default |
I'm part of a company on YaparAI and want enterprise tools | Enterprise — pick org during key creation |
Multiple orgs, one key | Use a personal key + pass |
Cursor / Windsurf / Claude Code
Same configuration format in MCP settings:
{
"yaparai": {
"command": "yaparai",
"env": {
"YAPARAI_API_KEY": "yap_live_your_key_here"
}
}
}Python SDK Usage
import asyncio
from yaparai.client import YaparAIClient
async def main():
client = YaparAIClient(api_key="yap_live_your_key_here")
# Generate an image
job = await client.generate({"type": "image", "prompt": "A futuristic city"})
result = await client.wait_for_result(job["job_id"])
print(result["result_url"])
# Compare competitors (v0.5.0 — org-bound API key)
comparison = await client.enterprise_compare_competitors(
["uuid-1", "uuid-2", "uuid-3"]
)
print(comparison)
# Add a product (v0.5.0)
product = await client.enterprise_create_org_product({
"name": "Summer T-Shirt",
"price": 149,
"stock_status": "in_stock",
"category": "apparel",
})
print(product)
asyncio.run(main())Reliability (v0.4.0+)
Exponential backoff retry — 3 retries on network errors (1s → 2s → 4s + jitter), rate-limit aware (429 → 5s/10s/15s)
Literal type annotations on
platform,model,style,output_format— IDE auto-complete catches wrong values earlyStructured logging —
logging.getLogger("yaparai")for debug traceability32 unit tests on HTTP client, generation, editing, social, CRM, org resolution
CI on Python 3.10 / 3.11 / 3.12 + ruff lint
Pricing
100 free credits on signup (no credit card required)
Image:
6 credits ($0.50)Video:
350 credits ($3–5)Music:
14 credits ($1)Enterprise features: included with subscription
Credits never expire
Links
Website: yaparai.com
Enterprise Portal: kurumsal.yaparai.com
Gallery: yaparai.com/gallery
API Keys: yaparai.com/settings (personal) · kurumsal.yaparai.com/settings?tab=api-keys (org-bound)
Support: destek@yaparai.com
Release Notes
v0.5.0 (2026-04-21) — 6 new enterprise tools (competitor analysis + product catalog), org-bound API keys
v0.4.0 (2026-04-21) — 2 new tools, retry + logging, Literal types, full test suite. Community contribution by @enis1998
v0.3.1 — FastMCP 3.x compatibility
v0.3.0 — 30 tools, full platform coverage
v0.2.0 — 13 tools, PyPI ready
Full history: CHANGELOG.md
Contributors
Thanks to everyone who has contributed to YaparAI MCP!
@ilhankilic — Creator & maintainer
@enis1998 — v0.4.0: 2 new tools, retry mechanism, type safety, test suite
Want to contribute? Check out CONTRIBUTING.md.
License
Apache 2.0 — see LICENSE
Available Tools
43 toolsai_reply_suggestionA
Get an AI-generated reply suggestion for a social media conversation.
The AI reads the conversation context and suggests an appropriate reply. You can customize the AI behavior with a system prompt.
| Name | Required | Description | Default |
|---|---|---|---|
| conversation_id | Yes | Conversation ID to suggest a reply for | |
| account_id | Yes | Social account ID | |
| system_prompt | No | Optional custom instructions for the AI (e.g., "Reply politely in Turkish, offer 10% discount") | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description bears full responsibility. It states the AI 'reads the conversation context and suggests an appropriate reply,' indicating a non-destructive read operation. However, it does not explicitly state that it does not modify anything, nor does it mention authorization requirements or rate limits. The description is reasonably transparent but could be more explicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences long, front-loaded with the main purpose, and contains no redundant information. Every sentence adds necessary context: what the tool does, how it works, and customization option. Highly efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema and 100% parameter coverage, the description covers the key functionality. It explains the tool's purpose and customization. However, it lacks mention of prerequisites (e.g., conversation must exist) or potential errors, which would make it fully complete. Still, for a straightforward suggestion tool, it is adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema coverage is 100%, so each parameter has a description in the schema. The tool description adds value by stating that the system prompt can customize behavior, which aligns with the schema. However, it does not provide additional semantic meaning beyond what the schema already conveys, such as the purpose of conversation_id and account_id. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: 'Get an AI-generated reply suggestion for a social media conversation.' The verb 'get' and resource 'reply suggestion' are specific, and it differentiates from siblings like 'generate_text' (general text) and 'reply_to_message' (manual reply) by focusing on AI-generated suggestions for social media.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not provide explicit guidance on when to use this tool versus alternatives such as 'generate_text' or 'chat_with_bot'. It lacks when-not-to-use scenarios and does not mention prerequisites like conversation existence. The only hint is the mention of 'system prompt' customization, but no direct usage advice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
analyze_imageA
Analyze an image using Gemini Vision AI.
Upload an image and ask questions about it. Can identify objects, read text, describe scenes, analyze compositions, and more. Cost: ~2 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| image_url | Yes | URL of the image to analyze | |
| prompt | No | Question or instruction about the image (e.g., "What product is shown?", "Read the text in this image") | Describe this image in detail |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It discloses non-destructive nature by indicating analysis only, and adds cost information ('~2 credits'). It could be more explicit about no side effects, but sufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with purpose, no redundant information. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Tool is simple (2 params, no nested objects) and has an output schema. Description covers purpose, capabilities, and cost, making it complete enough for an agent to select and invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% description coverage, so baseline is 3. The description adds context (upload, ask questions, capabilities) but does not significantly enhance parameter meaning beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'analyze' with resource 'image' and lists specific capabilities (objects, text, scenes, compositions), distinguishing it from sibling tools like generate_image or transform_image which create or modify images.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It describes when to use the tool (analyze an image with questions) but does not explicitly state when not to use it or mention alternatives among siblings. However, the context makes it clear it's for analysis, not generation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
bulk_messageA
Send a message to multiple customers at once.
Broadcast promotions, announcements, or updates to a list of customers via their respective social platforms. You can target by specific IDs, a customer tag, or a platform.
| Name | Required | Description | Default |
|---|---|---|---|
| message | Yes | Message text to send | |
| customer_ids | No | List of specific customer IDs to message | |
| tag | No | Send to all customers with this tag (e.g., "vip", "returning") | |
| platform | No | Send only to customers from this platform | |
| media_urls | No | Optional list of image/video URLs to attach | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description should disclose behaviors like async execution, rate limits, or error handling. It only describes what the tool does, not its behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Concise two-sentence description with a clear first sentence. Could be slightly more structured but no unnecessary information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given output schema exists and schema coverage is 100%, description is mostly complete for purpose and targeting. Missing behavioral details are notable but not critical for basic usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema has 100% description coverage, so baseline is 3. Description reiterates targeting options but does not add significant meaning beyond schema. It mentions media_urls but no extra nuance.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool sends messages to multiple customers at once, with use cases (promotions, announcements) and targeting methods (IDs, tag, platform). Distinguishes well from siblings like reply_to_message and send_shipping_info.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description gives general usage scenarios but lacks explicit guidance on when not to use or comparison with alternatives. It does not mention that sending to specific IDs vs tag vs platform are mutually exclusive or how they interact.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
chat_with_botA
Send a message to a YaparAI chatbot and get a response.
Each chatbot is specialized for different tasks (customer support, product recommendations, etc.). Use list_chatbots() to discover available bots. Provide conversation_id to continue a conversation.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Chatbot slug (from list_chatbots results) | |
| message | Yes | Your message to the chatbot | |
| conversation_id | No | Optional — continue an existing conversation |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, but the description implies a write operation (sending a message) and includes response. It does not detail side effects, auth requirements, or rate limits, but the behavior is straightforward.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences: first states purpose, second adds key context (specialization and continuation). Every sentence is essential and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Tool is simple, and output schema exists (so return values are documented externally). Description covers prerequisites and continuation. Lacks mention of potential errors or bot availability, but overall sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% coverage with clear descriptions. Description adds minimal value beyond 'continue a conversation' and specialization remark. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states 'Send a message to a YaparAI chatbot and get a response,' specifying the verb (send), resource (chatbot), and outcome (get response). It distinguishes itself from sibling tools like list_chatbots (discovery) and read_conversation (reading).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance to use list_chatbots() for discovering available bots and to provide conversation_id for continuing conversations. It does not specify when not to use, but the context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
check_balanceA
Check your YaparAI credit balance.
Returns your current credit balance, total credits used, and the currency (credits).
No credits are charged for this operation.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of transparency. It discloses that the operation is free (no credit charge) and describes the return values. It does not mention rate limits or other behaviors, but for a simple read-only check this is adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with three short sentences, each adding value. No redundant information. It is front-loaded with the core purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's simplicity (zero parameters, output schema present), the description fully explains the purpose, return values, and cost. No gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, and the schema coverage is 100% (empty properties). Per guidelines, baseline for 0 params is 4. The description adds no parameter info because none is needed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool checks the YaparAI credit balance and specifies the exact return values (current balance, total used, currency). This is a specific verb+resource combination that distinguishes it from sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly notes that no credits are charged for this operation, providing clear context on when to use it. While it does not mention alternatives or exclusions, the free-of-charge nature is a strong usage guideline.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
compare_competitorsA
Compare 2–4 competitors on key metrics.
Returns latest metric snapshots for each competitor including PageSpeed score, total followers, posts in last 30 days, and product count. Use this as the basis for SWOT analysis or positioning decisions.
| Name | Required | Description | Default |
|---|---|---|---|
| competitor_ids | Yes | 2–4 competitor UUIDs | |
| org_id | No | Optional — override the org bound to the API key |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries transparency burden. Describes 'latest metric snapshots' and lists returned metrics, making behavior clear. No hidden destructive actions or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences with front-loaded purpose. No unnecessary words. Efficiently conveys purpose, metrics, and use case.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers purpose, metrics, and use case. Has output schema. Missing potential limitations like data freshness or prerequisites, but sufficient for selection and invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% coverage with good descriptions. Description adds context about the 2-4 competitor range and return metrics, but does not significantly extend schema info.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states it compares 2-4 competitors and lists specific metrics (PageSpeed, followers, posts, product count). Distinguishes from sibling tools like get_competitor (individual) and list_competitors (list).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states use for SWOT analysis or positioning decisions, providing good context. Lacks explicit when-not-to-use guidance, but siblings offer alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_org_productB
Create a new product in your organization's catalog.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Product name (required) | |
| sku | No | Optional SKU / part number | |
| price | No | Optional price (numeric) | |
| currency | No | ISO currency code (default TRY) | TRY |
| category | No | Optional category slug | |
| image_url | No | Optional product image URL (hosted image) | |
| stock_status | No | in_stock | out_of_stock | preorder | in_stock |
| description | No | Optional long description | |
| org_id | No | Optional — override the org bound to the API key |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavioral traits but fails to mention idempotency, permissions, duplicate handling, or side effects. The single sentence is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single concise sentence with no redundancy. While it could be expanded with guidelines, it is appropriately short for a straightforward creation tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Although an output schema exists (reducing need for return value docs), the description lacks behavioral context, error hints, and prerequisites, leaving it incomplete for a tool with 9 parameters and many siblings.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All 9 parameters are fully described in the schema (100% coverage), so the description adds no new meaning. Baseline is 3; no extra value provided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Create') and the resource ('new product in your organization's catalog'), distinguishing it from sibling tools like 'list_org_products' or 'update_product_stock'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool vs alternatives, such as checking if the product already exists or updating stock. Usage context is entirely absent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_social_postA
Create and publish a social media post.
Post to Instagram, Facebook, TikTok, Twitter/X and other platforms. Supports text, images, and videos. Requires enterprise subscription.
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Post caption/text content | |
| platform | Yes | Target platform ("instagram", "facebook", "tiktok", "twitter") | |
| account_id | Yes | Social account ID (from list_social_accounts) | |
| media_urls | No | Optional list of image/video URLs to attach | |
| scheduled_at | No | Optional ISO 8601 datetime to schedule the post (e.g., "2026-05-01T10:00:00Z"). If None, posts immediately. | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries full burden. It discloses that the tool creates and publishes posts and supports media, but does not mention behavioral traits like idempotency, rate limits, or whether the post is immediately visible. This is adequate but could be more comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, consisting of two sentences that front-load the core purpose and key details. Every sentence adds value without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (6 parameters, multiple platforms), the description covers the essential aspects: purpose, platforms, media types, and subscription requirement. It relies on the output schema for return values, which is acceptable. Minor omission: no mention of scheduling or account linking, but those are in the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already explains parameters well. The description adds value by noting the enterprise requirement, but otherwise repeats information available in the schema (platforms, media support). Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: create and publish a social media post. It lists specific platforms (Instagram, Facebook, TikTok, Twitter/X) and supported content types (text, images, videos), distinguishing it from sibling tools like generate_caption or list_social_posts.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description mentions the enterprise subscription requirement but provides no explicit guidance on when to use this tool vs alternatives (e.g., generate_caption for caption generation). It implies usage for posting but lacks when-not-to-use or comparative context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
execute_templateA
Execute a ComfyUI template to generate content.
Runs a pre-built AI workflow with your inputs. Each template has different capabilities — use get_template_detail() first to see what inputs are accepted. Credits are deducted based on the template.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Template slug (e.g., "flux-logo-generator", "product-photo-enhancer") | |
| prompt | Yes | Main text prompt for the template | |
| image_url | No | Input image URL (required for image-based templates) | |
| width | No | Output width in pixels (64-2048) | |
| height | No | Output height in pixels (64-2048) | |
| extra_inputs | No | Additional template-specific inputs (see get_template_detail). e.g., {"brand_color": "#FF0000", "logo_text": "ACME Corp"} |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description adds context about credit deduction and prerequisite but omits key behaviors like synchronous vs. asynchronous execution, return value structure, or error handling, making it adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is relatively concise with three sentences, though the first line is somewhat redundant with the tool name. Information is front-loaded effectively.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema, the description provides basic context but lacks information about execution time, job status checks, or error scenarios, leaving gaps for a complex tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with clear descriptions, and the description adds value by noting that extra_inputs varies by template, but does not expand on other parameters beyond schema defaults.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool executes a ComfyUI template to generate content, distinguishing it from other generation tools by emphasizing pre-built workflows and referencing get_template_detail for input details.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description advises using get_template_detail first to understand template-specific inputs, providing clear context on when to use the tool but lacks explicit exclusions or comparisons to alternative tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
extract_customer_infoA
Extract contact information from conversation history using AI.
The AI reads through all messages with this customer and extracts their name, phone number, email address, and physical address. Great for auto-filling CRM records from chat conversations.
| Name | Required | Description | Default |
|---|---|---|---|
| customer_id | Yes | Customer ID to extract info for | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It mentions that the AI reads all messages to extract info, implying a read operation, but does not disclose potential costs, permissions, or side effects. Some transparency but incomplete.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded with the main purpose. It could be slightly tighter, but it is well-structured and easy to understand.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that an output schema exists (so return values are covered), and the description lists the extracted fields (name, phone, email, address), the description is complete enough for a tool that reads conversation history. It lacks mention of edge cases or behavior for missing info, but overall adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers both parameters with descriptions. The tool description adds no extra meaning beyond the schema. Baseline score of 3 is appropriate given 100% schema description coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action (extract) and the resource (contact information from conversation history). It distinguishes itself from sibling tools like list_customers or get_customer by focusing on extraction from conversation history.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a use case ('auto-filling CRM records from chat conversations') but does not explicitly state when not to use or mention alternatives among siblings. The usage is implied but not fully guided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_captionA
Generate an AI-powered social media caption.
Creates engaging, platform-optimized captions using AI. Supports multiple languages and tones.
| Name | Required | Description | Default |
|---|---|---|---|
| topic | Yes | What the post is about (e.g., "new summer collection launch") | |
| platform | No | Target platform ("instagram", "facebook", "tiktok", "twitter") | |
| language | No | Caption language ("tr" for Turkish, "en" for English) | tr |
| tone | No | Writing tone ("professional", "casual", "fun", "formal") | professional |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It mentions AI-powered generation, platform optimization, and language/tone support. However, it does not disclose limitations, required permissions, or potential quality variations. The org_id parameter and env var fallback are transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded, no wasted words. The first sentence captures the core action, and the second adds value by highlighting key features.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete enough given the full schema and presence of an output schema. However, it does not explicitly state what the tool returns (e.g., the generated caption text), though the output schema likely covers this. Minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description says 'supports multiple languages and tones' but this adds no new meaning beyond what the schema already provides for language and tone parameters. No extra parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Generate an AI-powered social media caption', which is specific and distinct from sibling tools like generate_hashtags or generate_text. It also mentions platform optimization, further clarifying its purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies it is for creating captions for social media posts but provides no explicit guidance on when to use this tool versus alternatives or when not to use it. No exclusions or prerequisites are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_hashtagsB
Generate AI-optimized hashtags for a social media post.
Creates relevant, trending hashtags based on your caption content.
| Name | Required | Description | Default |
|---|---|---|---|
| caption | Yes | The post caption to generate hashtags for | |
| platform | No | Target platform ("instagram", "facebook", "tiktok") | |
| language | No | Hashtag language ("tr" for Turkish, "en" for English) | tr |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full responsibility for behavioral disclosure. It mentions generating 'AI-optimized' and 'trending' hashtags, but omits any details about side effects, resource consumption (e.g., API credits), or authorization requirements. This is minimal transparency for a tool that likely consumes AI model quotas.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences front-load the primary purpose, with no wordiness or redundant information. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 4 parameters, an output schema, and sibling tools like 'generate_caption', the description is sufficiently complete but lacks details like the number of hashtags generated or platform-specific behavior. The output schema likely covers return values, so the description meets a minimum threshold but could hint at output structure.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, with detailed descriptions for each parameter. The tool's description adds 'based on your caption content,' which essentially restates the schema's caption parameter description. Given high schema coverage, the baseline is 3, and the description adds no extra meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: generating AI-optimized hashtags for a social media post. It uses a specific verb ('Generate') and resource ('hashtags'), and distinguishes it from siblings like 'generate_caption' or 'analyze_image'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives, such as when generating a caption or analyzing content. No when-to-use or when-not-to-use context is given, leaving the agent to infer usage solely from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_imageA
Generate an image using AI.
Supports 3 AI models: Flux, SDXL, Imagen 4. Smart routing automatically picks the best model for your prompt. Cost: ~6 credits per image.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the image to generate (Turkish or English) | |
| model | No | AI model to use — "auto" (smart routing), "flux" (best quality), "sdxl" (fast), "imagen4" (Google, photorealistic) | auto |
| negative_prompt | No | Things to avoid in the image | |
| width | No | Image width in pixels (64-2048, default 512) | |
| height | No | Image height in pixels (64-2048, default 512) | |
| style | No | Style preset (realistic, anime, cinematic, artistic) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description partially covers behavior: cost (~6 credits) and model routing. Missing details like output format (likely image URL), processing time, or error handling for invalid prompts.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Extremely concise: three short sentences cover purpose, models, routing, and cost. No redundancy, front-loaded with the core action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the existence of an output schema (handling return details), the description provides adequate context for invocation: required prompt, optional parameters explained in schema, and cost. Missing usage nuance but sufficient for a straightforward tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. Description adds value by explaining smart routing for model='auto' and stating the credit cost, which is absent from the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states 'Generate an image using AI' - a specific verb and resource. The description distinguishes from sibling tools like generate_text or generate_video by explicitly mentioning image generation and model options.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit when-to-use or when-not-to-use guidance. The mention of smart routing implies automated model selection but doesn't explain when to manually choose models or compare with alternatives like analyze_image or remove_background.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_mannequinA
Generate an AI mannequin / model photo for products.
Upload a product image (clothing, accessory) and the AI will generate a realistic mannequin/model wearing or displaying it. Great for e-commerce product listings. Cost: ~6 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the desired mannequin/model (e.g., "young woman, studio lighting", "male model, outdoor setting") | |
| image_url | Yes | URL of the product image |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided; description lacks behavioral details such as processing time, output format, or reversibility. Only mentions generation and cost.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, focused sentences with bolded first line, no fluff, every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool complexity (2 params), output schema present, and description includes cost, it is fairly complete but misses behavioral nuances like output type.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers both parameters with descriptions; description adds no extra semantic meaning beyond cost mention, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states the verb 'generate' and the resource 'mannequin/model photo', and distinguishes from siblings like 'generate_image' and 'virtual_try_on' by specifying it's for product images in e-commerce.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides clear usage context (upload product image, AI generates model) and mentions cost (~6 credits), but does not explicitly state when not to use or compare with alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_musicC
Generate music using AI (powered by Suno v4).
Create full songs with vocals or instrumental tracks from text descriptions. Supports Turkish and English lyrics. Cost: ~14 credits per track.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the music to generate (genre, mood, lyrics) | |
| style | No | Music genre (pop, rock, electronic, classical, lo-fi, ambient) | pop |
| instrumental | No | If True, generate without vocals |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description must disclose behavior. It mentions cost and AI model but lacks details on output handling, rate limits, or whether tracks are saved or returned. Incomplete for a generation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Concise, with four sentences covering purpose, features, and cost. No fluff, but could benefit from structured bullet points for readability.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists, description may omit return details, but it lacks context on generation duration, success/failure indicators, or how to retrieve the generated music. Adequate but not comprehensive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. Description adds context about Turkish and English lyrics (relevant to prompt) and cost, but no additional semantic details beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it generates music using AI, with options for vocals or instrumental, which distinguishes it from siblings like generate_music_video. However, it could be more specific about what 'full songs' entails.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives like generate_text or generate_image. It provides cost and language support but no direct comparison to siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_music_videoA
Generate a music video — AI music + video combined.
Creates both an original music track and a matching video in one go. The AI composes music and generates visuals that match the mood. Cost: ~364 credits (music + video).
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the music video (genre, mood, theme) | |
| style | No | Music genre (pop, rock, electronic, classical, lo-fi, ambient) | pop |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses cost and that music and video are generated together, but lacks details on rate limits, authentication needs, asynchronous behavior, or output format. With no annotations, more transparency expected.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, first sentence clear and direct. No redundancy, but slightly verbose in later sentences. Efficient overall.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Adequately covers key aspects: combined output, cost, parameter purposes. Could mention output format but output schema exists so not required. Reasonably complete for tool with two params.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and descriptions are clear. Description adds no new parameter information beyond schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states verb 'generate' and resource 'music video', and differentiates from siblings generate_music and generate_video by emphasizing combined creation. Distinction is explicit and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implies usage for combined music+video creation, mentions cost, but does not explicitly state when to use alternatives or when not to use. No exclusion criteria provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_textB
Generate text content using Gemini AI.
Create scripts, storyboards, song lyrics, marketing copy, and more. Powered by Google Gemini. Cost: ~2 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | What to generate (e.g., "Write a 30-second ad script for a coffee brand") | |
| sub_mode | No | Generation mode — "script" (video/ad scripts), "storyboard" (visual scene descriptions), or "lyrics" (song lyrics) | script |
| temperature | No | Creativity level (0.0 = focused, 1.0 = creative, default 0.7) | |
| max_tokens | No | Maximum output length (default 2048) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must convey behavioral traits. It mentions cost (~2 credits) but does not disclose whether the tool is read-only, destructive, or any side effects (e.g., token usage, rate limits). For a generative tool, this is a significant gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise at three sentences, front-loading the core purpose. Each sentence adds value: purpose, examples, cost. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (4 parameters, output schema exists), the description covers the basic purpose and examples but lacks usage context, error handling, or return value explanation. The output schema likely covers return values, so the description is minimally adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters adequately. The description adds no additional meaning beyond the schema; it mentions the sub_mode values implicitly through examples but does not elaborate on temperature or max_tokens.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a clear verb 'Generate' and specifies the resource 'text content using Gemini AI'. It lists example outputs (scripts, storyboards, lyrics, marketing copy), which helps differentiate from sibling tools like generate_caption (more focused) or generate_hashtags (narrower). However, it does not explicitly state that this is the general-purpose text generation tool, leaving some ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage by listing example outputs, but it does not state when to use this tool versus other text-generation siblings (e.g., generate_caption for captions, generate_hashtags for hashtags). No explicit when-not or alternative recommendations are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_videoA
Generate a video using AI.
Text-to-video or image-to-video. Models: Veo 3.1, Kling. Cost: ~350 credits per video.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the video to generate | |
| image_url | No | Optional source image URL (for image-to-video mode) | |
| model | No | Model to use — "auto" (default, picks best), "veo" (Veo 3.1), or "kling" (Kling). Veo 3.1 is best for cinematic quality. | auto |
| style | No | Style preset (cinematic, realistic, artistic) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It only discloses cost and model options but omits important behavioral traits like async vs sync, duration, storage, or failure modes. This is a significant gap for a generation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, zero wasted words. All information is front-loaded and essential.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has an output schema, so return values need not be explained. However, the description lacks key context like async behavior, duration limits, or storage details, which are important for video generation. It is adequate but not complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds context about the two modes and cost, but these are not parameter-specific enhancements beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Generate a video using AI' and differentiates 'Text-to-video or image-to-video', making the purpose exact. Among siblings like generate_image, generate_music, etc., it is distinctively positioned.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explains the two modes (text-to-video vs. image-to-video) and mentions cost. While it doesn't explicitly state when not to use or name alternatives, it provides sufficient context for basic usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_competitorB
Get detailed info for a single competitor.
| Name | Required | Description | Default |
|---|---|---|---|
| competitor_id | Yes | UUID from list_competitors results | |
| org_id | No | Optional — override the org bound to the API key |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not disclose behavioral traits such as side effects, permissions, or idempotency. For a read operation, information about caching or data freshness would be helpful.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence is concise and front-loaded. However, it could incorporate more detail without losing conciseness, such as mentioning the source of competitor_id.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema and only two parameters, the description is minimally adequate. Missing behavioral transparency and usage guidelines, but the core purpose is clear.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the description does not add significant meaning beyond what is already in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action 'Get detailed info' and the resource 'a single competitor'. It effectively distinguishes from sibling tools like 'list_competitors' and 'compare_competitors' by focusing on a single entity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance on when to use this tool versus alternatives. The schema implies using competitor_id from list_competitors, but the description lacks direct context or exclusion criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_customerA
Get detailed customer information.
Returns full customer profile including contact details, tags, notes, conversation history, and order info.
| Name | Required | Description | Default |
|---|---|---|---|
| customer_id | Yes | Customer ID (from list_customers results) | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description alone must convey behavior. It states it 'returns' data, implying a read operation, but does not explicitly confirm read-only, required permissions, or lack of side effects. For a retrieval tool this is adequate but not fully transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences, front-loaded with purpose, and no redundant information. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema, the description appropriately summarizes key return fields. Parameter documentation is complete via schema. No gaps for this straightforward retrieval tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description does not add additional meaning beyond what's already in the schema descriptions for 'customer_id' and 'org_id'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get', the resource 'detailed customer information', and lists specific return fields (contact details, tags, notes, conversation history, order info). It distinguishes from sibling 'list_customers' which returns a list, not a detailed profile.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for retrieving a single full customer profile but provides no explicit guidance on when to use vs alternatives like 'read_conversation' or 'list_customers', nor does it state when not to use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_job_statusA
Check the status of a generation job.
Use this to check on long-running jobs (especially video and music) or to retrieve the result URL of a completed job. No credits charged.
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | The job ID returned from a generate call |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description carries the full burden. It adds the 'no credits charged' behavioral detail but does not disclose other aspects like rate limits or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three concise sentences with no extraneous information, effectively front-loading the main purpose and key usage points.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the main function, usage context, and cost implications; presence of an output schema means return details are not needed here, making it complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 100% schema coverage, the parameter 'job_id' is already documented, but the description adds value by clarifying it's 'returned from a generate call', providing context beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool checks the status of a generation job, specifies it for long-running jobs (video/music) and retrieving result URLs, which distinguishes it from sibling generation tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use (for long-running jobs, to get result URL) and notes no credits charged, but does not cover when not to use or provide alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_social_quotaA
Get social media quota and usage limits.
Returns remaining post quota, message limits, and billing period info. Useful to check before running bulk operations.
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Implicitly a read-only operation ('Get'), no side effects mentioned. Lacks explicit statement of no destructive action, but adequate given simplicity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences, front-loaded with main action. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Complete for a simple quota check: explains return values, usage context, and benefits from output schema. No gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with parameter description already. Description adds no extra parameter detail, but not necessary due to high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states it gets social media quota and usage limits, specifying remaining post quota, message limits, and billing period info. Distinct from siblings like check_balance.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly suggests using before bulk operations, which is helpful context. However, does not mention when not to use or provide alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_template_detailA
Get full details of a template including its input parameters.
Returns the template's input fields (what you need to provide), output format, description, and credit cost. Use this before executing a template to understand its requirements. No credits charged.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | Template slug (from list_templates results) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully discloses behavior: it returns input fields, output format, description, and credit cost, and states 'No credits charged'. It is clearly a read-only operation, though it doesn't explicitly state idempotency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is four sentences, each contributing value: purpose, return contents, usage guidance, and cost note. It is front-loaded and concise with no redundant words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema (not needing return structure detail), the description is complete: it explains what is returned, when to use it, and the cost implication. It differentiates well from related tools like list_templates and execute_template.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers the single parameter 'slug' with a description ('Template slug from list_templates results'), achieving 100% coverage. The description adds no new information about the parameter beyond what the schema already provides, so score is baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool gets full details of a template, including input parameters, output format, description, and credit cost. It distinguishes itself from siblings like 'execute_template' (which runs the template) and 'list_templates' (which lists all templates) by focusing on detailed retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly advises 'Use this before executing a template to understand its requirements', providing clear when-to-use guidance. It does not explicitly state when not to use it, but the context implies it is not for execution.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
lip_syncA
Create a talking avatar from a photo using AI lip sync.
Upload a face photo and provide the text/speech description. The AI will animate the face to appear as if it's speaking. Great for presentations, social media, and content creation. Cost: ~14 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | The speech or dialogue for the avatar (e.g., "Hello! Welcome to our channel.") | |
| image_url | Yes | URL of the face photo to animate |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It only states that the AI animates the face to appear as if speaking and mentions a cost of ~14 credits. It lacks details on processing time, output format, photo requirements, or whether the tool is read-only (it is generative, so not read-only). This minimal disclosure is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very concise: three sentences plus a cost note. It front-loads the main purpose and adds relevant context without unnecessary repetition or fluff. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema, the description does not need to explain return values. It covers the core purpose and usage, but lacks behavioral details (e.g., limitations, processing time) and does not mention prerequisites. Overall it is adequate but has noticeable gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, with each parameter already explained concisely (prompt: speech/dialogue, image_url: URL of face photo). The description does not add any additional parameter semantics beyond what the schema provides, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates a talking avatar from a photo using AI lip sync. It specifies the verb 'create', the resource 'talking avatar', and the method 'AI lip sync', distinguishing it from other media tools like generate_video or swap_face.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description mentions it's great for presentations, social media, and content creation, implying appropriate use cases. However, it does not provide explicit guidance on when not to use this tool or suggest alternatives among the many sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_chatbotsA
List all available chatbots on YaparAI.
Returns active chatbots with their slug, name, description, and configuration. Use the slug to chat with a specific bot. No credits charged.
Returns: List of chatbot configs with slug, name, description, avatar_url.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It mentions a positive behavioral trait (no credits charged) and reports active chatbots, but lacks details on authentication, rate limits, or pagination. Adequate for a simple list.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with no fluff. The first sentence states the purpose, the second details the return structure, and the third provides a usage note. Very efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given zero parameters and an output schema, the description covers the essential: what the tool does, what it returns, how to use the result (slug), and that it is free. No major gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has zero parameters, so baseline is 4. Description adds value by listing the return fields (slug, name, description, avatar_url), which helps the agent understand the output even though an output schema exists.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool lists all available chatbots on YaparAI, and specifies the returned fields (slug, name, description, configuration). It also differentiates from the sibling tool 'chat_with_bot' by noting to use the slug for chatting.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description provides a usage hint ('Use the slug to chat with a specific bot') and notes 'No credits charged', but does not explicitly state when not to use or list alternatives. The usage is implied by the tool's purpose.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_competitorsA
List competitors tracked under your organization.
Competitor tracking includes website crawling (PageSpeed, SEO), social media metrics (followers, engagement), and marketplace product prices (Hepsiburada, Trendyol).
Requires enterprise subscription with an org-bound API key.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max results (default 50) | |
| offset | No | Pagination offset | |
| org_id | No | Optional — override the org bound to the API key |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so description carries full burden. It states the tool lists competitors (read operation) but does not explicitly confirm non-destructive behavior, rate limits, data freshness, or any side effects. This is insufficient for a standalone disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each adding value: purpose, scope of tracking, and prerequisites. No fluff, front-loaded with main action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given output schema exists, return format is covered. Description covers purpose, scope, and requirements. Could briefly mention pagination behavior (e.g., ordering) but otherwise complete for a listing tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% description coverage, so baseline is 3. The description adds no additional meaning beyond the schema; it only implicitly mentions org_id override. No extra context for limit/offset.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states 'List competitors tracked under your organization' with specific verb and resource. It distinguishes from siblings like 'get_competitor' and 'compare_competitors' by detailing what competitor tracking includes (crawling, social, marketplace).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description mentions prerequisites ('enterprise subscription with org-bound API key') but does not explicitly guide when to use this tool versus alternatives like get_competitor or compare_competitors. Usage is implied but not contrasted.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_customersA
List CRM customers with optional filtering.
Browse your customer database built from social media conversations. Supports search, platform filtering, and tag-based filtering. Requires enterprise subscription. No credits charged.
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Search by customer name, email, or phone | |
| platform | No | Filter by platform ("instagram", "facebook", "whatsapp") | |
| tag | No | Filter by customer tag (e.g., "vip", "lead", "returning") | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses data source (social media conversations), filtering capabilities, subscription constraint, and cost. No annotations provided, so the description fully addresses behavioral traits; no contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with no redundancy: first states purpose, second adds context, third gives usage notes. Front-loaded and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 4 parameters and no annotations, the description covers purpose, filtering, and subscription. Missing details like pagination or limit, but overall sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with parameter descriptions. The description adds context about the customer database source and subscription, supplementing the schema. However, org_id is not mentioned in the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it lists CRM customers with optional filtering, distinguishing it from siblings like get_customer (single customer) and sync_customers_from_inbox (import).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains when to use (browse customer database) and mentions enterprise subscription requirement and zero credit cost, but does not explicitly state when not to use or name alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_inboxA
List social media inbox conversations (DMs, comments).
Shows all incoming messages from Instagram, Facebook, WhatsApp, etc. Requires enterprise subscription. No credits charged.
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
For a read-only list operation with no annotations, the description discloses the enterprise requirement and credit policy, but omits details like pagination, rate limits, or behavior when org_id is omitted (schema already handles that).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the main action, then additional requirements. No fluff or redundant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's low complexity (1 optional param, no required params, and an existing output schema), the description covers purpose, sources, prerequisites, and cost. Minor gap: does not mention the output schema or data format.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for the single parameter org_id, and the schema already describes its optionality and env var fallback. The description adds no additional parameter information beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'List' and the resource 'social media inbox conversations (DMs, comments)', and specifies the platforms (Instagram, Facebook, WhatsApp), distinguishing it from sibling tools like list_social_posts or list_customers.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides context by noting the requirement for an enterprise subscription and that no credits are charged. This informs the agent about prerequisites and cost, but lacks explicit when-not-to-use or alternative tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_modelsA
List all available AI generation models and their credit costs.
Returns a list of models with their mode identifier, description, credit cost, and type (image/video/music).
Useful for understanding what you can generate and how much it costs. No credits are charged for this operation.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly states 'No credits are charged for this operation,' which is a key behavioral trait. It also describes the return structure. No annotations are provided, but the description covers important behavioral aspects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is four sentences, each serving a distinct purpose: stating the action, detailing the return information, noting utility, and clarifying no cost. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has an output schema and no parameters, the description is complete. It explains the purpose, return fields, utility, and cost-free nature.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has zero parameters, so the description does not need to add parameter semantics. The baseline for 0 parameters is 4 per calibration.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it lists all available AI generation models with their credit costs and details (mode identifier, description, credit cost, type). This action is distinct from sibling tools like generate_image or generate_video, which actually generate content.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description indicates the tool is useful for understanding what can be generated and costs, implying it should be used before generation. It lacks explicit when-not-to-use or alternatives, but the context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_organizationsA
List your organizations on YaparAI.
Returns organizations you're a member of, with their IDs, names, and your role. Use the org ID for enterprise tools (social media, CRM, chatbots). You can set YAPARAI_ORG_ID env var to skip passing org_id to every call. No credits charged.
Returns: List of organizations with id, name, role, and member count.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries the burden. It states 'No credits charged' and implies read-only by returning membership data. However, it does not discuss idempotency, rate limits, or potential side effects, which is acceptable for a simple list operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is concise with 6 sentences, all providing value. 'Returns:' block structures the output clearly. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter list tool, the description covers purpose, output schema, cost (no credits), and practical usage tip. No obvious gaps given the simplicity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has no parameters (100% coverage by schema), so description adds value by detailing the return fields (id, name, role, member count). This goes beyond the schema, which only provides property types.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'List your organizations on YaparAI' with specific verb and resource, and explains the returned data (IDs, names, role). It distinguishes from sibling list tools by focusing on organizations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides practical guidance: use the org ID for enterprise tools and set YAPARAI_ORG_ID env var to skip passing org_id. Does not explicitly mention when to use this tool vs alternatives, but the context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_org_productsA
List product catalog for your organization.
Returns org's product list with SKU, price, category, image, stock status (in_stock / out_of_stock / preorder). Used for automated social media posts, chatbot product lookup, or inventory management from AI assistants.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max results (default 50) | |
| offset | No | Pagination offset | |
| org_id | No | Optional — override the org bound to the API key |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must disclose behavior. It implies a read operation and lists return fields, but lacks details on authorization, rate limits, or empty results. Adequate but not comprehensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences plus a bullet list, front-loaded with purpose and return fields. No extraneous information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple listing tool with output schema (implied), the description covers purpose, return fields, and use cases. Lacks error handling details but is sufficient for typical usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with clear parameter descriptions (limit with default, offset, org_id). Description adds no extra parameter info; baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'List product catalog for your organization' and specifies return fields (SKU, price, etc.) and use cases. It distinguishes from sibling tools like create_org_product and update_product_stock.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit use cases (social media posts, chatbot lookup, inventory management) but does not mention when not to use or alternatives. However, the context is clear for an AI agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_social_accountsA
List connected social media accounts (Instagram, Facebook, TikTok, etc.).
Shows all social accounts linked to your organization. Requires enterprise subscription. No credits charged.
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It discloses read-only nature (listing), enterprise requirement, and no credit cost. Lacks details on pagination or error handling but acceptable for a simple list operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences only: purpose, scope, and requirement. Front-loaded and no unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple list tool with one parameter and an output schema, the description covers essential context: what it lists, organizational scope, subscription requirement, and cost. No gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema covers 100% of the single parameter (org_id) with a clear description. The description adds no new information beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool lists connected social media accounts, with examples (Instagram, Facebook, TikTok). It is distinct from sibling tools like create_social_post or list_social_posts, which deal with posts rather than accounts.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description mentions enterprise subscription requirement and that no credits are charged, giving clear usage context. It does not explicitly list alternatives but the purpose is self-contained.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_social_postsA
List published and scheduled social media posts.
Returns all posts for the organization, with optional filtering by platform or specific account. Requires enterprise subscription.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | No | Filter by platform ("instagram", "facebook", "tiktok", "twitter") | |
| account_id | No | Filter by specific social account ID | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavioral traits. It states the operation is read-only (listing) and mentions filtering, but lacks details on pagination, rate limits, ordering, or what 'all posts' means in terms of scope (e.g., time range, pagination).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, each adding value: first defines purpose, second adds scope and constraints. No redundant words. Information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers purpose, filtering options, and subscription requirement. Since an output schema exists (not shown), return values are likely documented. Missing details like pagination or draft handling are minor for a list tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so parameters are well-documented in the schema. The description repeats the filtering capability but adds value by mentioning the enterprise subscription prerequisite, which is not in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'list' and resource 'published and scheduled social media posts'. It distinguishes from sibling tools like 'create_social_post' and 'get_social_quota' by focusing on listing existing posts.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context: it lists posts for the organization with optional filtering, and notes the enterprise subscription requirement. It does not explicitly state when not to use it or name alternatives, but the purpose is unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_templatesA
Browse 448+ ready-made AI templates.
Discover pre-built workflows for common tasks: logo creation, product photography, portrait retouching, ad generation, and more. Each template has predefined inputs — just fill in prompts and images. No credits charged for browsing.
| Name | Required | Description | Default |
|---|---|---|---|
| category | No | Filter by category slug (e.g., "logo", "product", "portrait") | |
| media_type | No | Filter by output type ("image", "video") | |
| search | No | Search templates by name/description | |
| featured | No | Show only featured templates |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description carries the burden. It discloses that no credits are charged for browsing, indicating a safe read operation. However, it does not detail pagination, sorting, or any other behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three focused sentences: count, use cases, and key behavioral note (free). No wasted words, front-loaded with purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description adequately covers the tool's purpose and a key behavioral aspect. It could mention that the result is a list of templates, but overall it is complete for a browsing tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline 3. The description does not add significant meaning beyond the schema's parameter descriptions. It mentions 'predefined inputs' but this refers to templates, not parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it is for browsing AI templates, with specific examples of use cases like logo creation and product photography. It distinguishes itself from siblings like execute_template and get_template_detail by focusing on discovery.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use this tool (for discovering templates) and notes that browsing is free. It does not explicitly mention alternatives, but the context of sibling tools makes it clear when this is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
read_conversationA
Read messages in a social media conversation.
Get the full message history of a DM or comment thread.
| Name | Required | Description | Default |
|---|---|---|---|
| conversation_id | Yes | Conversation ID (from list_inbox results) | |
| account_id | Yes | Social account ID that received the messages | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must convey behavioral traits. It only states the tool reads messages, but does not disclose any side effects, authentication needs, rate limits, or error conditions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two succinct sentences that clearly communicate the tool's purpose without any superfluous words. Each sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is low in complexity and has a high schema coverage and an output schema. The description covers the basics but lacks behavioral details; however, it is adequate for a simple read operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond what the schema already provides for the parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'read' and resource 'messages in a social media conversation', and specifies 'full message history' for DM or comment threads. This distinguishes it from siblings like list_inbox (list) and reply_to_message (write).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit guidance on when to use this tool vs alternatives like list_inbox or reply_to_message. The parameter description hints that conversation_id comes from list_inbox, but the description itself lacks such context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
remove_backgroundA
Remove the background from an image using AI.
Upload an image and get back a version with the background removed. Works great for product photos, portraits, and any image where you need a clean cutout. Cost: ~2 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| image_url | Yes | URL of the image to process | |
| output_format | No | Background replacement — "transparent" (PNG with alpha) or "white" (white background) | transparent |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It mentions cost (~2 credits) and outcome, but does not disclose error conditions, size limits, or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is concise with 4 lines, front-loads the core purpose, and includes relevant use cases and cost without extraneous text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Has output schema. Covers purpose, use cases, and cost adequately for a simple tool, though missing details on image format/max size.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline 3. Description adds no extra parameter meaning beyond what the schema already describes (format options).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Remove the background from an image using AI' with specific examples like product photos and portraits, clearly differentiating it from sibling tools such as swap_face or transform_image.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for cutouts ('Works great for product photos, portraits...') but lacks explicit guidance on when not to use or comparisons to alternatives among many image-related siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reply_to_messageA
Reply to a social media message/DM.
Send a reply in an existing conversation on Instagram, Facebook, WhatsApp, or other connected platforms.
| Name | Required | Description | Default |
|---|---|---|---|
| conversation_id | Yes | Conversation ID to reply in | |
| account_id | Yes | Social account ID to reply from | |
| message | Yes | Reply text | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description carries full burden. It mentions 'reply' which implies mutation, but lacks details on side effects, authentication requirements, rate limits, or whether the reply is sent immediately. The description is minimal on behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences are front-loaded with the main action and then provide platform context. Every word earns its place; no redundancy or fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists (not shown), the description adequately covers the tool's core purpose and parameters. It lacks usage guidelines but is otherwise complete for a simple reply tool. A higher score would require explicit guidance on alternatives.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% description coverage, so each parameter is already documented. The tool description adds platform context but not parameter-specific meaning beyond the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool replies to social media messages/DMs in existing conversations, specifying platforms like Instagram, Facebook, WhatsApp. This is a specific verb+resource, and it distinguishes from sibling tools like create_social_post or bulk_message.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for replying in existing conversations, but does not explicitly state when not to use it or suggest alternatives. For instance, it doesn't mention that starting a new conversation might require a different tool, leaving some ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
send_shipping_infoA
Send shipping/tracking information to a customer via social media.
Automatically sends a tracking message through the same social platform the customer contacted you on.
| Name | Required | Description | Default |
|---|---|---|---|
| customer_id | Yes | Customer ID to notify | |
| carrier | Yes | Shipping carrier (e.g., "Yurtici", "Aras", "PTT", "MNG", "DHL") | |
| tracking_code | Yes | Package tracking number | |
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It discloses automatic platform selection, but omits details like permissions, potential failures, or prerequisites.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences, front-loaded with main action, no redundant words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given output schema exists and schema coverage is high, the description is nearly complete. Minor gap: doesn't specify if customer must have an existing conversation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds minimal context beyond the schema (e.g., platform selection), not enough to raise the score.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool sends shipping/tracking information via social media and automatically selects the platform based on customer contact, which is a specific verb+resource and distinguishes it from generic messaging siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use (when you have shipping tracking to send) but lacks explicit when-not-to-use or alternatives, though context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
swap_faceA
Swap a face in an image using AI.
Provide a target image and a source face image. The AI replaces the face in the target image with the face from the source image while keeping the rest of the image intact. Cost: ~6 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| image_url | Yes | Target image URL (the image where the face will be replaced) | |
| face_url | Yes | Source face image URL (the face to use for swapping) | |
| prompt | No | Optional additional instructions for the face swap |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden but only mentions the cost (~6 credits) and the fact that the rest of the image stays intact. It does not disclose potential failure modes, image format requirements, or whether the operation is safe (non-destructive). Annotations would help, but the description provides minimal behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise (four sentences) and front-loaded with the core purpose. Every sentence contributes value: operation summary, required inputs, behavior promise, and cost. No redundant or filler content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description adequately explains the tool's operation and mentions cost, but omits details like expected output format (though an output schema exists), image size limits, or prerequisite access. It is sufficient for basic use but could be more complete for edge cases.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so each parameter already has a clear description. The tool description adds no extra information about parameters beyond the schema (only a cost note). Hence, it meets the baseline but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool swaps a face in an image using AI, specifying the target and source images. It distinguishes itself from siblings like 'remove_background' and 'virtual_try_on' by focusing on face replacement, making the purpose unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains the tool's function but does not provide explicit guidance on when to use it versus alternatives such as 'virtual_try_on' or 'transform_image'. It implies usage for face swapping but lacks exclusions or context for choosing other tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sync_customers_from_inboxA
Import customers from social media inbox conversations.
Scans all inbox conversations and creates CRM customer records for anyone who has messaged you. New customers are auto-tagged by platform. Existing customers are not duplicated.
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Organization ID (uses YAPARAI_ORG_ID env var if not provided) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so description carries full burden. It discloses that the tool scans all inbox conversations, creates new records, auto-tags by platform, and does not duplicate existing customers. However, it does not mention if the operation is destructive or if it requires permissions, which would further clarify behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is four sentences with clear structure: purpose, process, auto-tagging, deduplication. Each sentence adds value, though could be slightly more concise. Front-loaded with core purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a sync tool with output schema, description covers main aspects: scanning scope, record creation, deduplication, platform tagging. Missing details on idempotency or limits, but overall sufficient for the use case.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has one optional parameter (org_id) with full description coverage. The tool description does not add additional parameter information, but the schema already explains its meaning and fallback. Baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool imports customers from social media inbox conversations, creating CRM records. It is specific with verb 'import' and resource 'customers from inbox', and distinguishes from sibling tools like list_customers (viewing) and get_customer (single record).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for importing new customers from inbox conversations, but does not explicitly state when not to use it or mention alternatives like list_customers for viewing existing ones. No exclusions or prerequisites are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
transform_imageA
Transform an existing image using AI (image-to-image).
Uses the source image as a reference and applies the prompt to create a new variation. Great for style transfer, modifications, and enhancements. Cost: ~6 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the desired transformation | |
| image_url | Yes | URL of the source image to transform | |
| negative_prompt | No | Things to avoid in the output | |
| width | No | Output width in pixels (64-2048, default 512) | |
| height | No | Output height in pixels (64-2048, default 512) | |
| style | No | Style preset (realistic, anime, cinematic, artistic) |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description bears full burden for behavioral disclosure. It states the tool uses the source image as reference and applies a prompt, and notes cost. It lacks explicit statements about side effects (e.g., whether the source is modified) or output behavior, though output schema exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, each serving a purpose: defining the action, explaining the process with examples, and noting cost. No unnecessary words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the main use case and cost, and the output schema exists for return values. With 6 parameters (2 required), it provides sufficient context for an agent to understand when and how to use the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds context like 'style transfer' which relates to the style parameter, but does not provide additional semantic details beyond what the input schema already describes.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Transform an existing image using AI (image-to-image)', using a specific verb and resource. It mentions style transfer, modifications, and enhancements, distinguishing it from sibling tools like generate_image (creates from scratch) and remove_background (specific removal).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides context for use ('Great for style transfer, modifications, and enhancements'), implying appropriate scenarios. However, it does not explicitly exclude inappropriate uses or compare with siblings like generate_image or swap_face, which could be alternatives for certain tasks.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_product_stockA
Update a product's stock status.
Use this to quickly mark products as out of stock when inventory runs out, or to flip back to in_stock after restocking. For variant-level stock counts, see v0.6.0 roadmap.
| Name | Required | Description | Default |
|---|---|---|---|
| product_id | Yes | UUID from list_org_products results | |
| stock_status | Yes | in_stock | out_of_stock | preorder | |
| org_id | No | Optional — override the org bound to the API key |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It says 'update' implying mutation, but doesn't disclose permissions, side effects, or whether changes are immediately visible. Lack of behavioral details reduces transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, no redundant information. Purpose is upfront, usage guidance and roadmap reference are concise. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple update tool with output schema, description covers basic usage. However, lacks behavioral transparency (e.g., reversibility, side effects) and doesn't elaborate on org_id usage, making it adequate but not fully complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema covers 100% of parameters, providing baseline. Description adds context for product_id ('UUID from list_org_products results') and stock_status enum values. However, org_id is not mentioned beyond schema, so some extra value but not complete.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool updates a product's stock status with specific verbs and resources. It distinguishes from siblings like create_org_product by focusing on stock updates, not product creation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly guides when to use: 'mark products as out of stock when inventory runs out, or flip back to in_stock after restocking.' Mentions roadmap for variant-level counts, providing context, but doesn't compare to other tools on the server.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
virtual_try_onA
Virtual clothing try-on using AI.
Upload a photo of a person and describe the clothing to try on. The AI will generate a realistic image of the person wearing the described outfit. Perfect for e-commerce and fashion. Cost: ~6 credits.
| Name | Required | Description | Default |
|---|---|---|---|
| prompt | Yes | Description of the clothing to try on (e.g., "red summer dress", "blue denim jacket") | |
| image_url | Yes | URL of the person's photo |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It mentions cost (~6 credits) and states the output is a 'realistic image', but does not disclose behavioral traits like request limits, input constraints, or potential failure modes. Given the lack of annotations, the description should provide more operational context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very concise: 4 short sentences, each adding value. It front-loads the purpose and quickly explains the process. No unnecessary words or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's moderate complexity (AI image generation), the description covers the main inputs and output (realistic image). It mentions cost but lacks details on image resolution, style constraints, error handling, or result format. The presence of an output schema partially compensates, but overall completeness is adequate not excellent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema has 100% description coverage, so baseline is 3. The description largely restates the schema (e.g., 'upload a photo' for image_url, 'describe the clothing' for prompt) without adding new meaning or constraints beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: virtual clothing try-on using AI. It specifies the action (upload photo, describe clothing, generate image) and explicitly distinguishes from siblings like 'generate_image' or 'swap_face' by focusing on clothing try-on.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a use case ('Perfect for e-commerce and fashion'), but lacks explicit when-not-to-use or alternatives. For a server with many image-generation siblings, more guidance on when to choose virtual_try_on over, say, 'generate_image' or 'swap_face' would be beneficial.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
43 tool updates
v0.5.1- First observed
ai_reply_suggestion - First observed
analyze_image - First observed
bulk_message - First observed
chat_with_bot - First observed
check_balance - First observed
compare_competitors - First observed
create_org_product - First observed
create_social_post - First observed
execute_template - First observed
extract_customer_info - First observed
generate_caption - First observed
generate_hashtags - First observed
generate_image - First observed
generate_mannequin - First observed
generate_music - First observed
generate_music_video - First observed
generate_text - First observed
generate_video - First observed
get_competitor - First observed
get_customer - First observed
get_job_status - First observed
get_social_quota - First observed
get_template_detail - First observed
lip_sync - First observed
list_chatbots - First observed
list_competitors - First observed
list_customers - First observed
list_inbox - First observed
list_models - First observed
list_org_products - First observed
list_organizations - First observed
list_social_accounts - First observed
list_social_posts - First observed
list_templates - First observed
read_conversation - First observed
remove_background - First observed
reply_to_message - First observed
send_shipping_info - First observed
swap_face - First observed
sync_customers_from_inbox - First observed
transform_image - First observed
update_product_stock - First observed
virtual_try_on
TDQS
Scored across 43 tools
Each tool targets a specific functionality with clear descriptions that distinguish overlapping areas (e.g., generate_caption vs generate_text, ai_reply_suggestion vs chat_with_bot). No two tools serve the same purpose, making selection unambiguous.
The vast majority of tools follow a consistent verb_noun pattern (e.g., generate_image, list_customers, remove_background). Only a few minor exceptions (ai_reply_suggestion, lip_sync, virtual_try_on) exist, but they are still intuitive and do not break the overall consistency.
With 43 tools covering a wide range of features (content generation, social media, CRM, products, competitors, templates), the count is large but justifiable for a comprehensive platform server. It is slightly heavy but not excessive for the scope.
Core workflows for content generation and social media interaction are well-covered, but there are notable gaps in CRUD operations for entities like social posts, customers, products, and competitors (no update/delete tools). This limits the ability to fully manage resources via tools alone.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
Multi-model AI image and video generator. 14 models behind one OAuth-secured MCP endpoint.
AI image, video, voice and music generation over MCP, routed to Veo 3.1, Seedance 2.0 and more.
Generate and manage AI UGC video ads through eleven typed MCP tools
Brand-safe MCP for AI agents to create editable, on-brand graphics and automate variants.
Related MCP Servers
- AlicenseBqualityDmaintenanceFull-stack AI marketing toolkit with 41 MCP tools: SEO article generation in 55 languages, trend scouting (X/Reddit), competitor analysis, content gap detection, social media adaptations for 9 platforms, AI avatar video shorts, content ingestion (YouTube/PDF/web), lead magnets, and automated content autopilot.119MIT
- AlicenseNot gradedqualityAmaintenance52-tool MCP server for AI-powered social media management. Create content with 35+ AI models, distribute to multiple platforms, track analytics, and optimize with closed-loop learning.5404MIT
- AlicenseNot gradedqualityBmaintenanceMCP server for AI-assisted WordPress editing across 12 page builders. 172 tools for content management, page builder editing, WooCommerce, SEO analysis, accessibility scanning, and site intelligence. Edits native builder formats (Elementor, Bricks, Divi, Gutenberg, Beaver Builder, and 7 more) with duplicate-before-edit safety, optimistic locking, and surgical element-level operations7MIT
- FlicenseNot gradedqualityBmaintenanceEnables to plan, write, illustrate, and voice a full marketing campaign through an MCP pipeline that generates copy, moodboards, voiceovers, and images with automated guardrails and budget controls.-