From b5fcb573fd54c4d98360510201acc1c83562f4ff Mon Sep 17 00:00:00 2001 From: waleed Date: Fri, 30 Jan 2026 18:51:13 -0800 Subject: [PATCH] update docs --- apps/docs/content/docs/en/tools/ahrefs.mdx | 50 +-- apps/docs/content/docs/en/tools/airtable.mdx | 26 +- apps/docs/content/docs/en/tools/apify.mdx | 24 +- apps/docs/content/docs/en/tools/apollo.mdx | 78 ++-- apps/docs/content/docs/en/tools/asana.mdx | 16 +- apps/docs/content/docs/en/tools/calcom.mdx | 2 +- apps/docs/content/docs/en/tools/calendly.mdx | 42 +-- apps/docs/content/docs/en/tools/clerk.mdx | 36 +- .../docs/content/docs/en/tools/confluence.mdx | 4 +- apps/docs/content/docs/en/tools/datadog.mdx | 58 +-- apps/docs/content/docs/en/tools/discord.mdx | 148 ++++---- apps/docs/content/docs/en/tools/dropbox.mdx | 2 +- apps/docs/content/docs/en/tools/dynamodb.mdx | 54 +-- .../content/docs/en/tools/elasticsearch.mdx | 43 ++- .../docs/content/docs/en/tools/elevenlabs.mdx | 8 +- apps/docs/content/docs/en/tools/exa.mdx | 16 +- apps/docs/content/docs/en/tools/firecrawl.mdx | 18 +- apps/docs/content/docs/en/tools/fireflies.mdx | 20 +- apps/docs/content/docs/en/tools/gmail.mdx | 10 +- .../content/docs/en/tools/google_calendar.mdx | 30 +- .../content/docs/en/tools/google_docs.mdx | 4 +- .../content/docs/en/tools/google_drive.mdx | 6 +- .../content/docs/en/tools/google_forms.mdx | 22 +- .../content/docs/en/tools/google_groups.mdx | 58 +-- .../content/docs/en/tools/google_sheets.mdx | 12 +- .../content/docs/en/tools/google_slides.mdx | 28 +- .../content/docs/en/tools/google_vault.mdx | 36 +- apps/docs/content/docs/en/tools/grafana.mdx | 76 ++-- apps/docs/content/docs/en/tools/grain.mdx | 28 +- apps/docs/content/docs/en/tools/greptile.mdx | 16 +- apps/docs/content/docs/en/tools/hubspot.mdx | 68 ++-- .../content/docs/en/tools/huggingface.mdx | 2 +- apps/docs/content/docs/en/tools/hunter.mdx | 30 +- .../docs/content/docs/en/tools/incidentio.mdx | 126 +++---- apps/docs/content/docs/en/tools/jina.mdx | 4 +- apps/docs/content/docs/en/tools/jira.mdx | 12 +- .../docs/en/tools/jira_service_management.mdx | 70 ++-- apps/docs/content/docs/en/tools/kalshi.mdx | 102 +++--- apps/docs/content/docs/en/tools/lemlist.mdx | 20 +- apps/docs/content/docs/en/tools/linear.mdx | 8 +- apps/docs/content/docs/en/tools/linkup.mdx | 6 +- apps/docs/content/docs/en/tools/mailchimp.mdx | 346 +++++++++--------- apps/docs/content/docs/en/tools/mailgun.mdx | 28 +- apps/docs/content/docs/en/tools/mem0.mdx | 20 +- .../content/docs/en/tools/microsoft_excel.mdx | 8 +- .../docs/en/tools/microsoft_planner.mdx | 42 +-- .../content/docs/en/tools/microsoft_teams.mdx | 78 ++-- apps/docs/content/docs/en/tools/mongodb.mdx | 12 +- apps/docs/content/docs/en/tools/mysql.mdx | 22 +- apps/docs/content/docs/en/tools/neo4j.mdx | 36 +- apps/docs/content/docs/en/tools/notion.mdx | 14 +- apps/docs/content/docs/en/tools/onedrive.mdx | 20 +- apps/docs/content/docs/en/tools/outlook.mdx | 6 +- .../docs/content/docs/en/tools/perplexity.mdx | 10 +- apps/docs/content/docs/en/tools/pinecone.mdx | 28 +- apps/docs/content/docs/en/tools/pipedrive.mdx | 142 +++---- .../docs/content/docs/en/tools/polymarket.mdx | 80 ++-- apps/docs/content/docs/en/tools/posthog.mdx | 154 ++++---- apps/docs/content/docs/en/tools/qdrant.mdx | 26 +- apps/docs/content/docs/en/tools/rds.mdx | 28 +- apps/docs/content/docs/en/tools/reddit.mdx | 46 +-- apps/docs/content/docs/en/tools/resend.mdx | 10 +- apps/docs/content/docs/en/tools/s3.mdx | 22 +- .../docs/content/docs/en/tools/salesforce.mdx | 184 +++++----- apps/docs/content/docs/en/tools/sendgrid.mdx | 2 +- apps/docs/content/docs/en/tools/sentry.mdx | 48 +-- apps/docs/content/docs/en/tools/serper.mdx | 10 +- .../docs/content/docs/en/tools/servicenow.mdx | 20 +- .../docs/content/docs/en/tools/sharepoint.mdx | 24 +- .../docs/content/docs/en/tools/similarweb.mdx | 46 +-- apps/docs/content/docs/en/tools/slack.mdx | 10 +- apps/docs/content/docs/en/tools/sqs.mdx | 8 +- apps/docs/content/docs/en/tools/stt.mdx | 11 +- apps/docs/content/docs/en/tools/tavily.mdx | 16 +- apps/docs/content/docs/en/tools/telegram.mdx | 16 +- apps/docs/content/docs/en/tools/tinybird.mdx | 9 +- apps/docs/content/docs/en/tools/trello.mdx | 22 +- apps/docs/content/docs/en/tools/tts.mdx | 48 +-- .../docs/content/docs/en/tools/twilio_sms.mdx | 4 +- .../content/docs/en/tools/twilio_voice.mdx | 16 +- apps/docs/content/docs/en/tools/typeform.mdx | 32 +- apps/docs/content/docs/en/tools/wealthbox.mdx | 10 +- apps/docs/content/docs/en/tools/webflow.mdx | 30 +- apps/docs/content/docs/en/tools/whatsapp.mdx | 6 +- apps/docs/content/docs/en/tools/wordpress.mdx | 56 +-- apps/docs/content/docs/en/tools/x.mdx | 12 +- apps/docs/content/docs/en/tools/youtube.mdx | 42 +-- apps/docs/content/docs/en/tools/zendesk.mdx | 186 +++++----- apps/docs/content/docs/en/tools/zep.mdx | 30 +- apps/docs/content/docs/en/tools/zoom.mdx | 38 +- 90 files changed, 1774 insertions(+), 1759 deletions(-) diff --git a/apps/docs/content/docs/en/tools/ahrefs.mdx b/apps/docs/content/docs/en/tools/ahrefs.mdx index fd8a1b3cd..d965e1f5b 100644 --- a/apps/docs/content/docs/en/tools/ahrefs.mdx +++ b/apps/docs/content/docs/en/tools/ahrefs.mdx @@ -60,11 +60,11 @@ Get a list of backlinks pointing to a target domain or URL. Returns details abou | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `target` | string | Yes | The target domain or URL to analyze | -| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) | +| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | +| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | -| `limit` | number | No | Maximum number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | +| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -88,8 +88,8 @@ Get backlink statistics for a target domain or URL. Returns totals for different | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `target` | string | Yes | The target domain or URL to analyze | -| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) | +| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | +| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `apiKey` | string | Yes | Ahrefs API Key | @@ -113,11 +113,11 @@ Get a list of domains that link to a target domain or URL. Returns unique referr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `target` | string | Yes | The target domain or URL to analyze | -| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) | +| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | +| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | -| `limit` | number | No | Maximum number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | +| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -140,12 +140,12 @@ Get organic keywords that a target domain or URL ranks for in Google search resu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `target` | string | Yes | The target domain or URL to analyze | -| `country` | string | No | Country code for search results \(e.g., us, gb, de\). Default: us | -| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) | +| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | +| `country` | string | No | Country code for search results. Example: "us", "gb", "de" \(default: "us"\) | +| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | -| `limit` | number | No | Maximum number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | +| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -168,12 +168,12 @@ Get the top pages of a target domain sorted by organic traffic. Returns page URL | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `target` | string | Yes | The target domain to analyze | -| `country` | string | No | Country code for traffic data \(e.g., us, gb, de\). Default: us | -| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\) | +| `target` | string | Yes | The target domain to analyze. Example: "example.com" | +| `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" \(default: "us"\) | +| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\). Example: "domain" | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | -| `limit` | number | No | Maximum number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | +| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `select` | string | No | Comma-separated list of fields to return \(e.g., url,traffic,keywords,top_keyword,value\). Default: url,traffic,keywords,top_keyword,value | | `apiKey` | string | Yes | Ahrefs API Key | @@ -197,7 +197,7 @@ Get detailed metrics for a keyword including search volume, keyword difficulty, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `keyword` | string | Yes | The keyword to analyze | -| `country` | string | No | Country code for keyword data \(e.g., us, gb, de\). Default: us | +| `country` | string | No | Country code for keyword data. Example: "us", "gb", "de" \(default: "us"\) | | `apiKey` | string | Yes | Ahrefs API Key | #### Output @@ -222,11 +222,11 @@ Get a list of broken backlinks pointing to a target domain or URL. Useful for id | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `target` | string | Yes | The target domain or URL to analyze | -| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) | +| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | +| `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\). Example: "domain" | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | -| `limit` | number | No | Maximum number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | +| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `apiKey` | string | Yes | Ahrefs API Key | #### Output diff --git a/apps/docs/content/docs/en/tools/airtable.mdx b/apps/docs/content/docs/en/tools/airtable.mdx index 2c573c4ba..879b10b58 100644 --- a/apps/docs/content/docs/en/tools/airtable.mdx +++ b/apps/docs/content/docs/en/tools/airtable.mdx @@ -40,9 +40,9 @@ Read records from an Airtable table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `baseId` | string | Yes | ID of the Airtable base | -| `tableId` | string | Yes | ID of the table | -| `maxRecords` | number | No | Maximum number of records to return | +| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | +| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | +| `maxRecords` | number | No | Maximum number of records to return \(default: all records\) | | `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) | #### Output @@ -60,9 +60,9 @@ Retrieve a single record from an Airtable table by its ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `baseId` | string | Yes | ID of the Airtable base | -| `tableId` | string | Yes | ID or name of the table | -| `recordId` | string | Yes | ID of the record to retrieve | +| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | +| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | +| `recordId` | string | Yes | Record ID to retrieve \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) | #### Output @@ -79,8 +79,8 @@ Write new records to an Airtable table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `baseId` | string | Yes | ID of the Airtable base | -| `tableId` | string | Yes | ID or name of the table | +| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | +| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `records` | json | Yes | Array of records to create, each with a `fields` object | | `fields` | string | No | No description | @@ -99,9 +99,9 @@ Update an existing record in an Airtable table by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `baseId` | string | Yes | ID of the Airtable base | -| `tableId` | string | Yes | ID or name of the table | -| `recordId` | string | Yes | ID of the record to update | +| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | +| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | +| `recordId` | string | Yes | Record ID to update \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) | | `fields` | json | Yes | An object containing the field names and their new values | #### Output @@ -119,8 +119,8 @@ Update multiple existing records in an Airtable table | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `baseId` | string | Yes | ID of the Airtable base | -| `tableId` | string | Yes | ID or name of the table | +| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | +| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `records` | json | Yes | Array of records to update, each with an `id` and a `fields` object | #### Output diff --git a/apps/docs/content/docs/en/tools/apify.mdx b/apps/docs/content/docs/en/tools/apify.mdx index 518bb0a7f..ff701e9da 100644 --- a/apps/docs/content/docs/en/tools/apify.mdx +++ b/apps/docs/content/docs/en/tools/apify.mdx @@ -45,10 +45,12 @@ Run an APIFY actor synchronously and get results (max 5 minutes) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | -| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) | -| `input` | string | No | Actor input as JSON string. See actor documentation for required fields. | -| `timeout` | number | No | Timeout in seconds \(default: actor default\) | -| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) | +| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" | +| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} | +| `Example` | string | No | No description | +| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB | +| `timeout` | number | No | Timeout in seconds for the actor run. Example: 300 for 5 minutes, 3600 for 1 hour | +| `build` | string | No | Actor build to run. Examples: "latest", "beta", "1.2.3", "build-tag-name" | #### Output @@ -68,12 +70,14 @@ Run an APIFY actor asynchronously with polling for long-running tasks | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | -| `actorId` | string | Yes | Actor ID or username/actor-name \(e.g., "janedoe/my-actor" or actor ID\) | -| `input` | string | No | Actor input as JSON string | -| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts | -| `itemLimit` | number | No | Max dataset items to fetch \(1-250000, default 100\) | -| `timeout` | number | No | Timeout in seconds \(default: actor default\) | -| `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) | +| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" | +| `input` | string | No | Actor input as JSON string. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} | +| `Example` | string | No | No description | +| `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts. Example: 30 | +| `itemLimit` | number | No | Max dataset items to fetch \(1-250000\). Default: 100. Example: 500 | +| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB | +| `timeout` | number | No | Timeout in seconds for the actor run. Example: 300 for 5 minutes, 3600 for 1 hour | +| `build` | string | No | Actor build to run. Examples: "latest", "beta", "1.2.3", "build-tag-name" | #### Output diff --git a/apps/docs/content/docs/en/tools/apollo.mdx b/apps/docs/content/docs/en/tools/apollo.mdx index 7fc5863ee..d063d0171 100644 --- a/apps/docs/content/docs/en/tools/apollo.mdx +++ b/apps/docs/content/docs/en/tools/apollo.mdx @@ -53,8 +53,8 @@ Search Apollo | `person_seniorities` | array | No | Seniority levels \(e.g., \["senior", "executive", "manager"\]\) | | `organization_names` | array | No | Company names to search within | | `q_keywords` | string | No | Keywords to search for | -| `page` | number | No | Page number for pagination \(default: 1\) | -| `per_page` | number | No | Results per page \(default: 25, max: 100\) | +| `page` | number | No | Page number for pagination, default 1 \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, default 25, max 100 \(e.g., 25, 50, 100\) | #### Output @@ -78,7 +78,7 @@ Enrich data for a single person using Apollo | `last_name` | string | No | Last name of the person | | `email` | string | No | Email address of the person | | `organization_name` | string | No | Company name where the person works | -| `domain` | string | No | Company domain \(e.g., apollo.io\) | +| `domain` | string | No | Company domain \(e.g., "apollo.io", "acme.com"\) | | `linkedin_url` | string | No | LinkedIn profile URL | | `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) | | `reveal_phone_number` | boolean | No | Reveal phone numbers \(uses credits\) | @@ -123,9 +123,9 @@ Search Apollo | `organization_locations` | array | No | Company locations to search | | `organization_num_employees_ranges` | array | No | Employee count ranges \(e.g., \["1-10", "11-50"\]\) | | `q_organization_keyword_tags` | array | No | Industry or keyword tags | -| `q_organization_name` | string | No | Organization name to search for | -| `page` | number | No | Page number for pagination | -| `per_page` | number | No | Results per page \(max: 100\) | +| `q_organization_name` | string | No | Organization name to search for \(e.g., "Acme", "TechCorp"\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | #### Output @@ -145,8 +145,8 @@ Enrich data for a single organization using Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | -| `organization_name` | string | No | Name of the organization \(at least one of organization_name or domain is required\) | -| `domain` | string | No | Company domain \(e.g., apollo.io\) \(at least one of domain or organization_name is required\) | +| `organization_name` | string | No | Name of the organization \(e.g., "Acme Corporation"\) - at least one of organization_name or domain is required | +| `domain` | string | No | Company domain \(e.g., "apollo.io", "acme.com"\) - at least one of domain or organization_name is required | #### Output @@ -186,8 +186,8 @@ Create a new contact in your Apollo database | `first_name` | string | Yes | First name of the contact | | `last_name` | string | Yes | Last name of the contact | | `email` | string | No | Email address of the contact | -| `title` | string | No | Job title | -| `account_id` | string | No | Apollo account ID to associate with | +| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) | +| `account_id` | string | No | Apollo account ID to associate with \(e.g., "acc_abc123"\) | | `owner_id` | string | No | User ID of the contact owner | #### Output @@ -206,12 +206,12 @@ Update an existing contact in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | -| `contact_id` | string | Yes | ID of the contact to update | +| `contact_id` | string | Yes | ID of the contact to update \(e.g., "con_abc123"\) | | `first_name` | string | No | First name of the contact | | `last_name` | string | No | Last name of the contact | | `email` | string | No | Email address | -| `title` | string | No | Job title | -| `account_id` | string | No | Apollo account ID | +| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) | +| `account_id` | string | No | Apollo account ID \(e.g., "acc_abc123"\) | | `owner_id` | string | No | User ID of the contact owner | #### Output @@ -232,8 +232,8 @@ Search your team | `apiKey` | string | Yes | Apollo API key | | `q_keywords` | string | No | Keywords to search for | | `contact_stage_ids` | array | No | Filter by contact stage IDs | -| `page` | number | No | Page number for pagination | -| `per_page` | number | No | Results per page \(max: 100\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | #### Output @@ -294,7 +294,7 @@ Create a new account (company) in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | -| `name` | string | Yes | Company name | +| `name` | string | Yes | Company name \(e.g., "Acme Corporation"\) | | `website_url` | string | No | Company website URL | | `phone` | string | No | Company phone number | | `owner_id` | string | No | User ID of the account owner | @@ -315,8 +315,8 @@ Update an existing account in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | -| `account_id` | string | Yes | ID of the account to update | -| `name` | string | No | Company name | +| `account_id` | string | Yes | ID of the account to update \(e.g., "acc_abc123"\) | +| `name` | string | No | Company name \(e.g., "Acme Corporation"\) | | `website_url` | string | No | Company website URL | | `phone` | string | No | Company phone number | | `owner_id` | string | No | User ID of the account owner | @@ -340,8 +340,8 @@ Search your team | `q_keywords` | string | No | Keywords to search for in account data | | `owner_id` | string | No | Filter by account owner user ID | | `account_stage_ids` | array | No | Filter by account stage IDs | -| `page` | number | No | Page number for pagination | -| `per_page` | number | No | Results per page \(max: 100\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | #### Output @@ -401,8 +401,8 @@ Create a new deal for an account in your Apollo database (master key required) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key \(master key required\) | -| `name` | string | Yes | Name of the opportunity/deal | -| `account_id` | string | Yes | ID of the account this opportunity belongs to | +| `name` | string | Yes | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) | +| `account_id` | string | Yes | ID of the account this opportunity belongs to \(e.g., "acc_abc123"\) | | `amount` | number | No | Monetary value of the opportunity | | `stage_id` | string | No | ID of the deal stage | | `owner_id` | string | No | User ID of the opportunity owner | @@ -426,11 +426,11 @@ Search and list all deals/opportunities in your team | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | | `q_keywords` | string | No | Keywords to search for in opportunity names | -| `account_ids` | array | No | Filter by specific account IDs | +| `account_ids` | array | No | Filter by specific account IDs \(e.g., \["acc_123", "acc_456"\]\) | | `stage_ids` | array | No | Filter by deal stage IDs | | `owner_ids` | array | No | Filter by opportunity owner IDs | -| `page` | number | No | Page number for pagination | -| `per_page` | number | No | Results per page \(max: 100\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | #### Output @@ -450,7 +450,7 @@ Retrieve complete details of a specific deal/opportunity by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | -| `opportunity_id` | string | Yes | ID of the opportunity to retrieve | +| `opportunity_id` | string | Yes | ID of the opportunity to retrieve \(e.g., "opp_abc123"\) | #### Output @@ -468,8 +468,8 @@ Update an existing deal/opportunity in your Apollo database | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key | -| `opportunity_id` | string | Yes | ID of the opportunity to update | -| `name` | string | No | Name of the opportunity/deal | +| `opportunity_id` | string | Yes | ID of the opportunity to update \(e.g., "opp_abc123"\) | +| `name` | string | No | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) | | `amount` | number | No | Monetary value of the opportunity | | `stage_id` | string | No | ID of the deal stage | | `owner_id` | string | No | User ID of the opportunity owner | @@ -492,10 +492,10 @@ Search for sequences/campaigns in your team | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key \(master key required\) | -| `q_name` | string | No | Search sequences by name | +| `q_name` | string | No | Search sequences by name \(e.g., "Outbound Q1", "Follow-up"\) | | `active` | boolean | No | Filter by active status \(true for active sequences, false for inactive\) | -| `page` | number | No | Page number for pagination | -| `per_page` | number | No | Results per page \(max: 100\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | #### Output @@ -515,8 +515,8 @@ Add contacts to an Apollo sequence | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key \(master key required\) | -| `sequence_id` | string | Yes | ID of the sequence to add contacts to | -| `contact_ids` | array | Yes | Array of contact IDs to add to the sequence | +| `sequence_id` | string | Yes | ID of the sequence to add contacts to \(e.g., "seq_abc123"\) | +| `contact_ids` | array | Yes | Array of contact IDs to add to the sequence \(e.g., \["con_abc123", "con_def456"\]\) | | `emailer_campaign_id` | string | No | Optional emailer campaign ID | | `send_email_from_user_id` | string | No | User ID to send emails from | @@ -538,8 +538,8 @@ Create a new task in Apollo | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key \(master key required\) | | `note` | string | Yes | Task note/description | -| `contact_id` | string | No | Contact ID to associate with | -| `account_id` | string | No | Account ID to associate with | +| `contact_id` | string | No | Contact ID to associate with \(e.g., "con_abc123"\) | +| `account_id` | string | No | Account ID to associate with \(e.g., "acc_abc123"\) | | `due_at` | string | No | Due date in ISO format | | `priority` | string | No | Task priority | | `type` | string | No | Task type | @@ -560,11 +560,11 @@ Search for tasks in Apollo | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Apollo API key \(master key required\) | -| `contact_id` | string | No | Filter by contact ID | -| `account_id` | string | No | Filter by account ID | +| `contact_id` | string | No | Filter by contact ID \(e.g., "con_abc123"\) | +| `account_id` | string | No | Filter by account ID \(e.g., "acc_abc123"\) | | `completed` | boolean | No | Filter by completion status | -| `page` | number | No | Page number for pagination | -| `per_page` | number | No | Results per page \(max: 100\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | #### Output diff --git a/apps/docs/content/docs/en/tools/asana.mdx b/apps/docs/content/docs/en/tools/asana.mdx index 3b43bc352..266469610 100644 --- a/apps/docs/content/docs/en/tools/asana.mdx +++ b/apps/docs/content/docs/en/tools/asana.mdx @@ -42,8 +42,8 @@ Retrieve a single task by GID or get multiple tasks with filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `taskGid` | string | No | The globally unique identifier \(GID\) of the task. If not provided, will get multiple tasks. | -| `workspace` | string | No | Workspace GID to filter tasks \(required when not using taskGid\) | -| `project` | string | No | Project GID to filter tasks | +| `workspace` | string | No | Asana workspace GID \(numeric string\) to filter tasks \(required when not using taskGid\) | +| `project` | string | No | Asana project GID \(numeric string\) to filter tasks | | `limit` | number | No | Maximum number of tasks to return \(default: 50\) | #### Output @@ -80,7 +80,7 @@ Create a new task in Asana | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `workspace` | string | Yes | Workspace GID where the task will be created | +| `workspace` | string | Yes | Asana workspace GID \(numeric string\) where the task will be created | | `name` | string | Yes | Name of the task | | `notes` | string | No | Notes or description for the task | | `assignee` | string | No | User GID to assign the task to | @@ -107,7 +107,7 @@ Update an existing task in Asana | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskGid` | string | Yes | The globally unique identifier \(GID\) of the task to update | +| `taskGid` | string | Yes | Asana task GID \(numeric string\) of the task to update | | `name` | string | No | Updated name for the task | | `notes` | string | No | Updated notes or description for the task | | `assignee` | string | No | Updated assignee user GID | @@ -134,7 +134,7 @@ Retrieve all projects from an Asana workspace | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `workspace` | string | Yes | Workspace GID to retrieve projects from | +| `workspace` | string | Yes | Asana workspace GID \(numeric string\) to retrieve projects from | #### Output @@ -155,10 +155,10 @@ Search for tasks in an Asana workspace | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `workspace` | string | Yes | Workspace GID to search tasks in | +| `workspace` | string | Yes | Asana workspace GID \(numeric string\) to search tasks in | | `text` | string | No | Text to search for in task names | | `assignee` | string | No | Filter tasks by assignee user GID | -| `projects` | array | No | Array of project GIDs to filter tasks by | +| `projects` | array | No | Array of Asana project GIDs \(numeric strings\) to filter tasks by | | `completed` | boolean | No | Filter by completion status | #### Output @@ -193,7 +193,7 @@ Add a comment (story) to an Asana task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskGid` | string | Yes | The globally unique identifier \(GID\) of the task | +| `taskGid` | string | Yes | Asana task GID \(numeric string\) | | `text` | string | Yes | The text content of the comment | #### Output diff --git a/apps/docs/content/docs/en/tools/calcom.mdx b/apps/docs/content/docs/en/tools/calcom.mdx index 7f08ef91d..3b6dbc07f 100644 --- a/apps/docs/content/docs/en/tools/calcom.mdx +++ b/apps/docs/content/docs/en/tools/calcom.mdx @@ -529,7 +529,7 @@ Update an existing event type in Cal.com | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `eventTypeId` | number | Yes | Event type ID to update | +| `eventTypeId` | number | Yes | Event type ID to update \(e.g., 12345\) | | `title` | string | No | Title of the event type | | `slug` | string | No | Unique slug for the event type URL | | `lengthInMinutes` | number | No | Duration of the event in minutes | diff --git a/apps/docs/content/docs/en/tools/calendly.mdx b/apps/docs/content/docs/en/tools/calendly.mdx index 05d209666..57279226c 100644 --- a/apps/docs/content/docs/en/tools/calendly.mdx +++ b/apps/docs/content/docs/en/tools/calendly.mdx @@ -67,11 +67,11 @@ Retrieve a list of all event types for a user or organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Calendly Personal Access Token | -| `user` | string | No | Return only event types that belong to this user \(URI format\) | -| `organization` | string | No | Return only event types that belong to this organization \(URI format\) | -| `count` | number | No | Number of results per page \(default: 20, max: 100\) | -| `pageToken` | string | No | Page token for pagination | -| `sort` | string | No | Sort order for results \(e.g., "name:asc", "name:desc"\) | +| `user` | string | No | Return only event types that belong to this user. Format: URI \(e.g., "https://api.calendly.com/users/abc123-def456"\) | +| `organization` | string | No | Return only event types that belong to this organization. Format: URI \(e.g., "https://api.calendly.com/organizations/abc123-def456"\) | +| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) | +| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token | +| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "name:asc", "name:desc"\) | | `active` | boolean | No | When true, show only active event types. When false or unchecked, show all event types \(both active and inactive\). | #### Output @@ -108,7 +108,7 @@ Get detailed information about a specific event type | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Calendly Personal Access Token | -| `eventTypeUuid` | string | Yes | Event type UUID \(can be full URI or just the UUID\) | +| `eventTypeUuid` | string | Yes | Event type UUID. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/event_types/abc123-def456"\) | #### Output @@ -145,15 +145,15 @@ Retrieve a list of scheduled events for a user or organization | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Calendly Personal Access Token | -| `user` | string | No | Return events that belong to this user \(URI format\). Either "user" or "organization" must be provided. | -| `organization` | string | No | Return events that belong to this organization \(URI format\). Either "user" or "organization" must be provided. | +| `user` | string | No | Return events that belong to this user. Either "user" or "organization" must be provided. Format: URI \(e.g., "https://api.calendly.com/users/abc123-def456"\) | +| `organization` | string | No | Return events that belong to this organization. Either "user" or "organization" must be provided. Format: URI \(e.g., "https://api.calendly.com/organizations/abc123-def456"\) | | `invitee_email` | string | No | Return events where invitee has this email | -| `count` | number | No | Number of results per page \(default: 20, max: 100\) | -| `max_start_time` | string | No | Return events with start time before this time \(ISO 8601 format\) | -| `min_start_time` | string | No | Return events with start time after this time \(ISO 8601 format\) | -| `pageToken` | string | No | Page token for pagination | -| `sort` | string | No | Sort order for results \(e.g., "start_time:asc", "start_time:desc"\) | -| `status` | string | No | Filter by status \("active" or "canceled"\) | +| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) | +| `max_start_time` | string | No | Return events with start time before this time. Format: ISO 8601 \(e.g., "2024-01-15T09:00:00Z"\) | +| `min_start_time` | string | No | Return events with start time after this time. Format: ISO 8601 \(e.g., "2024-01-01T00:00:00Z"\) | +| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token | +| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "start_time:asc", "start_time:desc"\) | +| `status` | string | No | Filter by status. Format: "active" or "canceled" | #### Output @@ -192,7 +192,7 @@ Get detailed information about a specific scheduled event | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Calendly Personal Access Token | -| `eventUuid` | string | Yes | Scheduled event UUID \(can be full URI or just the UUID\) | +| `eventUuid` | string | Yes | Scheduled event UUID. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/scheduled_events/abc123-def456"\) | #### Output @@ -233,12 +233,12 @@ Retrieve a list of invitees for a scheduled event | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Calendly Personal Access Token | -| `eventUuid` | string | Yes | Scheduled event UUID \(can be full URI or just the UUID\) | -| `count` | number | No | Number of results per page \(default: 20, max: 100\) | +| `eventUuid` | string | Yes | Scheduled event UUID. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/scheduled_events/abc123-def456"\) | +| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) | | `email` | string | No | Filter invitees by email address | -| `pageToken` | string | No | Page token for pagination | -| `sort` | string | No | Sort order for results \(e.g., "created_at:asc", "created_at:desc"\) | -| `status` | string | No | Filter by status \("active" or "canceled"\) | +| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token | +| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "created_at:asc", "created_at:desc"\) | +| `status` | string | No | Filter by status. Format: "active" or "canceled" | #### Output @@ -278,7 +278,7 @@ Cancel a scheduled event | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Calendly Personal Access Token | -| `eventUuid` | string | Yes | Scheduled event UUID to cancel \(can be full URI or just the UUID\) | +| `eventUuid` | string | Yes | Scheduled event UUID to cancel. Format: UUID \(e.g., "abc123-def456"\) or full URI \(e.g., "https://api.calendly.com/scheduled_events/abc123-def456"\) | | `reason` | string | No | Reason for cancellation \(will be sent to invitees\) | #### Output diff --git a/apps/docs/content/docs/en/tools/clerk.mdx b/apps/docs/content/docs/en/tools/clerk.mdx index 8584c8a7b..abde1d410 100644 --- a/apps/docs/content/docs/en/tools/clerk.mdx +++ b/apps/docs/content/docs/en/tools/clerk.mdx @@ -43,15 +43,15 @@ List all users in your Clerk application with optional filtering and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `limit` | number | No | Number of results per page \(1-500, default: 10\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | | `orderBy` | string | No | Sort field with optional +/- prefix for direction \(default: -created_at\) | -| `emailAddress` | string | No | Filter by email address \(comma-separated for multiple\) | +| `emailAddress` | string | No | Filter by email address \(e.g., user@example.com or user1@example.com,user2@example.com\) | | `phoneNumber` | string | No | Filter by phone number \(comma-separated for multiple\) | | `externalId` | string | No | Filter by external ID \(comma-separated for multiple\) | | `username` | string | No | Filter by username \(comma-separated for multiple\) | -| `userId` | string | No | Filter by user ID \(comma-separated for multiple\) | -| `query` | string | No | Search query to match across email, phone, username, and names | +| `userId` | string | No | Filter by user ID \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC or comma-separated for multiple\) | +| `query` | string | No | Search query to match across email, phone, username, and names \(e.g., john or john@example.com\) | #### Output @@ -94,7 +94,7 @@ Retrieve a single user by their ID from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `userId` | string | Yes | The ID of the user to retrieve | +| `userId` | string | Yes | The ID of the user to retrieve \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -191,7 +191,7 @@ Update an existing user in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `userId` | string | Yes | The ID of the user to update | +| `userId` | string | Yes | The ID of the user to update \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `firstName` | string | No | First name of the user | | `lastName` | string | No | Last name of the user | | `username` | string | No | Username \(must be unique\) | @@ -240,7 +240,7 @@ Delete a user from your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `userId` | string | Yes | The ID of the user to delete | +| `userId` | string | Yes | The ID of the user to delete \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -260,10 +260,10 @@ List all organizations in your Clerk application with optional filtering | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `limit` | number | No | Number of results per page \(1-500, default: 10\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | | `includeMembersCount` | boolean | No | Include member count for each organization | -| `query` | string | No | Search by organization ID, name, or slug | +| `query` | string | No | Search by organization ID, name, or slug \(e.g., Acme Corp or acme-corp\) | | `orderBy` | string | No | Sort field \(name, created_at, members_count\) with +/- prefix | #### Output @@ -296,7 +296,7 @@ Retrieve a single organization by ID or slug from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `organizationId` | string | Yes | The ID or slug of the organization to retrieve | +| `organizationId` | string | Yes | The ID or slug of the organization to retrieve \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug\) | #### Output @@ -327,7 +327,7 @@ Create a new organization in your Clerk application | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | | `name` | string | Yes | Name of the organization | -| `createdBy` | string | Yes | User ID of the creator \(will become admin\) | +| `createdBy` | string | Yes | User ID of the creator who will become admin \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | | `slug` | string | No | Slug identifier for the organization | | `maxAllowedMemberships` | number | No | Maximum member capacity \(0 for unlimited\) | | `publicMetadata` | json | No | Public metadata \(JSON object\) | @@ -361,11 +361,11 @@ List sessions for a user or client in your Clerk application | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `userId` | string | No | User ID to list sessions for \(required if clientId not provided\) | +| `userId` | string | No | User ID to list sessions for \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC; required if clientId not provided\) | | `clientId` | string | No | Client ID to list sessions for \(required if userId not provided\) | | `status` | string | No | Filter by session status \(abandoned, active, ended, expired, pending, removed, replaced, revoked\) | -| `limit` | number | No | Number of results per page \(1-500, default: 10\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results per page \(e.g., 10, 50, 100; range: 1-500, default: 10\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 10, 20\) | #### Output @@ -394,7 +394,7 @@ Retrieve a single session by ID from Clerk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `sessionId` | string | Yes | The ID of the session to retrieve | +| `sessionId` | string | Yes | The ID of the session to retrieve \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output @@ -421,7 +421,7 @@ Revoke a session to immediately invalidate it | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `secretKey` | string | Yes | The Clerk Secret Key for API authentication | -| `sessionId` | string | Yes | The ID of the session to revoke | +| `sessionId` | string | Yes | The ID of the session to revoke \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) | #### Output diff --git a/apps/docs/content/docs/en/tools/confluence.mdx b/apps/docs/content/docs/en/tools/confluence.mdx index c0d5834fe..6b1f531f4 100644 --- a/apps/docs/content/docs/en/tools/confluence.mdx +++ b/apps/docs/content/docs/en/tools/confluence.mdx @@ -42,7 +42,7 @@ Retrieve content from Confluence pages using the Confluence API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) | -| `pageId` | string | Yes | Confluence page ID to retrieve | +| `pageId` | string | Yes | Confluence page ID to retrieve \(numeric ID from page URL or API\) | | `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. | #### Output @@ -63,7 +63,7 @@ Update a Confluence page using the Confluence API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) | -| `pageId` | string | Yes | Confluence page ID to update | +| `pageId` | string | Yes | Confluence page ID to update \(numeric ID from page URL or API\) | | `title` | string | No | New title for the page | | `content` | string | No | New content for the page in Confluence storage format | | `version` | number | No | Version number of the page \(required for preventing conflicts\) | diff --git a/apps/docs/content/docs/en/tools/datadog.mdx b/apps/docs/content/docs/en/tools/datadog.mdx index 4ae3533c4..9bbc3e392 100644 --- a/apps/docs/content/docs/en/tools/datadog.mdx +++ b/apps/docs/content/docs/en/tools/datadog.mdx @@ -60,9 +60,9 @@ Query metric timeseries data from Datadog. Use for analyzing trends, creating re | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}"\) | -| `from` | number | Yes | Start time as Unix timestamp in seconds | -| `to` | number | Yes | End time as Unix timestamp in seconds | +| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}", "sum:nginx.requests\{env:prod\}.as_count\(\)"\) | +| `from` | number | Yes | Start time as Unix timestamp in seconds \(e.g., 1705320000\) | +| `to` | number | Yes | End time as Unix timestamp in seconds \(e.g., 1705323600\) | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) | @@ -86,11 +86,11 @@ Post an event to the Datadog event stream. Use for deployment notifications, ale | `text` | string | Yes | Event body/description. Supports markdown. | | `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot | | `priority` | string | No | Event priority: normal or low | -| `host` | string | No | Host name to associate with this event | -| `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api"\) | +| `host` | string | No | Host name to associate with this event \(e.g., "web-server-01", "prod-api-1"\) | +| `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api", "team:backend,priority:high"\) | | `aggregationKey` | string | No | Key to aggregate events together | | `sourceTypeName` | string | No | Source type name for the event | -| `dateHappened` | number | No | Unix timestamp when the event occurred \(defaults to now\) | +| `dateHappened` | number | No | Unix timestamp in seconds when the event occurred \(e.g., 1705320000, defaults to now\) | | `apiKey` | string | Yes | Datadog API key | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) | @@ -119,7 +119,7 @@ Create a new monitor/alert in Datadog. Monitors can track metrics, service check | --------- | ---- | -------- | ----------- | | `name` | string | Yes | Monitor name | | `type` | string | Yes | Monitor type: metric alert, service check, event alert, process alert, log alert, query alert, composite, synthetics alert, slo alert | -| `query` | string | Yes | Monitor query \(e.g., "avg\(last_5m\):avg:system.cpu.idle\{*\} < 20"\) | +| `query` | string | Yes | Monitor query \(e.g., "avg\(last_5m\):avg:system.cpu.idle\{*\} < 20", "logs\(\"status:error\"\).index\(\"main\"\).rollup\(\"count\"\).last\(\"5m\"\) > 100"\) | | `message` | string | No | Message to include with notifications. Can include @-mentions and markdown. | | `tags` | string | No | Comma-separated list of tags | | `priority` | number | No | Monitor priority \(1-5, where 1 is highest\) | @@ -152,8 +152,8 @@ Retrieve details of a specific monitor by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `monitorId` | string | Yes | The ID of the monitor to retrieve | -| `groupStates` | string | No | Comma-separated group states to include: alert, warn, no data, ok | +| `monitorId` | string | Yes | The ID of the monitor to retrieve \(e.g., "12345678"\) | +| `groupStates` | string | No | Comma-separated group states to include \(e.g., "alert,warn", "alert,warn,no data,ok"\) | | `withDowntimes` | boolean | No | Include downtime data with the monitor | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | @@ -183,13 +183,13 @@ List all monitors in Datadog with optional filtering by name, tags, or state. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupStates` | string | No | Comma-separated group states to filter by: alert, warn, no data, ok | -| `name` | string | No | Filter monitors by name \(partial match\) | -| `tags` | string | No | Comma-separated list of tags to filter by | -| `monitorTags` | string | No | Comma-separated list of monitor tags to filter by | +| `groupStates` | string | No | Comma-separated group states to filter by \(e.g., "alert,warn", "alert,warn,no data,ok"\) | +| `name` | string | No | Filter monitors by name with partial match \(e.g., "CPU", "Production"\) | +| `tags` | string | No | Comma-separated list of tags to filter by \(e.g., "env:prod,team:backend"\) | +| `monitorTags` | string | No | Comma-separated list of monitor tags to filter by \(e.g., "service:api,priority:high"\) | | `withDowntimes` | boolean | No | Include downtime data with monitors | -| `page` | number | No | Page number for pagination \(0-indexed\) | -| `pageSize` | number | No | Number of monitors per page \(max 1000\) | +| `page` | number | No | Page number for pagination \(0-indexed, e.g., 0, 1, 2\) | +| `pageSize` | number | No | Number of monitors per page \(e.g., 50, max: 1000\) | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) | @@ -214,9 +214,9 @@ Mute a monitor to temporarily suppress notifications. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `monitorId` | string | Yes | The ID of the monitor to mute | -| `scope` | string | No | Scope to mute \(e.g., "host:myhost"\). If not specified, mutes all scopes. | -| `end` | number | No | Unix timestamp when the mute should end. If not specified, mutes indefinitely. | +| `monitorId` | string | Yes | The ID of the monitor to mute \(e.g., "12345678"\) | +| `scope` | string | No | Scope to mute \(e.g., "host:myhost", "env:prod"\). If not specified, mutes all scopes. | +| `end` | number | No | Unix timestamp in seconds when the mute should end \(e.g., 1705323600\). If not specified, mutes indefinitely. | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) | @@ -235,11 +235,11 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | Log search query \(e.g., "service:web-app status:error"\) | -| `from` | string | Yes | Start time in ISO-8601 format or relative \(e.g., "now-1h"\) | -| `to` | string | Yes | End time in ISO-8601 format or relative \(e.g., "now"\) | -| `limit` | number | No | Maximum number of logs to return \(default: 50, max: 1000\) | -| `sort` | string | No | Sort order: timestamp \(oldest first\) or -timestamp \(newest first\) | +| `query` | string | Yes | Log search query using Datadog query syntax \(e.g., "service:web-app status:error", "host:prod-* @http.status_code:500"\) | +| `from` | string | Yes | Start time in ISO-8601 format or relative time \(e.g., "now-1h", "now-15m", "2024-01-15T10:00:00Z"\) | +| `to` | string | Yes | End time in ISO-8601 format or relative time \(e.g., "now", "now-5m", "2024-01-15T12:00:00Z"\) | +| `limit` | number | No | Maximum number of logs to return \(e.g., 50, 100, max: 1000\) | +| `sort` | string | No | Sort order: "timestamp" for oldest first, "-timestamp" for newest first | | `indexes` | string | No | Comma-separated list of log indexes to search | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | @@ -287,10 +287,10 @@ Schedule a downtime to suppress monitor notifications during maintenance windows | --------- | ---- | -------- | ----------- | | `scope` | string | Yes | Scope to apply downtime to \(e.g., "host:myhost", "env:production", or "*" for all\) | | `message` | string | No | Message to display during downtime | -| `start` | number | No | Unix timestamp for downtime start \(defaults to now\) | -| `end` | number | No | Unix timestamp for downtime end | -| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York"\) | -| `monitorId` | string | No | Specific monitor ID to mute | +| `start` | number | No | Unix timestamp for downtime start in seconds \(e.g., 1705320000, defaults to now\) | +| `end` | number | No | Unix timestamp for downtime end in seconds \(e.g., 1705323600\) | +| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York", "UTC", "Europe/London"\) | +| `monitorId` | string | No | Specific monitor ID to mute \(e.g., "12345678"\) | | `monitorTags` | string | No | Comma-separated monitor tags to match \(e.g., "team:backend,priority:high"\) | | `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification | | `apiKey` | string | Yes | Datadog API key | @@ -318,7 +318,7 @@ List all scheduled downtimes in Datadog. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `currentOnly` | boolean | No | Only return currently active downtimes | -| `monitorId` | string | No | Filter by monitor ID | +| `monitorId` | string | No | Filter by monitor ID \(e.g., "12345678"\) | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) | @@ -343,7 +343,7 @@ Cancel a scheduled downtime. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `downtimeId` | string | Yes | The ID of the downtime to cancel | +| `downtimeId` | string | Yes | The ID of the downtime to cancel \(e.g., "abc123def456"\) | | `apiKey` | string | Yes | Datadog API key | | `applicationKey` | string | Yes | Datadog Application key | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) | diff --git a/apps/docs/content/docs/en/tools/discord.mdx b/apps/docs/content/docs/en/tools/discord.mdx index 13f2610f2..84dd318f8 100644 --- a/apps/docs/content/docs/en/tools/discord.mdx +++ b/apps/docs/content/docs/en/tools/discord.mdx @@ -53,9 +53,9 @@ Send a message to a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to send the message to | +| `channelId` | string | Yes | The Discord channel ID to send the message to, e.g., 123456789012345678 | | `content` | string | No | The text content of the message | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `files` | file[] | No | Files to attach to the message | #### Output @@ -89,7 +89,7 @@ Retrieve messages from a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to retrieve messages from | +| `channelId` | string | Yes | The Discord channel ID to retrieve messages from, e.g., 123456789012345678 | | `limit` | number | No | Maximum number of messages to retrieve \(default: 10, max: 100\) | #### Output @@ -125,7 +125,7 @@ Retrieve information about a Discord server (guild) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -151,7 +151,7 @@ Retrieve information about a Discord user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Discord bot token for authentication | -| `userId` | string | Yes | The Discord user ID | +| `userId` | string | Yes | The Discord user ID, e.g., 123456789012345678 | #### Output @@ -177,10 +177,10 @@ Edit an existing message in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID containing the message | -| `messageId` | string | Yes | The ID of the message to edit | +| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | +| `messageId` | string | Yes | The ID of the message to edit, e.g., 123456789012345678 | | `content` | string | No | The new text content for the message | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -202,9 +202,9 @@ Delete a message from a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID containing the message | -| `messageId` | string | Yes | The ID of the message to delete | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | +| `messageId` | string | Yes | The ID of the message to delete, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -221,10 +221,10 @@ Add a reaction emoji to a Discord message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID containing the message | -| `messageId` | string | Yes | The ID of the message to react to | +| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | +| `messageId` | string | Yes | The ID of the message to react to, e.g., 123456789012345678 | | `emoji` | string | Yes | The emoji to react with \(unicode emoji or custom emoji in name:id format\) | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -241,11 +241,11 @@ Remove a reaction from a Discord message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID containing the message | -| `messageId` | string | Yes | The ID of the message with the reaction | +| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | +| `messageId` | string | Yes | The ID of the message with the reaction, e.g., 123456789012345678 | | `emoji` | string | Yes | The emoji to remove \(unicode emoji or custom emoji in name:id format\) | -| `userId` | string | No | The user ID whose reaction to remove \(omit to remove bot's own reaction\) | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `userId` | string | No | The user ID whose reaction to remove \(omit to remove bot's own reaction\), e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -262,9 +262,9 @@ Pin a message in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID containing the message | -| `messageId` | string | Yes | The ID of the message to pin | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | +| `messageId` | string | Yes | The ID of the message to pin, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -281,9 +281,9 @@ Unpin a message in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID containing the message | -| `messageId` | string | Yes | The ID of the message to unpin | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | +| `messageId` | string | Yes | The ID of the message to unpin, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -300,11 +300,11 @@ Create a thread in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to create the thread in | +| `channelId` | string | Yes | The Discord channel ID to create the thread in, e.g., 123456789012345678 | | `name` | string | Yes | The name of the thread \(1-100 characters\) | -| `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\) | +| `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\), e.g., 123456789012345678 | | `autoArchiveDuration` | number | No | Duration in minutes to auto-archive the thread \(60, 1440, 4320, 10080\) | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -327,8 +327,8 @@ Join a thread in Discord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `threadId` | string | Yes | The thread ID to join | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `threadId` | string | Yes | The thread ID to join, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -345,8 +345,8 @@ Leave a thread in Discord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `threadId` | string | Yes | The thread ID to leave | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `threadId` | string | Yes | The thread ID to leave, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -363,9 +363,9 @@ Archive or unarchive a thread in Discord | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `threadId` | string | Yes | The thread ID to archive/unarchive | +| `threadId` | string | Yes | The thread ID to archive/unarchive, e.g., 123456789012345678 | | `archived` | boolean | Yes | Whether to archive \(true\) or unarchive \(false\) the thread | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -385,11 +385,11 @@ Create a new channel in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `name` | string | Yes | The name of the channel \(1-100 characters\) | | `type` | number | No | Channel type \(0=text, 2=voice, 4=category, 5=announcement, 13=stage\) | | `topic` | string | No | Channel topic \(0-1024 characters\) | -| `parentId` | string | No | Parent category ID for the channel | +| `parentId` | string | No | Parent category ID for the channel, e.g., 123456789012345678 | #### Output @@ -411,10 +411,10 @@ Update a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to update | +| `channelId` | string | Yes | The Discord channel ID to update, e.g., 123456789012345678 | | `name` | string | No | The new name for the channel | | `topic` | string | No | The new topic for the channel | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -436,8 +436,8 @@ Delete a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to delete | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `channelId` | string | Yes | The Discord channel ID to delete, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -454,8 +454,8 @@ Get information about a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to retrieve | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `channelId` | string | Yes | The Discord channel ID to retrieve, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -478,7 +478,7 @@ Create a new role in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `name` | string | Yes | The name of the role | | `color` | number | No | RGB color value as integer \(e.g., 0xFF0000 for red\) | | `hoist` | boolean | No | Whether to display role members separately from online members | @@ -505,8 +505,8 @@ Update a role in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `roleId` | string | Yes | The role ID to update | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `roleId` | string | Yes | The role ID to update, e.g., 123456789012345678 | | `name` | string | No | The new name for the role | | `color` | number | No | RGB color value as integer | | `hoist` | boolean | No | Whether to display role members separately | @@ -531,8 +531,8 @@ Delete a role from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `roleId` | string | Yes | The role ID to delete | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `roleId` | string | Yes | The role ID to delete, e.g., 123456789012345678 | #### Output @@ -549,9 +549,9 @@ Assign a role to a member in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to assign the role to | -| `roleId` | string | Yes | The role ID to assign | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to assign the role to, e.g., 123456789012345678 | +| `roleId` | string | Yes | The role ID to assign, e.g., 123456789012345678 | #### Output @@ -568,9 +568,9 @@ Remove a role from a member in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to remove the role from | -| `roleId` | string | Yes | The role ID to remove | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to remove the role from, e.g., 123456789012345678 | +| `roleId` | string | Yes | The role ID to remove, e.g., 123456789012345678 | #### Output @@ -587,8 +587,8 @@ Kick a member from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to kick | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to kick, e.g., 123456789012345678 | | `reason` | string | No | Reason for kicking the member | #### Output @@ -606,8 +606,8 @@ Ban a member from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to ban | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to ban, e.g., 123456789012345678 | | `reason` | string | No | Reason for banning the member | | `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) | @@ -626,8 +626,8 @@ Unban a member from a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to unban | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to unban, e.g., 123456789012345678 | | `reason` | string | No | Reason for unbanning the member | #### Output @@ -645,8 +645,8 @@ Get information about a member in a Discord server | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to retrieve | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to retrieve, e.g., 123456789012345678 | #### Output @@ -671,8 +671,8 @@ Update a member in a Discord server (e.g., change nickname) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | -| `userId` | string | Yes | The user ID to update | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | +| `userId` | string | Yes | The user ID to update, e.g., 123456789012345678 | | `nick` | string | No | New nickname for the member \(null to remove\) | | `mute` | boolean | No | Whether to mute the member in voice channels | | `deaf` | boolean | No | Whether to deafen the member in voice channels | @@ -696,11 +696,11 @@ Create an invite link for a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to create an invite for | +| `channelId` | string | Yes | The Discord channel ID to create an invite for, e.g., 123456789012345678 | | `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) | | `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) | | `temporary` | boolean | No | Whether invite grants temporary membership | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -724,7 +724,7 @@ Get information about a Discord invite | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | | `inviteCode` | string | Yes | The invite code to retrieve | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -748,7 +748,7 @@ Delete a Discord invite | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | | `inviteCode` | string | Yes | The invite code to delete | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -765,9 +765,9 @@ Create a webhook in a Discord channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `channelId` | string | Yes | The Discord channel ID to create the webhook in | +| `channelId` | string | Yes | The Discord channel ID to create the webhook in, e.g., 123456789012345678 | | `name` | string | Yes | Name of the webhook \(1-80 characters\) | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -789,11 +789,11 @@ Execute a Discord webhook to send a message | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `webhookId` | string | Yes | The webhook ID | +| `webhookId` | string | Yes | The webhook ID, e.g., 123456789012345678 | | `webhookToken` | string | Yes | The webhook token | | `content` | string | Yes | The message content to send | | `username` | string | No | Override the default username of the webhook | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -815,8 +815,8 @@ Get information about a Discord webhook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `webhookId` | string | Yes | The webhook ID to retrieve | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `webhookId` | string | Yes | The webhook ID to retrieve, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output @@ -839,8 +839,8 @@ Delete a Discord webhook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | The bot token for authentication | -| `webhookId` | string | Yes | The webhook ID to delete | -| `serverId` | string | Yes | The Discord server ID \(guild ID\) | +| `webhookId` | string | Yes | The webhook ID to delete, e.g., 123456789012345678 | +| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | #### Output diff --git a/apps/docs/content/docs/en/tools/dropbox.mdx b/apps/docs/content/docs/en/tools/dropbox.mdx index 8b259068a..54cf3013d 100644 --- a/apps/docs/content/docs/en/tools/dropbox.mdx +++ b/apps/docs/content/docs/en/tools/dropbox.mdx @@ -256,7 +256,7 @@ Search for files and folders in Dropbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `query` | string | Yes | The search query | -| `path` | string | No | Limit search to a specific folder path | +| `path` | string | No | Dropbox folder path to limit search scope \(e.g., /folder/subfolder\) | | `fileExtensions` | string | No | Comma-separated list of file extensions to filter by \(e.g., pdf,xlsx\) | | `maxResults` | number | No | Maximum number of results to return \(default: 100\) | diff --git a/apps/docs/content/docs/en/tools/dynamodb.mdx b/apps/docs/content/docs/en/tools/dynamodb.mdx index 03550a30d..36bc79f6f 100644 --- a/apps/docs/content/docs/en/tools/dynamodb.mdx +++ b/apps/docs/content/docs/en/tools/dynamodb.mdx @@ -54,8 +54,8 @@ Get an item from a DynamoDB table by primary key | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | Yes | DynamoDB table name | -| `key` | object | Yes | Primary key of the item to retrieve | +| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | +| `key` | object | Yes | Primary key of the item to retrieve \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `consistentRead` | boolean | No | Use strongly consistent read | #### Output @@ -76,8 +76,8 @@ Put an item into a DynamoDB table | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | Yes | DynamoDB table name | -| `item` | object | Yes | Item to put into the table | +| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | +| `item` | object | Yes | Item to put into the table \(e.g., \{"pk": "USER#123", "name": "John", "email": "john@example.com"\}\) | #### Output @@ -97,13 +97,13 @@ Query items from a DynamoDB table using key conditions | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | Yes | DynamoDB table name | -| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk"\) | -| `filterExpression` | string | No | Filter expression for results | -| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words | -| `expressionAttributeValues` | object | No | Expression attribute values | -| `indexName` | string | No | Secondary index name to query | -| `limit` | number | No | Maximum number of items to return | +| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | +| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk" or "pk = :pk AND sk BEGINS_WITH :prefix"\) | +| `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) | +| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#status": "status"\}\) | +| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":pk": "USER#123", ":minAge": 18\}\) | +| `indexName` | string | No | Secondary index name to query \(e.g., "GSI1", "email-index"\) | +| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) | #### Output @@ -124,12 +124,12 @@ Scan all items in a DynamoDB table | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | Yes | DynamoDB table name | -| `filterExpression` | string | No | Filter expression for results | -| `projectionExpression` | string | No | Attributes to retrieve | -| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words | -| `expressionAttributeValues` | object | No | Expression attribute values | -| `limit` | number | No | Maximum number of items to return | +| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | +| `filterExpression` | string | No | Filter expression for results \(e.g., "age > :minAge AND #status = :status"\) | +| `projectionExpression` | string | No | Attributes to retrieve \(e.g., "pk, sk, #name, email"\) | +| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#status": "status"\}\) | +| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":minAge": 18, ":status": "active"\}\) | +| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) | #### Output @@ -150,12 +150,12 @@ Update an item in a DynamoDB table | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | Yes | DynamoDB table name | -| `key` | object | Yes | Primary key of the item to update | -| `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name"\) | -| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words | -| `expressionAttributeValues` | object | No | Expression attribute values | -| `conditionExpression` | string | No | Condition that must be met for the update to succeed | +| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | +| `key` | object | Yes | Primary key of the item to update \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | +| `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name, age = :age" or "SET #count = #count + :inc"\) | +| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#count": "count"\}\) | +| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":name": "John", ":age": 30, ":inc": 1\}\) | +| `conditionExpression` | string | No | Condition that must be met for the update to succeed \(e.g., "attribute_exists\(pk\)" or "version = :expectedVersion"\) | #### Output @@ -175,9 +175,9 @@ Delete an item from a DynamoDB table | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | Yes | DynamoDB table name | -| `key` | object | Yes | Primary key of the item to delete | -| `conditionExpression` | string | No | Condition that must be met for the delete to succeed | +| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | +| `key` | object | Yes | Primary key of the item to delete \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | +| `conditionExpression` | string | No | Condition that must be met for the delete to succeed \(e.g., "attribute_exists\(pk\)"\) | #### Output @@ -196,7 +196,7 @@ Introspect DynamoDB to list tables or get detailed schema information for a spec | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `tableName` | string | No | Optional table name to get detailed schema. If not provided, lists all tables. | +| `tableName` | string | No | Optional table name to get detailed schema \(e.g., "Users", "Orders"\). If not provided, lists all tables. | #### Output diff --git a/apps/docs/content/docs/en/tools/elasticsearch.mdx b/apps/docs/content/docs/en/tools/elasticsearch.mdx index d806a3758..7e2f80dc2 100644 --- a/apps/docs/content/docs/en/tools/elasticsearch.mdx +++ b/apps/docs/content/docs/en/tools/elasticsearch.mdx @@ -49,11 +49,12 @@ Search documents in Elasticsearch using Query DSL. Returns matching documents wi | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name to search | -| `query` | string | No | Query DSL as JSON string | -| `from` | number | No | Starting offset for pagination \(default: 0\) | -| `size` | number | No | Number of results to return \(default: 10\) | -| `sort` | string | No | Sort specification as JSON string | +| `index` | string | Yes | Index name to search \(e.g., "products", "logs-2024"\) | +| `query` | string | No | Query DSL as JSON string. Example: \{"match":\{"title":"search term"\}\} or \{"bool":\{"must":\[...\]\}\} | +| `Example` | string | No | No description | +| `from` | number | No | Starting offset for pagination \(e.g., 0, 10, 20\). Default: 0 | +| `size` | number | No | Number of results to return \(e.g., 10, 25, 100\). Default: 10 | +| `sort` | string | No | Sort specification as JSON string. Example: \[\{"created_at":"desc"\}\] or \[\{"_score":"desc"\},\{"name":"asc"\}\] | | `sourceIncludes` | string | No | Comma-separated list of fields to include in _source | | `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source | | `trackTotalHits` | boolean | No | Track accurate total hit count \(default: true\) | @@ -82,8 +83,8 @@ Index (create or update) a document in Elasticsearch. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Target index name | -| `documentId` | string | No | Document ID \(auto-generated if not provided\) | +| `index` | string | Yes | Target index name \(e.g., "products", "logs-2024"\) | +| `documentId` | string | No | Document ID \(e.g., "abc123", "user_456"\). Auto-generated if not provided | | `document` | string | Yes | Document body as JSON string | | `refresh` | string | No | Refresh policy: true, false, or wait_for | @@ -111,8 +112,8 @@ Retrieve a document by ID from Elasticsearch. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name | -| `documentId` | string | Yes | Document ID to retrieve | +| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) | +| `documentId` | string | Yes | Document ID to retrieve \(e.g., "abc123", "user_456"\) | | `sourceIncludes` | string | No | Comma-separated list of fields to include | | `sourceExcludes` | string | No | Comma-separated list of fields to exclude | @@ -141,8 +142,8 @@ Partially update a document in Elasticsearch using doc merge. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name | -| `documentId` | string | Yes | Document ID to update | +| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) | +| `documentId` | string | Yes | Document ID to update \(e.g., "abc123", "user_456"\) | | `document` | string | Yes | Partial document to merge as JSON string | | `retryOnConflict` | number | No | Number of retries on version conflict | @@ -170,8 +171,8 @@ Delete a document from Elasticsearch by ID. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name | -| `documentId` | string | Yes | Document ID to delete | +| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) | +| `documentId` | string | Yes | Document ID to delete \(e.g., "abc123", "user_456"\) | | `refresh` | string | No | Refresh policy: true, false, or wait_for | #### Output @@ -198,8 +199,9 @@ Perform multiple index, create, delete, or update operations in a single request | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | No | Default index for operations that do not specify one | -| `operations` | string | Yes | Bulk operations as NDJSON string \(newline-delimited JSON\) | +| `index` | string | No | Default index for operations \(e.g., "products", "logs-2024"\) | +| `operations` | string | Yes | Bulk operations as NDJSON string. Each operation is two lines: action metadata and optional document. Example: \{"index":\{"_index":"products","_id":"1"\}\}\\n\{"name":"Widget"\}\\n | +| `Example` | string | No | No description | | `refresh` | string | No | Refresh policy: true, false, or wait_for | #### Output @@ -225,8 +227,9 @@ Count documents matching a query in Elasticsearch. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name to count documents in | -| `query` | string | No | Optional query to filter documents \(JSON string\) | +| `index` | string | Yes | Index name to count documents in \(e.g., "products", "logs-2024"\) | +| `query` | string | No | Query DSL to filter documents \(JSON string\). Example: \{"match":\{"status":"active"\}\} | +| `Example` | string | No | No description | #### Output @@ -250,7 +253,7 @@ Create a new index with optional settings and mappings. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name to create | +| `index` | string | Yes | Index name to create \(e.g., "products", "logs-2024"\) | | `settings` | string | No | Index settings as JSON string | | `mappings` | string | No | Index mappings as JSON string | @@ -277,7 +280,7 @@ Delete an index and all its documents. This operation is irreversible. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name to delete | +| `index` | string | Yes | Index name to delete \(e.g., "products", "logs-2024"\) | #### Output @@ -300,7 +303,7 @@ Retrieve index information including settings, mappings, and aliases. | `apiKey` | string | No | Elasticsearch API key | | `username` | string | No | Username for basic auth | | `password` | string | No | Password for basic auth | -| `index` | string | Yes | Index name to retrieve info for | +| `index` | string | Yes | Index name to retrieve info for \(e.g., "products", "logs-2024"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/elevenlabs.mdx b/apps/docs/content/docs/en/tools/elevenlabs.mdx index 108bce0f3..10c952b12 100644 --- a/apps/docs/content/docs/en/tools/elevenlabs.mdx +++ b/apps/docs/content/docs/en/tools/elevenlabs.mdx @@ -41,9 +41,11 @@ Convert TTS using ElevenLabs voices | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | -| `voiceId` | string | Yes | The ID of the voice to use | -| `modelId` | string | No | The ID of the model to use \(defaults to eleven_monolingual_v1\) | +| `text` | string | Yes | The text to convert to speech \(e.g., "Hello, welcome to our service!"\) | +| `voiceId` | string | Yes | The ID of the voice to use \(e.g., "21m00Tcm4TlvDq8ikWAM" for Rachel\) | +| `modelId` | string | No | The ID of the model to use \(e.g., "eleven_multilingual_v2", "eleven_turbo_v2"\). Defaults to eleven_monolingual_v1 | +| `stability` | number | No | Voice stability setting from 0.0 to 1.0 \(e.g., 0.5 for balanced, 0.75 for more stable\). Higher values produce more consistent output | +| `similarity` | number | No | Similarity boost setting from 0.0 to 1.0 \(e.g., 0.75 for natural, 1.0 for maximum similarity\). Higher values make the voice more similar to the original | | `apiKey` | string | Yes | Your ElevenLabs API key | #### Output diff --git a/apps/docs/content/docs/en/tools/exa.mdx b/apps/docs/content/docs/en/tools/exa.mdx index 3b585db42..4907f2d38 100644 --- a/apps/docs/content/docs/en/tools/exa.mdx +++ b/apps/docs/content/docs/en/tools/exa.mdx @@ -44,11 +44,11 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `query` | string | Yes | The search query to execute | -| `numResults` | number | No | Number of results to return \(default: 10, max: 25\) | -| `useAutoprompt` | boolean | No | Whether to use autoprompt to improve the query \(default: false\) | -| `type` | string | No | Search type: neural, keyword, auto or fast \(default: auto\) | -| `includeDomains` | string | No | Comma-separated list of domains to include in results | -| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results | +| `numResults` | number | No | Number of results to return \(e.g., 5, 10, 25\). Default: 10, max: 25 | +| `useAutoprompt` | boolean | No | Whether to use autoprompt to improve the query \(true or false\). Default: false | +| `type` | string | No | Search type: "neural", "keyword", "auto", or "fast". Default: "auto" | +| `includeDomains` | string | No | Comma-separated list of domains to include in results \(e.g., "github.com, stackoverflow.com"\) | +| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results \(e.g., "reddit.com, pinterest.com"\) | | `category` | string | No | Filter by category: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report | | `text` | boolean | No | Include full text content in results \(default: false\) | | `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) | @@ -107,10 +107,10 @@ Find webpages similar to a given URL using Exa AI. Returns a list of similar lin | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `url` | string | Yes | The URL to find similar links for | -| `numResults` | number | No | Number of similar links to return \(default: 10, max: 25\) | +| `numResults` | number | No | Number of similar links to return \(e.g., 5, 10, 25\). Default: 10, max: 25 | | `text` | boolean | No | Whether to include the full text of the similar pages | -| `includeDomains` | string | No | Comma-separated list of domains to include in results | -| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results | +| `includeDomains` | string | No | Comma-separated list of domains to include in results \(e.g., "github.com, stackoverflow.com"\) | +| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results \(e.g., "reddit.com, pinterest.com"\) | | `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) | | `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) | | `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) | diff --git a/apps/docs/content/docs/en/tools/firecrawl.mdx b/apps/docs/content/docs/en/tools/firecrawl.mdx index e109e93a7..bbcc1d01f 100644 --- a/apps/docs/content/docs/en/tools/firecrawl.mdx +++ b/apps/docs/content/docs/en/tools/firecrawl.mdx @@ -50,7 +50,7 @@ Extract structured content from web pages with comprehensive metadata support. C | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | The URL to scrape content from | +| `url` | string | Yes | The URL to scrape content from \(e.g., "https://example.com/page"\) | | `scrapeOptions` | json | No | Options for content scraping | | `apiKey` | string | Yes | Firecrawl API key | @@ -115,8 +115,12 @@ Crawl entire websites and extract structured content from all accessible pages | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | The website URL to crawl | -| `limit` | number | No | Maximum number of pages to crawl \(default: 100\) | +| `url` | string | Yes | The website URL to crawl \(e.g., "https://example.com" or "https://docs.example.com/guide"\) | +| `limit` | number | No | Maximum number of pages to crawl \(e.g., 50, 100, 500\). Default: 100 | +| `maxDepth` | number | No | Maximum depth to crawl from the starting URL \(e.g., 1, 2, 3\). Controls how many levels deep to follow links | +| `formats` | json | No | Output formats for scraped content \(e.g., \["markdown"\], \["markdown", "html"\], \["markdown", "links"\]\) | +| `excludePaths` | json | No | URL paths to exclude from crawling \(e.g., \["/blog/*", "/admin/*", "/*.pdf"\]\) | +| `includePaths` | json | No | URL paths to include in crawling \(e.g., \["/docs/*", "/api/*"\]\). Only these paths will be crawled | | `onlyMainContent` | boolean | No | Extract only main content from pages | | `apiKey` | string | Yes | Firecrawl API Key | @@ -148,12 +152,12 @@ Get a complete list of URLs from any website quickly and reliably. Useful for di | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | The base URL to map and discover links from | +| `url` | string | Yes | The base URL to map and discover links from \(e.g., "https://example.com"\) | | `search` | string | No | Filter results by relevance to a search term \(e.g., "blog"\) | | `sitemap` | string | No | Controls sitemap usage: "skip", "include" \(default\), or "only" | | `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) | | `ignoreQueryParameters` | boolean | No | Exclude URLs containing query strings \(default: true\) | -| `limit` | number | No | Maximum number of links to return \(max: 100,000, default: 5,000\) | +| `limit` | number | No | Maximum number of links to return \(e.g., 100, 1000, 5000\). Max: 100,000, default: 5,000 | | `timeout` | number | No | Request timeout in milliseconds | | `location` | json | No | Geographic context for proxying \(country, languages\) | | `apiKey` | string | Yes | Firecrawl API key | @@ -173,7 +177,7 @@ Extract structured data from entire webpages using natural language prompts and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `urls` | json | Yes | Array of URLs to extract data from \(supports glob format\) | +| `urls` | json | Yes | Array of URLs to extract data from \(e.g., \["https://example.com/page1", "https://example.com/page2"\] or \["https://example.com/*"\]\) | | `prompt` | string | No | Natural language guidance for the extraction process | | `schema` | json | No | JSON Schema defining the structure of data to extract | | `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) | @@ -200,7 +204,7 @@ Autonomous web data extraction agent. Searches and gathers information based on | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `prompt` | string | Yes | Natural language description of the data to extract \(max 10,000 characters\) | -| `urls` | json | No | Optional array of URLs to focus the agent on | +| `urls` | json | No | Optional array of URLs to focus the agent on \(e.g., \["https://example.com", "https://docs.example.com"\]\) | | `schema` | json | No | JSON Schema defining the structure of data to extract | | `maxCredits` | number | No | Maximum credits to spend on this agent task | | `strictConstrainToURLs` | boolean | No | If true, agent will only visit URLs provided in the urls array | diff --git a/apps/docs/content/docs/en/tools/fireflies.mdx b/apps/docs/content/docs/en/tools/fireflies.mdx index 1b7172beb..2445a2167 100644 --- a/apps/docs/content/docs/en/tools/fireflies.mdx +++ b/apps/docs/content/docs/en/tools/fireflies.mdx @@ -44,13 +44,13 @@ List meeting transcripts from Fireflies.ai with optional filtering | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Fireflies API key | -| `keyword` | string | No | Search keyword in meeting title or transcript | +| `keyword` | string | No | Search keyword in meeting title or transcript \(e.g., "quarterly review"\) | | `fromDate` | string | No | Filter transcripts from this date \(ISO 8601 format\) | | `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) | | `hostEmail` | string | No | Filter by meeting host email | | `participants` | string | No | Filter by participant emails \(comma-separated\) | -| `limit` | number | No | Maximum number of transcripts to return \(max 50\) | -| `skip` | number | No | Number of transcripts to skip for pagination | +| `limit` | number | No | Maximum number of transcripts to return \(e.g., 10, max 50\) | +| `skip` | number | No | Number of transcripts to skip for pagination \(e.g., 0, 10, 20\) | #### Output @@ -68,7 +68,7 @@ Get a single transcript with full details including summary, action items, and a | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Fireflies API key | -| `transcriptId` | string | Yes | The transcript ID to retrieve | +| `transcriptId` | string | Yes | The transcript ID to retrieve \(e.g., "abc123def456"\) | #### Output @@ -97,7 +97,7 @@ Get user information from Fireflies.ai. Returns current user if no ID specified. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Fireflies API key | -| `userId` | string | No | User ID to retrieve \(optional, defaults to API key owner\) | +| `userId` | string | No | User ID to retrieve \(e.g., "user_abc123", defaults to API key owner\) | #### Output @@ -164,7 +164,7 @@ Delete a transcript from Fireflies.ai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Fireflies API key | -| `transcriptId` | string | Yes | The transcript ID to delete | +| `transcriptId` | string | Yes | The transcript ID to delete \(e.g., "abc123def456"\) | #### Output @@ -202,7 +202,7 @@ Create a soundbite/highlight from a specific time range in a transcript | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Fireflies API key | -| `transcriptId` | string | Yes | ID of the transcript to create the bite from | +| `transcriptId` | string | Yes | ID of the transcript to create the bite from \(e.g., "abc123def456"\) | | `startTime` | number | Yes | Start time of the bite in seconds | | `endTime` | number | Yes | End time of the bite in seconds | | `name` | string | No | Name for the bite \(max 256 characters\) | @@ -227,10 +227,10 @@ List soundbites/highlights from Fireflies.ai | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Fireflies API key | -| `transcriptId` | string | No | Filter bites for a specific transcript | +| `transcriptId` | string | No | Filter bites for a specific transcript \(e.g., "abc123def456"\) | | `mine` | boolean | No | Only return bites owned by the API key owner \(default: true\) | -| `limit` | number | No | Maximum number of bites to return \(max 50\) | -| `skip` | number | No | Number of bites to skip for pagination | +| `limit` | number | No | Maximum number of bites to return \(e.g., 10, max 50\) | +| `skip` | number | No | Number of bites to skip for pagination \(e.g., 0, 10, 20\) | #### Output diff --git a/apps/docs/content/docs/en/tools/gmail.mdx b/apps/docs/content/docs/en/tools/gmail.mdx index 6f893ce0f..8eb78c6de 100644 --- a/apps/docs/content/docs/en/tools/gmail.mdx +++ b/apps/docs/content/docs/en/tools/gmail.mdx @@ -96,11 +96,11 @@ Read emails from Gmail. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `messageId` | string | No | ID of the message to read | -| `folder` | string | No | Folder/label to read emails from | -| `unreadOnly` | boolean | No | Only retrieve unread messages | +| `messageId` | string | No | Gmail message ID to read \(e.g., 18f1a2b3c4d5e6f7\) | +| `folder` | string | No | Folder/label to read emails from \(e.g., INBOX, SENT, DRAFT, TRASH, SPAM, or custom label name\) | +| `unreadOnly` | boolean | No | Set to true to only retrieve unread messages | | `maxResults` | number | No | Maximum number of messages to retrieve \(default: 1, max: 10\) | -| `includeAttachments` | boolean | No | Download and include email attachments | +| `includeAttachments` | boolean | No | Set to true to download and include email attachments | #### Output @@ -128,7 +128,7 @@ Search emails in Gmail. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `query` | string | Yes | Search query for emails | -| `maxResults` | number | No | Maximum number of results to return | +| `maxResults` | number | No | Maximum number of results to return \(e.g., 10, 25, 50\) | #### Output diff --git a/apps/docs/content/docs/en/tools/google_calendar.mdx b/apps/docs/content/docs/en/tools/google_calendar.mdx index 57d5df967..875b56d5d 100644 --- a/apps/docs/content/docs/en/tools/google_calendar.mdx +++ b/apps/docs/content/docs/en/tools/google_calendar.mdx @@ -44,7 +44,7 @@ Create a new event in Google Calendar. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `summary` | string | Yes | Event title/summary | | `description` | string | No | Event description | | `location` | string | No | Event location | @@ -78,7 +78,7 @@ List events from Google Calendar. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `timeMin` | string | No | Lower bound for events \(RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z\) | | `timeMax` | string | No | Upper bound for events \(RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z\) | | `orderBy` | string | No | Order of events returned \(startTime or updated\) | @@ -100,8 +100,8 @@ Get a specific event from Google Calendar. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | -| `eventId` | string | Yes | Event ID to retrieve | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | +| `eventId` | string | Yes | Google Calendar event ID to retrieve | #### Output @@ -127,8 +127,8 @@ Update an existing event in Google Calendar. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | -| `eventId` | string | Yes | Event ID to update | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | +| `eventId` | string | Yes | Google Calendar event ID to update | | `summary` | string | No | New event title/summary | | `description` | string | No | New event description | | `location` | string | No | New event location | @@ -162,8 +162,8 @@ Delete an event from Google Calendar. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | -| `eventId` | string | Yes | Event ID to delete | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | +| `eventId` | string | Yes | Google Calendar event ID to delete | | `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | #### Output @@ -181,9 +181,9 @@ Move an event to a different calendar. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Source calendar ID \(defaults to primary\) | -| `eventId` | string | Yes | Event ID to move | -| `destinationCalendarId` | string | Yes | Destination calendar ID | +| `calendarId` | string | No | Source Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | +| `eventId` | string | Yes | Google Calendar event ID to move | +| `destinationCalendarId` | string | Yes | Destination Google Calendar ID | | `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | #### Output @@ -210,7 +210,7 @@ Get instances of a recurring event from Google Calendar. Returns API-aligned fie | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `eventId` | string | Yes | Recurring event ID to get instances of | | `timeMin` | string | No | Lower bound for instances \(RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z\) | | `timeMax` | string | No | Upper bound for instances \(RFC3339 timestamp, e.g., 2025-06-04T00:00:00Z\) | @@ -266,7 +266,7 @@ Create events from natural language text. Returns API-aligned fields only. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `text` | string | Yes | Natural language text describing the event \(e.g., "Meeting with John tomorrow at 3pm"\) | | `attendees` | array | No | Array of attendee email addresses \(comma-separated string also accepted\) | | `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | @@ -295,8 +295,8 @@ Invite attendees to an existing Google Calendar event. Returns API-aligned field | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `calendarId` | string | No | Calendar ID \(defaults to primary\) | -| `eventId` | string | Yes | Event ID to invite attendees to | +| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | +| `eventId` | string | Yes | Google Calendar event ID to invite attendees to | | `attendees` | array | Yes | Array of attendee email addresses to invite | | `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | | `replaceExisting` | boolean | No | Whether to replace existing attendees or add to them \(defaults to false\) | diff --git a/apps/docs/content/docs/en/tools/google_docs.mdx b/apps/docs/content/docs/en/tools/google_docs.mdx index 5b2f55fac..02d55b6dd 100644 --- a/apps/docs/content/docs/en/tools/google_docs.mdx +++ b/apps/docs/content/docs/en/tools/google_docs.mdx @@ -79,7 +79,7 @@ Read content from a Google Docs document | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `documentId` | string | Yes | The ID of the document to read | +| `documentId` | string | Yes | Google Docs document ID | #### Output @@ -124,7 +124,7 @@ Create a new Google Docs document | --------- | ---- | -------- | ----------- | | `title` | string | Yes | The title of the document to create | | `content` | string | No | The content of the document to create | -| `folderSelector` | string | No | Select the folder to create the document in | +| `folderSelector` | string | No | Google Drive folder ID to create the document in \(e.g., 1ABCxyz...\) | | `folderId` | string | No | The ID of the folder to create the document in \(internal use\) | #### Output diff --git a/apps/docs/content/docs/en/tools/google_drive.mdx b/apps/docs/content/docs/en/tools/google_drive.mdx index 39547b4f6..8aca5fc9e 100644 --- a/apps/docs/content/docs/en/tools/google_drive.mdx +++ b/apps/docs/content/docs/en/tools/google_drive.mdx @@ -54,7 +54,7 @@ List files and folders in Google Drive with complete metadata | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `folderSelector` | string | No | Select the folder to list files from | +| `folderSelector` | string | No | Google Drive folder ID to list files from \(e.g., 1ABCxyz...\) | | `folderId` | string | No | The ID of the folder to list files from \(internal use\) | | `query` | string | No | Search term to filter files by name \(e.g. "budget" finds files with "budget" in the name\). Do NOT use Google Drive query syntax here - just provide a plain search term. | | `pageSize` | number | No | The maximum number of files to return \(default: 100\) | @@ -167,7 +167,7 @@ Create a new folder in Google Drive with complete metadata returned | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `fileName` | string | Yes | Name of the folder to create | -| `folderSelector` | string | No | Select the parent folder to create the folder in | +| `folderSelector` | string | No | Google Drive parent folder ID to create the folder in \(e.g., 1ABCxyz...\) | | `folderId` | string | No | ID of the parent folder \(internal use\) | #### Output @@ -225,7 +225,7 @@ Upload a file to Google Drive with complete metadata returned | `file` | file | No | Binary file to upload \(UserFile object\) | | `content` | string | No | Text content to upload \(use this OR file, not both\) | | `mimeType` | string | No | The MIME type of the file to upload \(auto-detected from file if not provided\) | -| `folderSelector` | string | No | Select the folder to upload the file to | +| `folderSelector` | string | No | Google Drive folder ID to upload the file to \(e.g., 1ABCxyz...\) | | `folderId` | string | No | The ID of the folder to upload the file to \(internal use\) | #### Output diff --git a/apps/docs/content/docs/en/tools/google_forms.mdx b/apps/docs/content/docs/en/tools/google_forms.mdx index 8e73de385..fd463521f 100644 --- a/apps/docs/content/docs/en/tools/google_forms.mdx +++ b/apps/docs/content/docs/en/tools/google_forms.mdx @@ -43,8 +43,8 @@ Retrieve a single response or list responses from a Google Form | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form | -| `responseId` | string | No | If provided, returns this specific response | +| `formId` | string | Yes | Google Forms form ID | +| `responseId` | string | No | Response ID - if provided, returns this specific response | | `pageSize` | number | No | Maximum number of responses to return \(service may return fewer\). Defaults to 5000. | #### Output @@ -71,7 +71,7 @@ Retrieve a form structure including its items, settings, and metadata | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form to retrieve | +| `formId` | string | Yes | Google Forms form ID to retrieve | #### Output @@ -121,7 +121,7 @@ Apply multiple updates to a form (add items, update info, change settings, etc.) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form to update | +| `formId` | string | Yes | Google Forms form ID | | `requests` | json | Yes | Array of update requests \(updateFormInfo, updateSettings, createItem, updateItem, moveItem, deleteItem\) | | `includeFormInResponse` | boolean | No | Whether to return the updated form in the response | @@ -159,7 +159,7 @@ Update the publish settings of a form (publish/unpublish, accept responses) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form | +| `formId` | string | Yes | Google Forms form ID | | `isPublished` | boolean | Yes | Whether the form is published and visible to others | | `isAcceptingResponses` | boolean | No | Whether the form accepts responses \(forced to false if isPublished is false\) | @@ -181,7 +181,7 @@ Create a notification watch for form changes (schema changes or new responses) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form to watch | +| `formId` | string | Yes | Google Forms form ID to watch | | `eventType` | string | Yes | Event type to watch: SCHEMA \(form changes\) or RESPONSES \(new submissions\) | | `topicName` | string | Yes | The Cloud Pub/Sub topic name \(format: projects/\{project\}/topics/\{topic\}\) | | `watchId` | string | No | Custom watch ID \(4-63 chars, lowercase letters, numbers, hyphens\) | @@ -205,7 +205,7 @@ List all notification watches for a form | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form | +| `formId` | string | Yes | Google Forms form ID | #### Output @@ -226,8 +226,8 @@ Delete a notification watch from a form | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form | -| `watchId` | string | Yes | The ID of the watch to delete | +| `formId` | string | Yes | Google Forms form ID | +| `watchId` | string | Yes | Watch ID to delete | #### Output @@ -243,8 +243,8 @@ Renew a notification watch for another 7 days | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | The ID of the Google Form | -| `watchId` | string | Yes | The ID of the watch to renew | +| `formId` | string | Yes | Google Forms form ID | +| `watchId` | string | Yes | Watch ID to renew | #### Output diff --git a/apps/docs/content/docs/en/tools/google_groups.mdx b/apps/docs/content/docs/en/tools/google_groups.mdx index 053dffc71..61b44ae62 100644 --- a/apps/docs/content/docs/en/tools/google_groups.mdx +++ b/apps/docs/content/docs/en/tools/google_groups.mdx @@ -28,8 +28,8 @@ List all groups in a Google Workspace domain | --------- | ---- | -------- | ----------- | | `customer` | string | No | Customer ID or "my_customer" for the authenticated user\'s domain | | `domain` | string | No | Domain name to filter groups by | -| `maxResults` | number | No | Maximum number of results to return \(1-200\) | -| `pageToken` | string | No | Token for pagination | +| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 | +| `pageToken` | string | No | Token for fetching the next page of results | | `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) | #### Output @@ -47,7 +47,7 @@ Get details of a specific Google Group by email or group ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | #### Output @@ -63,8 +63,8 @@ Create a new Google Group in the domain | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `email` | string | Yes | Email address for the new group \(e.g., team@yourdomain.com\) | -| `name` | string | Yes | Display name for the group | +| `email` | string | Yes | Email address for the new group \(e.g., team@example.com\) | +| `name` | string | Yes | Display name for the group \(e.g., Engineering Team\) | | `description` | string | No | Description of the group | #### Output @@ -81,10 +81,10 @@ Update an existing Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `name` | string | No | New display name for the group | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `name` | string | No | New display name for the group \(e.g., Engineering Team\) | | `description` | string | No | New description for the group | -| `email` | string | No | New email address for the group | +| `email` | string | No | New email address for the group \(e.g., newteam@example.com\) | #### Output @@ -100,7 +100,7 @@ Delete a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID to delete | +| `groupKey` | string | Yes | Group identifier to delete. Can be the group email address \(e.g., team@example.com\) or the unique group ID | #### Output @@ -116,9 +116,9 @@ List all members of a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `maxResults` | number | No | Maximum number of results to return \(1-200\) | -| `pageToken` | string | No | Token for pagination | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 | +| `pageToken` | string | No | Token for fetching the next page of results | | `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) | #### Output @@ -136,8 +136,8 @@ Get details of a specific member in a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `memberKey` | string | Yes | Member email address or unique member ID | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID | #### Output @@ -153,9 +153,9 @@ Add a new member to a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `email` | string | Yes | Email address of the member to add | -| `role` | string | No | Role for the member \(MEMBER, MANAGER, or OWNER\). Defaults to MEMBER. | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `email` | string | Yes | Email address of the member to add \(e.g., user@example.com\) | +| `role` | string | No | Role for the member: MEMBER, MANAGER, or OWNER. Defaults to MEMBER | #### Output @@ -171,8 +171,8 @@ Remove a member from a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `memberKey` | string | Yes | Email address or unique ID of the member to remove | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `memberKey` | string | Yes | Member identifier to remove. Can be the member email address \(e.g., user@example.com\) or the unique member ID | #### Output @@ -188,9 +188,9 @@ Update a member | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `memberKey` | string | Yes | Member email address or unique member ID | -| `role` | string | Yes | New role for the member \(MEMBER, MANAGER, or OWNER\) | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID | +| `role` | string | Yes | New role for the member: MEMBER, MANAGER, or OWNER | #### Output @@ -206,8 +206,8 @@ Check if a user is a member of a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | -| `memberKey` | string | Yes | Member email address or unique member ID to check | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | +| `memberKey` | string | Yes | Member identifier to check. Can be the member email address \(e.g., user@example.com\) or the unique member ID | #### Output @@ -223,7 +223,7 @@ List all email aliases for a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | #### Output @@ -244,7 +244,7 @@ Add an email alias to a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `alias` | string | Yes | The email alias to add to the group | #### Output @@ -265,7 +265,7 @@ Remove an email alias from a Google Group | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupKey` | string | Yes | Group email address or unique group ID | +| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `alias` | string | Yes | The email alias to remove from the group | #### Output @@ -282,7 +282,7 @@ Get the settings for a Google Group including access permissions, moderation, an | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupEmail` | string | Yes | The email address of the group | +| `groupEmail` | string | Yes | The email address of the group \(e.g., team@example.com\) | #### Output @@ -330,7 +330,7 @@ Update the settings for a Google Group including access permissions, moderation, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `groupEmail` | string | Yes | The email address of the group | +| `groupEmail` | string | Yes | The email address of the group \(e.g., team@example.com\) | | `name` | string | No | The group name \(max 75 characters\) | | `description` | string | No | The group description \(max 4096 characters\) | | `whoCanJoin` | string | No | Who can join: ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN | diff --git a/apps/docs/content/docs/en/tools/google_sheets.mdx b/apps/docs/content/docs/en/tools/google_sheets.mdx index 0325f1d5e..bf034e016 100644 --- a/apps/docs/content/docs/en/tools/google_sheets.mdx +++ b/apps/docs/content/docs/en/tools/google_sheets.mdx @@ -144,7 +144,7 @@ Clear values from a specific range in a Google Sheets spreadsheet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet | +| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `sheetName` | string | Yes | The name of the sheet/tab to clear | | `cellRange` | string | No | The cell range to clear \(e.g. "A1:D10"\). Clears entire sheet if not specified. | @@ -166,7 +166,7 @@ Get metadata about a Google Sheets spreadsheet including title and sheet list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet | +| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `includeGridData` | boolean | No | Whether to include grid data \(cell values\). Defaults to false. | #### Output @@ -219,7 +219,7 @@ Read multiple ranges from a Google Sheets spreadsheet in a single request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet | +| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `ranges` | json | Yes | Array of ranges to read \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. | | `majorDimension` | string | No | The major dimension of values: "ROWS" \(default\) or "COLUMNS" | | `valueRenderOption` | string | No | How values should be rendered: "FORMATTED_VALUE" \(default\), "UNFORMATTED_VALUE", or "FORMULA" | @@ -245,7 +245,7 @@ Update multiple ranges in a Google Sheets spreadsheet in a single request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet | +| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `data` | json | Yes | Array of value ranges to update. Each item should have "range" \(e.g., "Sheet1!A1:D10"\) and "values" \(2D array\). | | `valueInputOption` | string | No | How input data should be interpreted: "RAW" or "USER_ENTERED" \(default\). USER_ENTERED parses formulas. | @@ -276,7 +276,7 @@ Clear multiple ranges in a Google Sheets spreadsheet in a single request | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet | +| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `ranges` | json | Yes | Array of ranges to clear \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. | #### Output @@ -297,7 +297,7 @@ Copy a sheet from one spreadsheet to another | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `sourceSpreadsheetId` | string | Yes | The ID of the source spreadsheet | +| `sourceSpreadsheetId` | string | Yes | Source Google Sheets spreadsheet ID | | `sheetId` | number | Yes | The ID of the sheet to copy \(numeric ID, not the sheet name\). Use Get Spreadsheet to find sheet IDs. | | `destinationSpreadsheetId` | string | Yes | The ID of the destination spreadsheet where the sheet will be copied | diff --git a/apps/docs/content/docs/en/tools/google_slides.mdx b/apps/docs/content/docs/en/tools/google_slides.mdx index 1c852b797..57cd9e845 100644 --- a/apps/docs/content/docs/en/tools/google_slides.mdx +++ b/apps/docs/content/docs/en/tools/google_slides.mdx @@ -44,7 +44,7 @@ Read content from a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation to read | +| `presentationId` | string | Yes | Google Slides presentation ID | #### Output @@ -68,7 +68,7 @@ Write or update content in a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation to write to | +| `presentationId` | string | Yes | Google Slides presentation ID | | `content` | string | Yes | The content to write to the slide | | `slideIndex` | number | No | The index of the slide to write to \(defaults to first slide\) | @@ -93,7 +93,7 @@ Create a new Google Slides presentation | --------- | ---- | -------- | ----------- | | `title` | string | Yes | The title of the presentation to create | | `content` | string | No | The content to add to the first slide | -| `folderSelector` | string | No | Select the folder to create the presentation in | +| `folderSelector` | string | No | Google Drive folder ID to create the presentation in \(e.g., 1ABCxyz...\) | | `folderId` | string | No | The ID of the folder to create the presentation in \(internal use\) | #### Output @@ -114,7 +114,7 @@ Find and replace all occurrences of text throughout a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `findText` | string | Yes | The text to find \(e.g., \{\{placeholder\}\}\) | | `replaceText` | string | Yes | The text to replace with | | `matchCase` | boolean | No | Whether the search should be case-sensitive \(default: true\) | @@ -139,7 +139,7 @@ Add a new slide to a Google Slides presentation with a specified layout | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `layout` | string | No | The predefined layout for the slide \(BLANK, TITLE, TITLE_AND_BODY, TITLE_ONLY, SECTION_HEADER, etc.\). Defaults to BLANK. | | `insertionIndex` | number | No | The optional zero-based index indicating where to insert the slide. If not specified, the slide is added at the end. | | `placeholderIdMappings` | string | No | JSON array of placeholder mappings to assign custom object IDs to placeholders. Format: \[\{"layoutPlaceholder":\{"type":"TITLE"\},"objectId":"custom_title_id"\}\] | @@ -163,7 +163,7 @@ Insert an image into a specific slide in a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `pageObjectId` | string | Yes | The object ID of the slide/page to add the image to | | `imageUrl` | string | Yes | The publicly accessible URL of the image \(must be PNG, JPEG, or GIF, max 50MB\) | | `width` | number | No | Width of the image in points \(default: 300\) | @@ -190,7 +190,7 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `pageObjectId` | string | Yes | The object ID of the slide/page to get a thumbnail for | | `thumbnailSize` | string | No | The size of the thumbnail: SMALL \(200px\), MEDIUM \(800px\), or LARGE \(1600px\). Defaults to MEDIUM. | | `mimeType` | string | No | The MIME type of the thumbnail image: PNG or GIF. Defaults to PNG. | @@ -216,7 +216,7 @@ Get detailed information about a specific slide/page in a Google Slides presenta | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `pageObjectId` | string | Yes | The object ID of the slide/page to retrieve | #### Output @@ -242,7 +242,7 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `objectId` | string | Yes | The object ID of the element or slide to delete | #### Output @@ -263,7 +263,7 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `objectId` | string | Yes | The object ID of the element or slide to duplicate | | `objectIds` | string | No | Optional JSON object mapping source object IDs \(within the slide being duplicated\) to new object IDs for the duplicates. Format: \{"sourceId1":"newId1","sourceId2":"newId2"\} | | `Format` | string | No | No description | @@ -286,7 +286,7 @@ Move one or more slides to a new position in a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `slideObjectIds` | string | Yes | Comma-separated list of slide object IDs to move. The slides will maintain their relative order. | | `insertionIndex` | number | Yes | The zero-based index where the slides should be moved. All slides with indices greater than or equal to this will be shifted right. | @@ -309,7 +309,7 @@ Create a new table on a slide in a Google Slides presentation | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `pageObjectId` | string | Yes | The object ID of the slide/page to add the table to | | `rows` | number | Yes | Number of rows in the table \(minimum 1\) | | `columns` | number | Yes | Number of columns in the table \(minimum 1\) | @@ -338,7 +338,7 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `pageObjectId` | string | Yes | The object ID of the slide/page to add the shape to | | `shapeType` | string | Yes | The type of shape to create. Common types: TEXT_BOX, RECTANGLE, ROUND_RECTANGLE, ELLIPSE, TRIANGLE, DIAMOND, STAR_5, ARROW_EAST, HEART, CLOUD | | `width` | number | No | Width of the shape in points \(default: 200\) | @@ -365,7 +365,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `presentationId` | string | Yes | The ID of the presentation | +| `presentationId` | string | Yes | Google Slides presentation ID | | `objectId` | string | Yes | The object ID of the shape or table cell to insert text into. For table cells, use the cell object ID. | | `text` | string | Yes | The text to insert | | `insertionIndex` | number | No | The zero-based index at which to insert the text. If not specified, text is inserted at the beginning \(index 0\). | diff --git a/apps/docs/content/docs/en/tools/google_vault.mdx b/apps/docs/content/docs/en/tools/google_vault.mdx index d6e39c51e..ebbec02e5 100644 --- a/apps/docs/content/docs/en/tools/google_vault.mdx +++ b/apps/docs/content/docs/en/tools/google_vault.mdx @@ -42,14 +42,14 @@ Create an export in a matter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `matterId` | string | Yes | The matter ID | +| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `exportName` | string | Yes | Name for the export \(avoid special characters\) | | `corpus` | string | Yes | Data corpus to export \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) | -| `accountEmails` | string | No | Comma-separated list of user emails to scope export | -| `orgUnitId` | string | No | Organization unit ID to scope export \(alternative to emails\) | -| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., 2024-01-01T00:00:00Z\) | -| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., 2024-12-31T23:59:59Z\) | -| `terms` | string | No | Search query terms to filter exported content | +| `accountEmails` | string | No | Comma-separated list of user emails to scope export \(e.g., "user1@example.com, user2@example.com"\) | +| `orgUnitId` | string | No | Organization unit ID to scope export \(e.g., "id:03ph8a2z1enx5q0", alternative to emails\) | +| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., "2024-01-01T00:00:00Z"\) | +| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., "2024-12-31T23:59:59Z"\) | +| `terms` | string | No | Search query terms to filter exported content \(e.g., "from:sender@example.com subject:invoice"\) | #### Output @@ -65,10 +65,10 @@ List exports for a matter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `matterId` | string | Yes | The matter ID | +| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `pageSize` | number | No | Number of exports to return per page | | `pageToken` | string | No | Token for pagination | -| `exportId` | string | No | Optional export ID to fetch a specific export | +| `exportId` | string | No | Optional export ID to fetch a specific export \(e.g., "exportId123456"\) | #### Output @@ -86,7 +86,7 @@ Download a single file from a Google Vault export (GCS object) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `matterId` | string | Yes | The matter ID | +| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName | | `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName | | `fileName` | string | No | Optional filename override for the downloaded file | @@ -105,14 +105,14 @@ Create a hold in a matter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `matterId` | string | Yes | The matter ID | +| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `holdName` | string | Yes | Name for the hold | | `corpus` | string | Yes | Data corpus to hold \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) | -| `accountEmails` | string | No | Comma-separated list of user emails to put on hold | -| `orgUnitId` | string | No | Organization unit ID to put on hold \(alternative to accounts\) | -| `terms` | string | No | Search terms to filter held content \(for MAIL and GROUPS corpus\) | -| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) | -| `endTime` | string | No | End time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) | +| `accountEmails` | string | No | Comma-separated list of user emails to put on hold \(e.g., "user1@example.com, user2@example.com"\) | +| `orgUnitId` | string | No | Organization unit ID to put on hold \(e.g., "id:03ph8a2z1enx5q0", alternative to accounts\) | +| `terms` | string | No | Search terms to filter held content \(e.g., "from:sender@example.com subject:invoice", for MAIL and GROUPS corpus\) | +| `startTime` | string | No | Start time for date filtering \(ISO 8601 format, e.g., "2024-01-01T00:00:00Z", for MAIL and GROUPS corpus\) | +| `endTime` | string | No | End time for date filtering \(ISO 8601 format, e.g., "2024-12-31T23:59:59Z", for MAIL and GROUPS corpus\) | | `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) | #### Output @@ -129,10 +129,10 @@ List holds for a matter | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `matterId` | string | Yes | The matter ID | +| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `pageSize` | number | No | Number of holds to return per page | | `pageToken` | string | No | Token for pagination | -| `holdId` | string | No | Optional hold ID to fetch a specific hold | +| `holdId` | string | No | Optional hold ID to fetch a specific hold \(e.g., "holdId123456"\) | #### Output @@ -169,7 +169,7 @@ List matters, or get a specific matter if matterId is provided | --------- | ---- | -------- | ----------- | | `pageSize` | number | No | Number of matters to return per page | | `pageToken` | string | No | Token for pagination | -| `matterId` | string | No | Optional matter ID to fetch a specific matter | +| `matterId` | string | No | Optional matter ID to fetch a specific matter \(e.g., "12345678901234567890"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/grafana.mdx b/apps/docs/content/docs/en/tools/grafana.mdx index f50cd21cc..f3d0b6320 100644 --- a/apps/docs/content/docs/en/tools/grafana.mdx +++ b/apps/docs/content/docs/en/tools/grafana.mdx @@ -48,8 +48,8 @@ Get a dashboard by its UID | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | -| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | +| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve \(e.g., abc123def\) | #### Output @@ -68,10 +68,10 @@ Search and list all dashboards | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `query` | string | No | Search query to filter dashboards by title | | `tag` | string | No | Filter by tag \(comma-separated for multiple tags\) | -| `folderIds` | string | No | Filter by folder IDs \(comma-separated\) | +| `folderIds` | string | No | Filter by folder IDs \(comma-separated, e.g., 1,2,3\) | | `starred` | boolean | No | Only return starred dashboards | | `limit` | number | No | Maximum number of dashboards to return | @@ -97,9 +97,9 @@ Create a new dashboard | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `title` | string | Yes | The title of the new dashboard | -| `folderUid` | string | No | The UID of the folder to create the dashboard in | +| `folderUid` | string | No | The UID of the folder to create the dashboard in \(e.g., folder-abc123\) | | `tags` | string | No | Comma-separated list of tags | | `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) | | `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) | @@ -128,10 +128,10 @@ Update an existing dashboard. Fetches the current dashboard and merges your chan | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | -| `dashboardUid` | string | Yes | The UID of the dashboard to update | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | +| `dashboardUid` | string | Yes | The UID of the dashboard to update \(e.g., abc123def\) | | `title` | string | No | New title for the dashboard | -| `folderUid` | string | No | New folder UID to move the dashboard to | +| `folderUid` | string | No | New folder UID to move the dashboard to \(e.g., folder-abc123\) | | `tags` | string | No | Comma-separated list of new tags | | `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) | | `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) | @@ -160,8 +160,8 @@ Delete a dashboard by its UID | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | -| `dashboardUid` | string | Yes | The UID of the dashboard to delete | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | +| `dashboardUid` | string | Yes | The UID of the dashboard to delete \(e.g., abc123def\) | #### Output @@ -181,7 +181,7 @@ List all alert rules in the Grafana instance | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | #### Output @@ -206,7 +206,7 @@ Get a specific alert rule by its UID | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `alertRuleUid` | string | Yes | The UID of the alert rule to retrieve | #### Output @@ -234,9 +234,9 @@ Create a new alert rule | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `title` | string | Yes | The title of the alert rule | -| `folderUid` | string | Yes | The UID of the folder to create the alert in | +| `folderUid` | string | Yes | The UID of the folder to create the alert in \(e.g., folder-abc123\) | | `ruleGroup` | string | Yes | The name of the rule group | | `condition` | string | Yes | The refId of the query or expression to use as the alert condition | | `data` | string | Yes | JSON array of query/expression data objects | @@ -265,10 +265,10 @@ Update an existing alert rule. Fetches the current rule and merges your changes. | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `alertRuleUid` | string | Yes | The UID of the alert rule to update | | `title` | string | No | New title for the alert rule | -| `folderUid` | string | No | New folder UID to move the alert to | +| `folderUid` | string | No | New folder UID to move the alert to \(e.g., folder-abc123\) | | `ruleGroup` | string | No | New rule group name | | `condition` | string | No | New condition refId | | `data` | string | No | New JSON array of query/expression data objects | @@ -297,7 +297,7 @@ Delete an alert rule by its UID | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `alertRuleUid` | string | Yes | The UID of the alert rule to delete | #### Output @@ -316,7 +316,7 @@ List all alert notification contact points | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | #### Output @@ -338,13 +338,13 @@ Create an annotation on a dashboard or as a global annotation | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `text` | string | Yes | The text content of the annotation | | `tags` | string | No | Comma-separated list of tags | -| `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to | -| `panelId` | number | No | ID of the panel to add the annotation to | -| `time` | number | No | Start time in epoch milliseconds \(defaults to now\) | -| `timeEnd` | number | No | End time in epoch milliseconds \(for range annotations\) | +| `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to \(e.g., abc123def\) | +| `panelId` | number | No | ID of the panel to add the annotation to \(e.g., 1, 2\) | +| `time` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000, defaults to now\) | +| `timeEnd` | number | No | End time in epoch milliseconds for range annotations \(e.g., 1704153600000\) | #### Output @@ -363,11 +363,11 @@ Query annotations by time range, dashboard, or tags | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | -| `from` | number | No | Start time in epoch milliseconds | -| `to` | number | No | End time in epoch milliseconds | -| `dashboardUid` | string | Yes | Dashboard UID to query annotations from | -| `panelId` | number | No | Filter by panel ID | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | +| `from` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000\) | +| `to` | number | No | End time in epoch milliseconds \(e.g., 1704153600000\) | +| `dashboardUid` | string | Yes | Dashboard UID to query annotations from \(e.g., abc123def\) | +| `panelId` | number | No | Filter by panel ID \(e.g., 1, 2\) | | `tags` | string | No | Comma-separated list of tags to filter by | | `type` | string | No | Filter by type \(alert or annotation\) | | `limit` | number | No | Maximum number of annotations to return | @@ -401,12 +401,12 @@ Update an existing annotation | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `annotationId` | number | Yes | The ID of the annotation to update | | `text` | string | Yes | New text content for the annotation | | `tags` | string | No | Comma-separated list of new tags | -| `time` | number | No | New start time in epoch milliseconds | -| `timeEnd` | number | No | New end time in epoch milliseconds | +| `time` | number | No | New start time in epoch milliseconds \(e.g., 1704067200000\) | +| `timeEnd` | number | No | New end time in epoch milliseconds \(e.g., 1704153600000\) | #### Output @@ -425,7 +425,7 @@ Delete an annotation by its ID | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `annotationId` | number | Yes | The ID of the annotation to delete | #### Output @@ -444,7 +444,7 @@ List all data sources configured in Grafana | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | #### Output @@ -468,8 +468,8 @@ Get a data source by its ID or UID | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | -| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | +| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve \(e.g., prometheus, P1234AB5678\) | #### Output @@ -494,7 +494,7 @@ List all folders in Grafana | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `limit` | number | No | Maximum number of folders to return | | `page` | number | No | Page number for pagination | @@ -527,7 +527,7 @@ Create a new folder in Grafana | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grafana Service Account Token | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | -| `organizationId` | string | No | Organization ID for multi-org Grafana instances | +| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `title` | string | Yes | The title of the new folder | | `uid` | string | No | Optional UID for the folder \(auto-generated if not provided\) | diff --git a/apps/docs/content/docs/en/tools/grain.mdx b/apps/docs/content/docs/en/tools/grain.mdx index 3ef69b609..49e77f09a 100644 --- a/apps/docs/content/docs/en/tools/grain.mdx +++ b/apps/docs/content/docs/en/tools/grain.mdx @@ -48,13 +48,13 @@ List recordings from Grain with optional filters and pagination | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | -| `cursor` | string | No | Pagination cursor for next page | -| `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp | -| `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp | +| `cursor` | string | No | Pagination cursor for next page \(returned from previous response\) | +| `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp \(e.g., "2024-01-15T00:00:00Z"\) | +| `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp \(e.g., "2024-01-01T00:00:00Z"\) | | `participantScope` | string | No | Filter: "internal" or "external" | -| `titleSearch` | string | No | Search term to filter by recording title | -| `teamId` | string | No | Filter by team UUID | -| `meetingTypeId` | string | No | Filter by meeting type UUID | +| `titleSearch` | string | No | Search term to filter by recording title \(e.g., "weekly standup"\) | +| `teamId` | string | No | Filter by team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | +| `meetingTypeId` | string | No | Filter by meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `includeHighlights` | boolean | No | Include highlights/clips in response | | `includeParticipants` | boolean | No | Include participant list in response | | `includeAiSummary` | boolean | No | Include AI-generated summary | @@ -87,7 +87,7 @@ Get details of a single recording by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | -| `recordingId` | string | Yes | The recording UUID | +| `recordingId` | string | Yes | The recording UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `includeHighlights` | boolean | No | Include highlights/clips | | `includeParticipants` | boolean | No | Include participant list | | `includeAiSummary` | boolean | No | Include AI summary | @@ -125,7 +125,7 @@ Get the full transcript of a recording | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | -| `recordingId` | string | Yes | The recording UUID | +| `recordingId` | string | Yes | The recording UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | #### Output @@ -184,13 +184,13 @@ Create a webhook to receive recording events | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | -| `hookUrl` | string | Yes | Webhook endpoint URL \(must respond 2xx\) | +| `hookUrl` | string | Yes | Webhook endpoint URL \(e.g., "https://example.com/webhooks/grain"\) | | `hookType` | string | Yes | Type of webhook: "recording_added" or "upload_status" | -| `filterBeforeDatetime` | string | No | Filter: recordings before this date | -| `filterAfterDatetime` | string | No | Filter: recordings after this date | +| `filterBeforeDatetime` | string | No | Filter: recordings before this ISO8601 date \(e.g., "2024-01-15T00:00:00Z"\) | +| `filterAfterDatetime` | string | No | Filter: recordings after this ISO8601 date \(e.g., "2024-01-01T00:00:00Z"\) | | `filterParticipantScope` | string | No | Filter: "internal" or "external" | -| `filterTeamId` | string | No | Filter: specific team UUID | -| `filterMeetingTypeId` | string | No | Filter: specific meeting type | +| `filterTeamId` | string | No | Filter: specific team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | +| `filterMeetingTypeId` | string | No | Filter: specific meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `includeHighlights` | boolean | No | Include highlights in webhook payload | | `includeParticipants` | boolean | No | Include participants in webhook payload | | `includeAiSummary` | boolean | No | Include AI summary in webhook payload | @@ -239,7 +239,7 @@ Delete a webhook by ID | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | -| `hookId` | string | Yes | The hook UUID to delete | +| `hookId` | string | Yes | The hook UUID to delete \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/greptile.mdx b/apps/docs/content/docs/en/tools/greptile.mdx index 86a273773..7132bbb13 100644 --- a/apps/docs/content/docs/en/tools/greptile.mdx +++ b/apps/docs/content/docs/en/tools/greptile.mdx @@ -46,9 +46,9 @@ Query repositories in natural language and get answers with relevant code refere | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | Natural language question about the codebase | -| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\) | -| `sessionId` | string | No | Session ID for conversation continuity | +| `query` | string | Yes | Natural language question about the codebase. Example: "How does authentication work?" or "Where is the payment processing logic?" | +| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\). Example: "facebook/react" or "github:main:facebook/react,github:main:facebook/relay" | +| `sessionId` | string | No | Session ID for conversation continuity. Use the same sessionId across multiple queries to maintain context. Example: "session-abc123" | | `genius` | boolean | No | Enable genius mode for more thorough analysis \(slower but more accurate\) | | `apiKey` | string | Yes | Greptile API key | | `githubToken` | string | Yes | GitHub Personal Access Token with repo read access | @@ -76,9 +76,9 @@ Search repositories in natural language and get relevant code references without | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | Natural language search query to find relevant code | -| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\) | -| `sessionId` | string | No | Session ID for conversation continuity | +| `query` | string | Yes | Natural language search query to find relevant code. Example: "authentication middleware" or "database connection handling" | +| `repositories` | string | Yes | Comma-separated list of repositories. Format: "github:branch:owner/repo" or just "owner/repo" \(defaults to github:main\). Example: "facebook/react" or "github:main:facebook/react,github:main:facebook/relay" | +| `sessionId` | string | No | Session ID for conversation continuity. Use the same sessionId across multiple searches to maintain context. Example: "session-abc123" | | `genius` | boolean | No | Enable genius mode for more thorough search \(slower but more accurate\) | | `apiKey` | string | Yes | Greptile API key | | `githubToken` | string | Yes | GitHub Personal Access Token with repo read access | @@ -106,7 +106,7 @@ Submit a repository to be indexed by Greptile. Indexing must complete before the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `remote` | string | Yes | Git remote type: github or gitlab | -| `repository` | string | Yes | Repository in owner/repo format \(e.g., "facebook/react"\) | +| `repository` | string | Yes | Repository in owner/repo format. Example: "facebook/react" or "vercel/next.js" | | `branch` | string | Yes | Branch to index \(e.g., "main" or "master"\) | | `reload` | boolean | No | Force re-indexing even if already indexed | | `notify` | boolean | No | Send email notification when indexing completes | @@ -130,7 +130,7 @@ Check the indexing status of a repository. Use this to verify if a repository is | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `remote` | string | Yes | Git remote type: github or gitlab | -| `repository` | string | Yes | Repository in owner/repo format \(e.g., "facebook/react"\) | +| `repository` | string | Yes | Repository in owner/repo format. Example: "facebook/react" or "vercel/next.js" | | `branch` | string | Yes | Branch name \(e.g., "main" or "master"\) | | `apiKey` | string | Yes | Greptile API key | | `githubToken` | string | Yes | GitHub Personal Access Token with repo read access | diff --git a/apps/docs/content/docs/en/tools/hubspot.mdx b/apps/docs/content/docs/en/tools/hubspot.mdx index b0ec8df93..695ccb44f 100644 --- a/apps/docs/content/docs/en/tools/hubspot.mdx +++ b/apps/docs/content/docs/en/tools/hubspot.mdx @@ -44,7 +44,7 @@ Retrieve all users from HubSpot account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `limit` | string | No | Number of results to return \(default: 100\) | +| `limit` | string | No | Number of results to return \(default: 100, max: 100\) | #### Output @@ -69,9 +69,9 @@ Retrieve all contacts from HubSpot account with pagination support | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `limit` | string | No | Maximum number of results per page \(max 100, default 100\) | -| `after` | string | No | Pagination cursor for next page of results | -| `properties` | string | No | Comma-separated list of properties to return \(e.g., "email,firstname,lastname"\) | -| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for | +| `after` | string | No | Pagination cursor for next page of results \(from previous response\) | +| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "email,firstname,lastname,phone"\) | +| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) | #### Output @@ -114,10 +114,10 @@ Retrieve a single contact by ID or email from HubSpot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `contactId` | string | Yes | The ID or email of the contact to retrieve | +| `contactId` | string | Yes | The HubSpot contact ID \(numeric string\) or email address to retrieve | | `idProperty` | string | No | Property to use as unique identifier \(e.g., "email"\). If not specified, uses record ID | -| `properties` | string | No | Comma-separated list of properties to return | -| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for | +| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "email,firstname,lastname,phone"\) | +| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) | #### Output @@ -155,8 +155,8 @@ Create a new contact in HubSpot. Requires at least one of: email, firstname, or | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `properties` | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname | -| `associations` | array | No | Array of associations to create with the contact \(e.g., companies, deals\). Each object should have "to" \(with "id"\) and "types" \(with "associationCategory" and "associationTypeId"\) | +| `properties` | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname \(e.g., \{"email": "john@example.com", "firstname": "John", "lastname": "Doe"\}\) | +| `associations` | array | No | Array of associations to create with the contact as JSON. Each object should have "to.id" \(company/deal ID\) and "types" array with "associationCategory" and "associationTypeId" | #### Output @@ -194,9 +194,9 @@ Update an existing contact in HubSpot by ID or email | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `contactId` | string | Yes | The ID or email of the contact to update | +| `contactId` | string | Yes | The HubSpot contact ID \(numeric string\) or email of the contact to update | | `idProperty` | string | No | Property to use as unique identifier \(e.g., "email"\). If not specified, uses record ID | -| `properties` | object | Yes | Contact properties to update as JSON object | +| `properties` | object | Yes | Contact properties to update as JSON object \(e.g., \{"firstname": "John", "phone": "+1234567890"\}\) | #### Output @@ -234,12 +234,12 @@ Search for contacts in HubSpot using filters, sorting, and queries | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value | -| `sorts` | array | No | Array of sort objects with propertyName and direction \("ASCENDING" or "DESCENDING"\) | -| `query` | string | No | Search query string | -| `properties` | array | No | Array of property names to return | +| `filterGroups` | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" \(e.g., "EQ", "CONTAINS"\), and "value" | +| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) | +| `query` | string | No | Search query string to match against contact name, email, and other text fields | +| `properties` | array | No | Array of HubSpot property names to return \(e.g., \["email", "firstname", "lastname", "phone"\]\) | | `limit` | number | No | Maximum number of results to return \(max 100\) | -| `after` | string | No | Pagination cursor for next page | +| `after` | string | No | Pagination cursor for next page \(from previous response\) | #### Output @@ -284,9 +284,9 @@ Retrieve all companies from HubSpot account with pagination support | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `limit` | string | No | Maximum number of results per page \(max 100, default 100\) | -| `after` | string | No | Pagination cursor for next page of results | -| `properties` | string | No | Comma-separated list of properties to return | -| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for | +| `after` | string | No | Pagination cursor for next page of results \(from previous response\) | +| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "name,domain,industry"\) | +| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) | #### Output @@ -330,10 +330,10 @@ Retrieve a single company by ID or domain from HubSpot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `companyId` | string | Yes | The ID or domain of the company to retrieve | +| `companyId` | string | Yes | The HubSpot company ID \(numeric string\) or domain to retrieve | | `idProperty` | string | No | Property to use as unique identifier \(e.g., "domain"\). If not specified, uses record ID | -| `properties` | string | No | Comma-separated list of properties to return | -| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for | +| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "name,domain,industry"\) | +| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) | #### Output @@ -372,8 +372,8 @@ Create a new company in HubSpot | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `properties` | object | Yes | Company properties as JSON object \(e.g., name, domain, city, industry\) | -| `associations` | array | No | Array of associations to create with the company | +| `properties` | object | Yes | Company properties as JSON object \(e.g., \{"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"\}\) | +| `associations` | array | No | Array of associations to create with the company as JSON \(each with "to.id" and "types" containing "associationCategory" and "associationTypeId"\) | #### Output @@ -412,9 +412,9 @@ Update an existing company in HubSpot by ID or domain | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `companyId` | string | Yes | The ID or domain of the company to update | +| `companyId` | string | Yes | The HubSpot company ID \(numeric string\) or domain of the company to update | | `idProperty` | string | No | Property to use as unique identifier \(e.g., "domain"\). If not specified, uses record ID | -| `properties` | object | Yes | Company properties to update as JSON object | +| `properties` | object | Yes | Company properties to update as JSON object \(e.g., \{"name": "New Name", "industry": "Finance"\}\) | #### Output @@ -453,12 +453,12 @@ Search for companies in HubSpot using filters, sorting, and queries | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value | -| `sorts` | array | No | Array of sort objects with propertyName and direction \("ASCENDING" or "DESCENDING"\) | -| `query` | string | No | Search query string | -| `properties` | array | No | Array of property names to return | +| `filterGroups` | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" \(e.g., "EQ", "CONTAINS"\), and "value" | +| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) | +| `query` | string | No | Search query string to match against company name, domain, and other text fields | +| `properties` | array | No | Array of HubSpot property names to return \(e.g., \["name", "domain", "industry"\]\) | | `limit` | number | No | Maximum number of results to return \(max 100\) | -| `after` | string | No | Pagination cursor for next page | +| `after` | string | No | Pagination cursor for next page \(from previous response\) | #### Output @@ -504,9 +504,9 @@ Retrieve all deals from HubSpot account with pagination support | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `limit` | string | No | Maximum number of results per page \(max 100, default 100\) | -| `after` | string | No | Pagination cursor for next page of results | -| `properties` | string | No | Comma-separated list of properties to return | -| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for | +| `after` | string | No | Pagination cursor for next page of results \(from previous response\) | +| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "dealname,amount,dealstage"\) | +| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,companies"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/huggingface.mdx b/apps/docs/content/docs/en/tools/huggingface.mdx index 0b4c66a0d..8a5fce3ca 100644 --- a/apps/docs/content/docs/en/tools/huggingface.mdx +++ b/apps/docs/content/docs/en/tools/huggingface.mdx @@ -43,7 +43,7 @@ Generate completions using Hugging Face Inference API | `systemPrompt` | string | No | System prompt to guide the model behavior | | `content` | string | Yes | The user message content to send to the model | | `provider` | string | Yes | The provider to use for the API request \(e.g., novita, cerebras, etc.\) | -| `model` | string | Yes | Model to use for chat completions \(e.g., deepseek/deepseek-v3-0324\) | +| `model` | string | Yes | Model to use for chat completions \(e.g., "deepseek/deepseek-v3-0324", "meta-llama/Llama-3.3-70B-Instruct"\) | | `maxTokens` | number | No | Maximum number of tokens to generate | | `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random | | `apiKey` | string | Yes | Hugging Face API token | diff --git a/apps/docs/content/docs/en/tools/hunter.mdx b/apps/docs/content/docs/en/tools/hunter.mdx index b4ac5e4cf..d1ea0fff4 100644 --- a/apps/docs/content/docs/en/tools/hunter.mdx +++ b/apps/docs/content/docs/en/tools/hunter.mdx @@ -42,7 +42,7 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `query` | string | No | Natural language search query for companies | -| `domain` | string | No | Company domain names to filter by | +| `domain` | string | No | Company domain name to filter by \(e.g., "stripe.com", "company.io"\) | | `headcount` | string | No | Company size filter \(e.g., "1-10", "11-50"\) | | `company_type` | string | No | Type of organization | | `technology` | string | No | Technology used by companies | @@ -67,12 +67,12 @@ Returns all the email addresses found using one given domain name, with sources. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `domain` | string | Yes | Domain name to search for email addresses | -| `limit` | number | No | Maximum email addresses to return \(default: 10\) | -| `offset` | number | No | Number of email addresses to skip | -| `type` | string | No | Filter for personal or generic emails | -| `seniority` | string | No | Filter by seniority level: junior, senior, or executive | -| `department` | string | No | Filter by specific departments \(e.g., sales, marketing\) | +| `domain` | string | Yes | Domain name to search for email addresses \(e.g., "stripe.com", "company.io"\) | +| `limit` | number | No | Maximum email addresses to return \(e.g., 10, 25, 50\). Default: 10 | +| `offset` | number | No | Number of email addresses to skip for pagination \(e.g., 0, 10, 20\) | +| `type` | string | No | Filter for personal or generic emails \(e.g., "personal", "generic", "all"\) | +| `seniority` | string | No | Filter by seniority level \(e.g., "junior", "senior", "executive"\) | +| `department` | string | No | Filter by specific department \(e.g., "sales", "marketing", "engineering", "hr"\) | | `apiKey` | string | Yes | Hunter.io API Key | #### Output @@ -128,10 +128,10 @@ Finds the most likely email address for a person given their name and company do | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `domain` | string | Yes | Company domain name | -| `first_name` | string | Yes | Person's first name | -| `last_name` | string | Yes | Person's last name | -| `company` | string | No | Company name | +| `domain` | string | Yes | Company domain name \(e.g., "stripe.com", "company.io"\) | +| `first_name` | string | Yes | Person\'s first name \(e.g., "John", "Sarah"\) | +| `last_name` | string | Yes | Person\'s last name \(e.g., "Smith", "Johnson"\) | +| `company` | string | No | Company name \(e.g., "Stripe", "Acme Inc"\) | | `apiKey` | string | Yes | Hunter.io API Key | #### Output @@ -193,7 +193,7 @@ Enriches company data using domain name. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `domain` | string | Yes | Domain to find company data for | +| `domain` | string | Yes | Domain to find company data for \(e.g., "stripe.com", "company.io"\) | | `apiKey` | string | Yes | Hunter.io API Key | #### Output @@ -218,9 +218,9 @@ Returns the total number of email addresses found for a domain or company. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `domain` | string | No | Domain to count emails for \(required if company not provided\) | -| `company` | string | No | Company name to count emails for \(required if domain not provided\) | -| `type` | string | No | Filter for personal or generic emails only | +| `domain` | string | No | Domain to count emails for \(e.g., "stripe.com"\). Required if company not provided | +| `company` | string | No | Company name to count emails for \(e.g., "Stripe", "Acme Inc"\). Required if domain not provided | +| `type` | string | No | Filter for personal or generic emails only \(e.g., "personal", "generic", "all"\) | | `apiKey` | string | Yes | Hunter.io API Key | #### Output diff --git a/apps/docs/content/docs/en/tools/incidentio.mdx b/apps/docs/content/docs/en/tools/incidentio.mdx index d4bc9baf2..11456c55f 100644 --- a/apps/docs/content/docs/en/tools/incidentio.mdx +++ b/apps/docs/content/docs/en/tools/incidentio.mdx @@ -49,8 +49,8 @@ List incidents from incident.io. Returns a list of incidents with their details | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `page_size` | number | No | Number of incidents to return per page \(default: 25\) | -| `after` | string | No | Pagination cursor to fetch the next page of results | +| `page_size` | number | No | Number of incidents to return per page \(e.g., 10, 25, 50\). Default: 25 | +| `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -99,9 +99,9 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | | `idempotency_key` | string | Yes | Unique identifier to prevent duplicate incident creation. Use a UUID or unique string. | -| `name` | string | No | Name of the incident \(optional\) | -| `summary` | string | No | Brief summary of the incident | -| `severity_id` | string | Yes | ID of the severity level \(required\) | +| `name` | string | No | Name of the incident \(e.g., "Database connection issues"\) | +| `summary` | string | No | Brief summary of the incident \(e.g., "Intermittent connection failures to primary database"\) | +| `severity_id` | string | Yes | ID of the severity level \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_type_id` | string | No | ID of the incident type | | `incident_status_id` | string | No | ID of the initial incident status | | `visibility` | string | Yes | Visibility of the incident: "public" or "private" \(required\) | @@ -144,7 +144,7 @@ Retrieve detailed information about a specific incident from incident.io by its | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | ID of the incident to retrieve | +| `id` | string | Yes | ID of the incident to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -187,11 +187,11 @@ Update an existing incident in incident.io. Can update name, summary, severity, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | ID of the incident to update | -| `name` | string | No | Updated name of the incident | -| `summary` | string | No | Updated summary of the incident | -| `severity_id` | string | No | Updated severity ID for the incident | -| `incident_status_id` | string | No | Updated status ID for the incident | +| `id` | string | Yes | ID of the incident to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `name` | string | No | Updated name of the incident \(e.g., "Database connection issues"\) | +| `summary` | string | No | Updated summary of the incident \(e.g., "Intermittent connection failures to primary database"\) | +| `severity_id` | string | No | Updated severity ID for the incident \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `incident_status_id` | string | No | Updated status ID for the incident \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_type_id` | string | No | Updated incident type ID | | `notify_incident_channel` | boolean | Yes | Whether to notify the incident channel about this update | @@ -233,8 +233,8 @@ List actions from incident.io. Optionally filter by incident ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `incident_id` | string | No | Filter actions by incident ID | -| `page_size` | number | No | Number of actions to return per page | +| `incident_id` | string | No | Filter actions by incident ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `page_size` | number | No | Number of actions to return per page \(e.g., 10, 25, 50\) | #### Output @@ -271,7 +271,7 @@ Get detailed information about a specific action from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | Action ID | +| `id` | string | Yes | Action ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -308,8 +308,8 @@ List follow-ups from incident.io. Optionally filter by incident ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `incident_id` | string | No | Filter follow-ups by incident ID | -| `page_size` | number | No | Number of follow-ups to return per page | +| `incident_id` | string | No | Filter follow-ups by incident ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `page_size` | number | No | Number of follow-ups to return per page \(e.g., 10, 25, 50\) | #### Output @@ -352,7 +352,7 @@ Get detailed information about a specific follow-up from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | Follow-up ID | +| `id` | string | Yes | Follow-up ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -395,7 +395,7 @@ List all users in your Incident.io workspace. Returns user details including id, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Incident.io API Key | -| `page_size` | number | No | Number of results to return per page \(default: 25\) | +| `page_size` | number | No | Number of results to return per page \(e.g., 10, 25, 50\). Default: 25 | #### Output @@ -416,7 +416,7 @@ Get detailed information about a specific user in your Incident.io workspace by | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Incident.io API Key | -| `id` | string | Yes | The unique identifier of the user to retrieve | +| `id` | string | Yes | The unique identifier of the user to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -437,8 +437,8 @@ List all workflows in your incident.io workspace. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `page_size` | number | No | Number of workflows to return per page | -| `after` | string | No | Pagination cursor to fetch the next page of results | +| `page_size` | number | No | Number of workflows to return per page \(e.g., 10, 25, 50\) | +| `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -464,7 +464,7 @@ Get details of a specific workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the workflow to retrieve | +| `id` | string | Yes | The ID of the workflow to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -487,8 +487,8 @@ Update an existing workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the workflow to update | -| `name` | string | No | New name for the workflow | +| `id` | string | Yes | The ID of the workflow to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `name` | string | No | New name for the workflow \(e.g., "Notify on Critical Incidents"\) | | `state` | string | No | New state for the workflow \(active, draft, or disabled\) | | `folder` | string | No | New folder for the workflow | @@ -513,7 +513,7 @@ Delete a workflow in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the workflow to delete | +| `id` | string | Yes | The ID of the workflow to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -530,8 +530,8 @@ List all schedules in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `page_size` | number | No | Number of results per page \(default: 25\) | -| `after` | string | No | Pagination cursor to fetch the next page of results | +| `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | +| `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -556,7 +556,7 @@ Create a new schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `name` | string | Yes | Name of the schedule | +| `name` | string | Yes | Name of the schedule \(e.g., "Primary On-Call"\) | | `timezone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) | | `config` | string | Yes | Schedule configuration as JSON string with rotations. Example: \{"rotations": \[\{"name": "Primary", "users": \[\{"id": "user_id"\}\], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": \[\{"interval": 1, "interval_type": "weekly"\}\]\}\]\} | | `Example` | string | No | No description | @@ -581,7 +581,7 @@ Get details of a specific schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the schedule | +| `id` | string | Yes | The ID of the schedule \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -603,8 +603,8 @@ Update an existing schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the schedule to update | -| `name` | string | No | New name for the schedule | +| `id` | string | Yes | The ID of the schedule to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `name` | string | No | New name for the schedule \(e.g., "Primary On-Call"\) | | `timezone` | string | No | New timezone for the schedule \(e.g., America/New_York\) | | `config` | string | No | Schedule configuration as JSON string with rotations. Example: \{"rotations": \[\{"name": "Primary", "users": \[\{"id": "user_id"\}\], "handover_start_at": "2024-01-01T09:00:00Z", "handovers": \[\{"interval": 1, "interval_type": "weekly"\}\]\}\]\} | | `Example` | string | No | No description | @@ -629,7 +629,7 @@ Delete a schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the schedule to delete | +| `id` | string | Yes | The ID of the schedule to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -646,7 +646,7 @@ List all escalation policies in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `page_size` | number | No | Number of results per page \(default: 25\) | +| `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | #### Output @@ -668,7 +668,7 @@ Create a new escalation policy in incident.io | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | | `idempotency_key` | string | Yes | Unique identifier to prevent duplicate escalation creation. Use a UUID or unique string. | -| `title` | string | Yes | Title of the escalation | +| `title` | string | Yes | Title of the escalation \(e.g., "Database Critical Alert"\) | | `escalation_path_id` | string | No | ID of the escalation path to use \(required if user_ids not provided\) | | `user_ids` | string | No | Comma-separated list of user IDs to notify \(required if escalation_path_id not provided\) | @@ -691,7 +691,7 @@ Get details of a specific escalation policy in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the escalation policy | +| `id` | string | Yes | The ID of the escalation policy \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -734,7 +734,7 @@ Create a new custom field in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `name` | string | Yes | Name of the custom field | +| `name` | string | Yes | Name of the custom field \(e.g., "Affected Service"\) | | `description` | string | Yes | Description of the custom field \(required\) | | `field_type` | string | Yes | Type of the custom field \(e.g., text, single_select, multi_select, numeric, datetime, link, user, team\) | @@ -759,7 +759,7 @@ Get detailed information about a specific custom field from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | Custom field ID | +| `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -782,8 +782,8 @@ Update an existing custom field in incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | Custom field ID | -| `name` | string | Yes | New name for the custom field \(required\) | +| `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `name` | string | Yes | New name for the custom field \(e.g., "Affected Service"\) | | `description` | string | Yes | New description for the custom field \(required\) | #### Output @@ -807,7 +807,7 @@ Delete a custom field from incident.io. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | Custom field ID | +| `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -909,7 +909,7 @@ Create a new incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `name` | string | Yes | Name of the incident role | +| `name` | string | Yes | Name of the incident role \(e.g., "Incident Commander"\) | | `description` | string | Yes | Description of the incident role | | `instructions` | string | Yes | Instructions for the incident role | | `shortform` | string | Yes | Short form abbreviation for the role | @@ -938,7 +938,7 @@ Get details of a specific incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the incident role | +| `id` | string | Yes | The ID of the incident role \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -964,8 +964,8 @@ Update an existing incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the incident role to update | -| `name` | string | Yes | Name of the incident role | +| `id` | string | Yes | The ID of the incident role to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `name` | string | Yes | Name of the incident role \(e.g., "Incident Commander"\) | | `description` | string | Yes | Description of the incident role | | `instructions` | string | Yes | Instructions for the incident role | | `shortform` | string | Yes | Short form abbreviation for the role | @@ -994,7 +994,7 @@ Delete an incident role in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the incident role to delete | +| `id` | string | Yes | The ID of the incident role to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1032,7 +1032,7 @@ Get details of a specific incident timestamp definition in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the incident timestamp | +| `id` | string | Yes | The ID of the incident timestamp \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1054,9 +1054,9 @@ List all updates for a specific incident in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `incident_id` | string | No | The ID of the incident to get updates for \(optional - if not provided, returns all updates\) | -| `page_size` | number | No | Number of results to return per page | -| `after` | string | No | Cursor for pagination | +| `incident_id` | string | No | The ID of the incident to get updates for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\). If not provided, returns all updates | +| `page_size` | number | No | Number of results to return per page \(e.g., 10, 25, 50\) | +| `after` | string | No | Cursor for pagination \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1093,11 +1093,11 @@ List all entries for a specific schedule in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `schedule_id` | string | Yes | The ID of the schedule to get entries for | -| `entry_window_start` | string | No | Start date/time to filter entries \(ISO 8601 format\) | -| `entry_window_end` | string | No | End date/time to filter entries \(ISO 8601 format\) | -| `page_size` | number | No | Number of results to return per page | -| `after` | string | No | Cursor for pagination | +| `schedule_id` | string | Yes | The ID of the schedule to get entries for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `entry_window_start` | string | No | Start date/time to filter entries in ISO 8601 format \(e.g., "2024-01-15T09:00:00Z"\) | +| `entry_window_end` | string | No | End date/time to filter entries in ISO 8601 format \(e.g., "2024-01-22T09:00:00Z"\) | +| `page_size` | number | No | Number of results to return per page \(e.g., 10, 25, 50\) | +| `after` | string | No | Cursor for pagination \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1129,13 +1129,13 @@ Create a new schedule override in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `rotation_id` | string | Yes | The ID of the rotation to override | -| `schedule_id` | string | Yes | The ID of the schedule | +| `rotation_id` | string | Yes | The ID of the rotation to override \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `schedule_id` | string | Yes | The ID of the schedule \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `user_id` | string | No | The ID of the user to assign \(provide one of: user_id, user_email, or user_slack_id\) | | `user_email` | string | No | The email of the user to assign \(provide one of: user_id, user_email, or user_slack_id\) | | `user_slack_id` | string | No | The Slack ID of the user to assign \(provide one of: user_id, user_email, or user_slack_id\) | -| `start_at` | string | Yes | When the override starts \(ISO 8601 format\) | -| `end_at` | string | Yes | When the override ends \(ISO 8601 format\) | +| `start_at` | string | Yes | When the override starts in ISO 8601 format \(e.g., "2024-01-15T09:00:00Z"\) | +| `end_at` | string | Yes | When the override ends in ISO 8601 format \(e.g., "2024-01-22T09:00:00Z"\) | #### Output @@ -1163,7 +1163,7 @@ Create a new escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `name` | string | Yes | Name of the escalation path | +| `name` | string | Yes | Name of the escalation path \(e.g., "Critical Incident Path"\) | | `path` | json | Yes | Array of escalation levels with targets and time to acknowledge in seconds. Each level should have: targets \(array of \{id, type, schedule_id?, user_id?, urgency\}\) and time_to_ack_seconds \(number\) | | `working_hours` | json | No | Optional working hours configuration. Array of \{weekday, start_time, end_time\} | @@ -1198,7 +1198,7 @@ Get details of a specific escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the escalation path | +| `id` | string | Yes | The ID of the escalation path \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output @@ -1231,8 +1231,8 @@ Update an existing escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the escalation path to update | -| `name` | string | No | New name for the escalation path | +| `id` | string | Yes | The ID of the escalation path to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | +| `name` | string | No | New name for the escalation path \(e.g., "Critical Incident Path"\) | | `path` | json | No | New escalation path configuration. Array of escalation levels with targets and time_to_ack_seconds | | `working_hours` | json | No | New working hours configuration. Array of \{weekday, start_time, end_time\} | @@ -1267,7 +1267,7 @@ Delete an escalation path in incident.io | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | incident.io API Key | -| `id` | string | Yes | The ID of the escalation path to delete | +| `id` | string | Yes | The ID of the escalation path to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/jina.mdx b/apps/docs/content/docs/en/tools/jina.mdx index 9b2dc70e9..9a2561c0d 100644 --- a/apps/docs/content/docs/en/tools/jina.mdx +++ b/apps/docs/content/docs/en/tools/jina.mdx @@ -43,7 +43,7 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | The URL to read and convert to markdown | +| `url` | string | Yes | The URL to read and convert to markdown \(e.g., "https://example.com/page"\) | | `useReaderLMv2` | boolean | No | Whether to use ReaderLM-v2 for better quality \(3x token cost\) | | `gatherLinks` | boolean | No | Whether to gather all links at the end | | `jsonResponse` | boolean | No | Whether to return response in JSON format | @@ -73,7 +73,7 @@ Search the web and return top 5 results with LLM-friendly content. Each result i | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `q` | string | Yes | Search query string | +| `q` | string | Yes | Search query string \(e.g., "machine learning tutorials"\) | | `apiKey` | string | Yes | Your Jina AI API key | | `num` | number | No | Maximum number of results per page \(default: 5\) | | `site` | string | No | Restrict results to specific domain\(s\). Can be comma-separated for multiple sites \(e.g., "jina.ai,github.com"\) | diff --git a/apps/docs/content/docs/en/tools/jira.mdx b/apps/docs/content/docs/en/tools/jira.mdx index b2a296e3e..921ae9cd9 100644 --- a/apps/docs/content/docs/en/tools/jira.mdx +++ b/apps/docs/content/docs/en/tools/jira.mdx @@ -43,7 +43,7 @@ Retrieve detailed information about a specific Jira issue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | -| `projectId` | string | No | Jira project ID \(optional; not required to retrieve a single issue\). | +| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when retrieving a single issue. | | `issueKey` | string | Yes | Jira issue key to retrieve \(e.g., PROJ-123\) | | `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. | @@ -68,8 +68,8 @@ Update a Jira issue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | -| `projectId` | string | No | Jira project ID to update issues in. If not provided, all issues will be retrieved. | -| `issueKey` | string | Yes | Jira issue key to update | +| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when updating a single issue. | +| `issueKey` | string | Yes | Jira issue key to update \(e.g., PROJ-123\) | | `summary` | string | No | New summary for the issue | | `description` | string | No | New description for the issue | | `status` | string | No | New status for the issue | @@ -94,7 +94,7 @@ Write a Jira issue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | -| `projectId` | string | Yes | Project ID for the issue | +| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) | | `summary` | string | Yes | Summary for the issue | | `description` | string | No | Description for the issue | | `priority` | string | No | Priority ID or name for the issue \(e.g., "10000" or "High"\) | @@ -127,8 +127,8 @@ Retrieve multiple Jira issues in bulk | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | -| `projectId` | string | Yes | Jira project ID | -| `cloudId` | string | No | Jira cloud ID | +| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) | +| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. | #### Output diff --git a/apps/docs/content/docs/en/tools/jira_service_management.mdx b/apps/docs/content/docs/en/tools/jira_service_management.mdx index b1194ff1b..9cc80444e 100644 --- a/apps/docs/content/docs/en/tools/jira_service_management.mdx +++ b/apps/docs/content/docs/en/tools/jira_service_management.mdx @@ -46,8 +46,8 @@ Get all service desks from Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -68,9 +68,9 @@ Get request types for a service desk in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to get request types for | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -91,8 +91,8 @@ Create a new service request in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to create the request in | -| `requestTypeId` | string | Yes | Request Type ID for the new request | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | +| `requestTypeId` | string | Yes | Request Type ID \(e.g., "10", "15"\) | | `summary` | string | Yes | Summary/title for the service request | | `description` | string | No | Description for the service request | | `raiseOnBehalfOf` | string | No | Account ID of customer to raise request on behalf of | @@ -138,12 +138,12 @@ Get multiple service requests from Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | No | Filter by service desk ID | +| `serviceDeskId` | string | No | Filter by service desk ID \(e.g., "1", "2"\) | | `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, ORGANIZATION, ALL_REQUESTS | | `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL | -| `searchTerm` | string | No | Search term to filter requests | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `searchTerm` | string | No | Search term to filter requests \(e.g., "password reset", "laptop"\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -166,7 +166,7 @@ Add a comment (public or internal) to a service request in Jira Service Manageme | `cloudId` | string | No | Jira Cloud ID for the instance | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | | `body` | string | Yes | Comment body text | -| `isPublic` | boolean | Yes | Whether the comment is public \(visible to customer\) or internal | +| `isPublic` | boolean | Yes | Whether the comment is public \(visible to customer\) or internal \(true/false\) | #### Output @@ -190,10 +190,10 @@ Get comments for a service request in Jira Service Management | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | -| `isPublic` | boolean | No | Filter to only public comments | -| `internal` | boolean | No | Filter to only internal comments | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `isPublic` | boolean | No | Filter to only public comments \(true/false\) | +| `internal` | boolean | No | Filter to only internal comments \(true/false\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -215,10 +215,10 @@ Get customers for a service desk in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to get customers for | -| `query` | string | No | Search query to filter customers | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | +| `query` | string | No | Search query to filter customers \(e.g., "john", "acme"\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -239,7 +239,7 @@ Add customers to a service desk in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to add customers to | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `emails` | string | Yes | Comma-separated email addresses to add as customers | #### Output @@ -260,9 +260,9 @@ Get organizations for a service desk in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to get organizations for | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -304,7 +304,7 @@ Add an organization to a service desk in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to add the organization to | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `organizationId` | string | Yes | Organization ID to add to the service desk | #### Output @@ -326,10 +326,10 @@ Get queues for a service desk in Jira Service Management | --------- | ---- | -------- | ----------- | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | -| `serviceDeskId` | string | Yes | Service Desk ID to get queues for | -| `includeCount` | boolean | No | Include issue count for each queue | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | +| `includeCount` | boolean | No | Include issue count for each queue \(true/false\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -351,8 +351,8 @@ Get SLA information for a service request in Jira Service Management | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -418,8 +418,8 @@ Get participants for a request in Jira Service Management | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output @@ -464,8 +464,8 @@ Get approvals for a request in Jira Service Management | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `cloudId` | string | No | Jira Cloud ID for the instance | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | -| `start` | number | No | Start index for pagination \(default: 0\) | -| `limit` | number | No | Maximum results to return \(default: 50\) | +| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | +| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | #### Output diff --git a/apps/docs/content/docs/en/tools/kalshi.mdx b/apps/docs/content/docs/en/tools/kalshi.mdx index abdfaeca1..42cfd50f5 100644 --- a/apps/docs/content/docs/en/tools/kalshi.mdx +++ b/apps/docs/content/docs/en/tools/kalshi.mdx @@ -42,11 +42,11 @@ Retrieve a list of prediction markets from Kalshi with all filtering options (V2 | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `status` | string | No | Filter by status \(unopened, open, closed, settled\) | -| `seriesTicker` | string | No | Filter by series ticker | -| `eventTicker` | string | No | Filter by event ticker | -| `limit` | string | No | Number of results \(1-1000, default: 100\) | -| `cursor` | string | No | Pagination cursor for next page | +| `status` | string | No | Filter by market status: "unopened", "open", "closed", or "settled" | +| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) | +| `eventTicker` | string | No | Filter by event ticker \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) | +| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | +| `cursor` | string | No | Pagination cursor from previous response for fetching next page | #### Output @@ -90,7 +90,7 @@ Retrieve details of a specific prediction market by ticker (V2 - full API respon | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `ticker` | string | Yes | The market ticker \(e.g., "KXBTC-24DEC31"\) | +| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | #### Output @@ -157,11 +157,11 @@ Retrieve a list of events from Kalshi with optional filtering (V2 - exact API re | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `status` | string | No | Filter by status \(open, closed, settled\) | -| `seriesTicker` | string | No | Filter by series ticker | -| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) | -| `limit` | string | No | Number of results \(1-200, default: 200\) | -| `cursor` | string | No | Pagination cursor for next page | +| `status` | string | No | Filter by event status: "open", "closed", or "settled" | +| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) | +| `withNestedMarkets` | string | No | Include nested markets in response: "true" or "false" | +| `limit` | string | No | Number of results to return \(1-200, default: 200\) | +| `cursor` | string | No | Pagination cursor from previous response for fetching next page | #### Output @@ -191,7 +191,7 @@ Retrieve details of a specific event by ticker (V2 - exact API response) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `eventTicker` | string | Yes | The event ticker | +| `eventTicker` | string | Yes | Event ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) | | `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) | #### Output @@ -241,11 +241,11 @@ Retrieve your open positions from Kalshi (V2 - exact API response) | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `ticker` | string | No | Filter by market ticker | -| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) | -| `settlementStatus` | string | No | Filter by settlement status \(all, unsettled, settled\). Default: unsettled | -| `limit` | string | No | Number of results \(1-1000, default: 100\) | -| `cursor` | string | No | Pagination cursor for next page | +| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) | +| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) | +| `settlementStatus` | string | No | Filter by settlement status: "all", "unsettled", or "settled" \(default: "unsettled"\) | +| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | +| `cursor` | string | No | Pagination cursor from previous response for fetching next page | #### Output @@ -279,11 +279,11 @@ Retrieve your orders from Kalshi with optional filtering (V2 with full API respo | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `ticker` | string | No | Filter by market ticker | -| `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) | -| `status` | string | No | Filter by status \(resting, canceled, executed\) | -| `limit` | string | No | Number of results \(1-200, default: 100\) | -| `cursor` | string | No | Pagination cursor for next page | +| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) | +| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) | +| `status` | string | No | Filter by order status: "resting", "canceled", or "executed" | +| `limit` | string | No | Number of results to return \(1-200, default: 100\) | +| `cursor` | string | No | Pagination cursor from previous response for fetching next page | #### Output @@ -320,7 +320,7 @@ Retrieve details of a specific order by ID from Kalshi (V2 with full API respons | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `orderId` | string | Yes | The order ID to retrieve | +| `orderId` | string | Yes | Order ID to retrieve \(e.g., "abc123-def456-ghi789"\) | #### Output @@ -369,7 +369,7 @@ Retrieve the orderbook (yes and no bids) for a specific market (V2 - includes de | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) | +| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | #### Output @@ -392,8 +392,8 @@ Retrieve recent trades with additional filtering options (V2 - includes trade_id | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `limit` | string | No | Number of results \(1-1000, default: 100\) | -| `cursor` | string | No | Pagination cursor for next page | +| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | +| `cursor` | string | No | Pagination cursor from previous response for fetching next page | #### Output @@ -416,11 +416,11 @@ Retrieve OHLC candlestick data for a specific market (V2 - full API response) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `seriesTicker` | string | Yes | Series ticker | -| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) | -| `startTs` | number | Yes | Start timestamp \(Unix seconds\) | -| `endTs` | number | Yes | End timestamp \(Unix seconds\) | -| `periodInterval` | number | Yes | Period interval: 1 \(1min\), 60 \(1hour\), or 1440 \(1day\) | +| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) | +| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | +| `startTs` | number | Yes | Start timestamp in Unix seconds \(e.g., 1704067200\) | +| `endTs` | number | Yes | End timestamp in Unix seconds \(e.g., 1704153600\) | +| `periodInterval` | number | Yes | Period interval: 1 \(1 minute\), 60 \(1 hour\), or 1440 \(1 day\) | #### Output @@ -439,12 +439,12 @@ Retrieve your portfolio | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `ticker` | string | No | Filter by market ticker | -| `orderId` | string | No | Filter by order ID | -| `minTs` | number | No | Minimum timestamp \(Unix milliseconds\) | -| `maxTs` | number | No | Maximum timestamp \(Unix milliseconds\) | -| `limit` | string | No | Number of results \(1-1000, default: 100\) | -| `cursor` | string | No | Pagination cursor for next page | +| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) | +| `orderId` | string | No | Filter by order ID \(e.g., "abc123-def456-ghi789"\) | +| `minTs` | number | No | Minimum timestamp in Unix milliseconds \(e.g., 1704067200000\) | +| `maxTs` | number | No | Maximum timestamp in Unix milliseconds \(e.g., 1704153600000\) | +| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | +| `cursor` | string | No | Pagination cursor from previous response for fetching next page | #### Output @@ -471,7 +471,7 @@ Retrieve details of a specific market series by ticker (V2 - exact API response) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `seriesTicker` | string | Yes | Series ticker | +| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) | #### Output @@ -520,11 +520,11 @@ Create a new order on a Kalshi prediction market (V2 with full API response) | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) | -| `side` | string | Yes | Side of the order: 'yes' or 'no' | -| `action` | string | Yes | Action type: 'buy' or 'sell' | -| `count` | string | Yes | Number of contracts \(minimum 1\) | -| `type` | string | No | Order type: 'limit' or 'market' \(default: limit\) | +| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | +| `side` | string | Yes | Side of the order: "yes" or "no" | +| `action` | string | Yes | Action type: "buy" or "sell" | +| `count` | string | Yes | Number of contracts to trade \(e.g., "10", "100"\) | +| `type` | string | No | Order type: "limit" or "market" \(default: "limit"\) | | `yesPrice` | string | No | Yes price in cents \(1-99\) | | `noPrice` | string | No | No price in cents \(1-99\) | | `yesPriceDollars` | string | No | Yes price in dollars \(e.g., "0.56"\) | @@ -587,7 +587,7 @@ Cancel an existing order on Kalshi (V2 with full API response) | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `orderId` | string | Yes | The order ID to cancel | +| `orderId` | string | Yes | Order ID to cancel \(e.g., "abc123-def456-ghi789"\) | #### Output @@ -640,13 +640,13 @@ Modify the price or quantity of an existing order on Kalshi (V2 with full API re | --------- | ---- | -------- | ----------- | | `keyId` | string | Yes | Your Kalshi API Key ID | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | -| `orderId` | string | Yes | The order ID to amend | -| `ticker` | string | Yes | Market ticker | -| `side` | string | Yes | Side of the order: 'yes' or 'no' | -| `action` | string | Yes | Action type: 'buy' or 'sell' | -| `clientOrderId` | string | Yes | The original client-specified order ID | -| `updatedClientOrderId` | string | Yes | The new client-specified order ID after amendment | -| `count` | string | No | Updated quantity for the order | +| `orderId` | string | Yes | Order ID to amend \(e.g., "abc123-def456-ghi789"\) | +| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | +| `side` | string | Yes | Side of the order: "yes" or "no" | +| `action` | string | Yes | Action type: "buy" or "sell" | +| `clientOrderId` | string | Yes | Original client-specified order ID | +| `updatedClientOrderId` | string | Yes | New client-specified order ID after amendment | +| `count` | string | No | Updated quantity for the order \(e.g., "10", "100"\) | | `yesPrice` | string | No | Updated yes price in cents \(1-99\) | | `noPrice` | string | No | Updated no price in cents \(1-99\) | | `yesPriceDollars` | string | No | Updated yes price in dollars \(e.g., "0.56"\) | diff --git a/apps/docs/content/docs/en/tools/lemlist.mdx b/apps/docs/content/docs/en/tools/lemlist.mdx index 7c3530c3d..c2ed048f4 100644 --- a/apps/docs/content/docs/en/tools/lemlist.mdx +++ b/apps/docs/content/docs/en/tools/lemlist.mdx @@ -46,11 +46,11 @@ Retrieves campaign activities and steps performed, including email opens, clicks | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Lemlist API key | | `type` | string | No | Filter by activity type \(e.g., emailOpened, emailClicked, emailReplied, paused\) | -| `campaignId` | string | No | Filter by campaign ID | -| `leadId` | string | No | Filter by lead ID | +| `campaignId` | string | No | Filter by campaign ID \(e.g., "cam_abc123def456"\) | +| `leadId` | string | No | Filter by lead ID \(e.g., "lea_abc123def456"\) | | `isFirst` | boolean | No | Filter for first activity only | -| `limit` | number | No | Number of results per request \(max 100, default 100\) | -| `offset` | number | No | Number of records to skip for pagination | +| `limit` | number | No | Number of results per request \(e.g., 50\). Max 100, default 100 | +| `offset` | number | No | Number of records to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -75,7 +75,7 @@ Retrieves lead information by email address or lead ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Lemlist API key | -| `leadIdentifier` | string | Yes | Lead email address or lead ID | +| `leadIdentifier` | string | Yes | Lead email address \(e.g., "john@example.com"\) or lead ID \(e.g., "lea_abc123def456"\) | #### Output @@ -102,11 +102,11 @@ Sends an email to a contact through the Lemlist inbox. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Lemlist API key | -| `sendUserId` | string | Yes | Identifier for the user sending the message | -| `sendUserEmail` | string | Yes | Email address of the sender | -| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender | -| `contactId` | string | Yes | Recipient contact identifier | -| `leadId` | string | Yes | Associated lead identifier | +| `sendUserId` | string | Yes | Identifier for the user sending the message \(e.g., "usr_abc123def456"\) | +| `sendUserEmail` | string | Yes | Email address of the sender \(e.g., "sales@company.com"\) | +| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender \(e.g., "mbx_abc123def456"\) | +| `contactId` | string | Yes | Recipient contact identifier \(e.g., "con_abc123def456"\) | +| `leadId` | string | Yes | Associated lead identifier \(e.g., "lea_abc123def456"\) | | `subject` | string | Yes | Email subject line | | `message` | string | Yes | Email message body in HTML format | | `cc` | json | No | Array of CC email addresses | diff --git a/apps/docs/content/docs/en/tools/linear.mdx b/apps/docs/content/docs/en/tools/linear.mdx index d6f61417b..ec1d24698 100644 --- a/apps/docs/content/docs/en/tools/linear.mdx +++ b/apps/docs/content/docs/en/tools/linear.mdx @@ -42,8 +42,8 @@ Fetch and filter issues from Linear | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | No | Linear team ID to filter by | -| `projectId` | string | No | Linear project ID to filter by | +| `teamId` | string | No | Linear team ID \(UUID format\) to filter issues by team | +| `projectId` | string | No | Linear project ID \(UUID format\) to filter issues by project | | `assigneeId` | string | No | User ID to filter by assignee | | `stateId` | string | No | Workflow state ID to filter by status | | `priority` | number | No | Priority to filter by \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | @@ -142,8 +142,8 @@ Create a new issue in Linear | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | Linear team ID | -| `projectId` | string | No | Linear project ID | +| `teamId` | string | Yes | Linear team ID \(UUID format\) where the issue will be created | +| `projectId` | string | No | Linear project ID \(UUID format\) to associate with the issue | | `title` | string | Yes | Issue title | | `description` | string | No | Issue description | | `stateId` | string | No | Workflow state ID \(status\) | diff --git a/apps/docs/content/docs/en/tools/linkup.mdx b/apps/docs/content/docs/en/tools/linkup.mdx index e6b0c3eb3..c3812f1d5 100644 --- a/apps/docs/content/docs/en/tools/linkup.mdx +++ b/apps/docs/content/docs/en/tools/linkup.mdx @@ -40,9 +40,9 @@ Search the web for information using Linkup | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `q` | string | Yes | The search query | -| `depth` | string | Yes | Search depth \(has to either be "standard" or "deep"\) | -| `outputType` | string | Yes | Type of output to return \(has to be "sourcedAnswer" or "searchResults"\) | +| `q` | string | Yes | The search query \(e.g., "latest AI research papers 2024"\) | +| `depth` | string | Yes | Search depth: "standard" for quick results, "deep" for comprehensive search | +| `outputType` | string | Yes | Output format: "sourcedAnswer" for AI-generated answer with citations, "searchResults" for raw results | | `apiKey` | string | Yes | Enter your Linkup API key | | `includeImages` | boolean | No | Whether to include images in search results | | `fromDate` | string | No | Start date for filtering results \(YYYY-MM-DD format\) | diff --git a/apps/docs/content/docs/en/tools/mailchimp.mdx b/apps/docs/content/docs/en/tools/mailchimp.mdx index 7d5341973..35dc40339 100644 --- a/apps/docs/content/docs/en/tools/mailchimp.mdx +++ b/apps/docs/content/docs/en/tools/mailchimp.mdx @@ -63,8 +63,8 @@ Retrieve a list of audiences (lists) from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -85,7 +85,7 @@ Retrieve details of a specific audience (list) from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | #### Output @@ -105,11 +105,11 @@ Create a new audience (list) in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `audienceName` | string | Yes | The name of the list | -| `contact` | string | Yes | JSON object of contact information | -| `permissionReminder` | string | Yes | Permission reminder text | -| `campaignDefaults` | string | Yes | JSON object of default campaign settings | -| `emailTypeOption` | string | Yes | Support multiple email formats | +| `audienceName` | string | Yes | The name of the audience/list \(e.g., "Newsletter Subscribers"\) | +| `contact` | string | Yes | JSON object of contact information \(e.g., \{"company": "Acme", "address1": "123 Main St", "city": "NYC", "state": "NY", "zip": "10001", "country": "US"\}\) | +| `permissionReminder` | string | Yes | Permission reminder text shown to subscribers \(e.g., "You signed up for updates on our website"\) | +| `campaignDefaults` | string | Yes | JSON object of default campaign settings \(e.g., \{"from_name": "Acme", "from_email": "news@acme.com", "subject": "", "language": "en"\}\) | +| `emailTypeOption` | string | Yes | Support multiple email formats: "true" or "false" | #### Output @@ -130,11 +130,11 @@ Update an existing audience (list) in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `audienceName` | string | No | The name of the list | -| `permissionReminder` | string | No | Permission reminder text | -| `campaignDefaults` | string | No | JSON object of default campaign settings | -| `emailTypeOption` | string | No | Support multiple email formats | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `audienceName` | string | No | The name of the audience/list \(e.g., "Newsletter Subscribers"\) | +| `permissionReminder` | string | No | Permission reminder text shown to subscribers \(e.g., "You signed up for updates on our website"\) | +| `campaignDefaults` | string | No | JSON object of default campaign settings \(e.g., \{"from_name": "Acme", "from_email": "news@acme.com"\}\) | +| `emailTypeOption` | string | No | Support multiple email formats: "true" or "false" | #### Output @@ -155,7 +155,7 @@ Delete an audience (list) from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list to delete | +| `listId` | string | Yes | The unique ID for the audience/list to delete \(e.g., "abc123def4"\) | #### Output @@ -172,10 +172,10 @@ Retrieve a list of members from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `status` | string | No | Filter by status \(subscribed, unsubscribed, cleaned, pending\) | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `status` | string | No | Filter by status: "subscribed", "unsubscribed", "cleaned", or "pending" | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -196,8 +196,8 @@ Retrieve details of a specific member from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | #### Output @@ -217,11 +217,11 @@ Add a new member to a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `emailAddress` | string | Yes | Member email address | -| `status` | string | Yes | Subscriber status | -| `mergeFields` | string | No | JSON object of merge fields | -| `interests` | string | No | JSON object of interests | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | +| `status` | string | Yes | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | +| `mergeFields` | string | No | JSON object of merge fields \(e.g., \{"FNAME": "John", "LNAME": "Doe"\}\) | +| `interests` | string | No | JSON object of interest IDs and their boolean values \(e.g., \{"abc123": true\}\) | #### Output @@ -242,12 +242,12 @@ Add a new member or update an existing member in a Mailchimp audience (upsert) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | -| `emailAddress` | string | Yes | Member email address | -| `statusIfNew` | string | Yes | Subscriber status if new member | -| `mergeFields` | string | No | JSON object of merge fields | -| `interests` | string | No | JSON object of interests | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | +| `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | +| `statusIfNew` | string | Yes | Subscriber status if new: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | +| `mergeFields` | string | No | JSON object of merge fields \(e.g., \{"FNAME": "John", "LNAME": "Doe"\}\) | +| `interests` | string | No | JSON object of interest IDs and their boolean values \(e.g., \{"abc123": true\}\) | #### Output @@ -268,12 +268,12 @@ Update an existing member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | -| `emailAddress` | string | No | Member email address | -| `status` | string | No | Subscriber status | -| `mergeFields` | string | No | JSON object of merge fields | -| `interests` | string | No | JSON object of interests | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | +| `emailAddress` | string | No | New member email address \(e.g., "user@example.com"\) | +| `status` | string | No | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | +| `mergeFields` | string | No | JSON object of merge fields \(e.g., \{"FNAME": "John", "LNAME": "Doe"\}\) | +| `interests` | string | No | JSON object of interest IDs and their boolean values \(e.g., \{"abc123": true\}\) | #### Output @@ -294,8 +294,8 @@ Delete a member from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | #### Output @@ -312,8 +312,8 @@ Permanently archive (delete) a member from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | #### Output @@ -332,10 +332,10 @@ Restore an archived member to a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | -| `emailAddress` | string | Yes | Member email address | -| `status` | string | Yes | Subscriber status | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | +| `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | +| `status` | string | Yes | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | #### Output @@ -356,10 +356,10 @@ Retrieve a list of campaigns from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignType` | string | No | Filter by campaign type \(regular, plaintext, absplit, rss, variate\) | -| `status` | string | No | Filter by status \(save, paused, schedule, sending, sent\) | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `campaignType` | string | No | Filter by campaign type: "regular", "plaintext", "absplit", "rss", or "variate" | +| `status` | string | No | Filter by status: "save", "paused", "schedule", "sending", or "sent" | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -380,7 +380,7 @@ Retrieve details of a specific campaign from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign | +| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | #### Output @@ -400,9 +400,9 @@ Create a new campaign in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignType` | string | Yes | Campaign type | -| `campaignSettings` | string | Yes | JSON object of campaign settings | -| `recipients` | string | No | JSON object of recipients | +| `campaignType` | string | Yes | Campaign type: "regular", "plaintext", "absplit", "rss", or "variate" | +| `campaignSettings` | string | Yes | JSON object of campaign settings \(e.g., \{"subject_line": "Newsletter", "from_name": "Acme", "reply_to": "news@acme.com"\}\) | +| `recipients` | string | No | JSON object of recipients \(e.g., \{"list_id": "abc123"\}\) | #### Output @@ -423,9 +423,9 @@ Update an existing campaign in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign | -| `campaignSettings` | string | No | JSON object of campaign settings | -| `recipients` | string | No | JSON object of recipients | +| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | +| `campaignSettings` | string | No | JSON object of campaign settings \(e.g., \{"subject_line": "Newsletter", "from_name": "Acme"\}\) | +| `recipients` | string | No | JSON object of recipients \(e.g., \{"list_id": "abc123"\}\) | #### Output @@ -446,7 +446,7 @@ Delete a campaign from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign to delete | +| `campaignId` | string | Yes | The unique ID for the campaign to delete \(e.g., "abc123def4"\) | #### Output @@ -463,7 +463,7 @@ Send a Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign to send | +| `campaignId` | string | Yes | The unique ID for the campaign to send \(e.g., "abc123def4"\) | #### Output @@ -482,8 +482,8 @@ Schedule a Mailchimp campaign to be sent at a specific time | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign to schedule | -| `scheduleTime` | string | Yes | ISO 8601 format date and time | +| `campaignId` | string | Yes | The unique ID for the campaign to schedule \(e.g., "abc123def4"\) | +| `scheduleTime` | string | Yes | Schedule time in ISO 8601 format \(e.g., "2024-12-25T10:00:00Z"\) | #### Output @@ -500,7 +500,7 @@ Unschedule a previously scheduled Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign to unschedule | +| `campaignId` | string | Yes | The unique ID for the campaign to unschedule \(e.g., "abc123def4"\) | #### Output @@ -519,7 +519,7 @@ Create a copy of an existing Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign to replicate | +| `campaignId` | string | Yes | The unique ID for the campaign to replicate \(e.g., "abc123def4"\) | #### Output @@ -540,7 +540,7 @@ Retrieve the HTML and plain-text content for a Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign | +| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | #### Output @@ -559,10 +559,10 @@ Set the content for a Mailchimp campaign | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign | +| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `html` | string | No | The HTML content for the campaign | | `plainText` | string | No | The plain-text content for the campaign | -| `templateId` | string | No | The ID of the template to use | +| `templateId` | string | No | The unique ID of the template to use \(e.g., "12345"\) | #### Output @@ -582,8 +582,8 @@ Retrieve a list of automations from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -604,7 +604,7 @@ Retrieve details of a specific automation from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `workflowId` | string | Yes | The unique ID for the automation workflow | +| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | #### Output @@ -624,7 +624,7 @@ Start all emails in a Mailchimp automation workflow | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `workflowId` | string | Yes | The unique ID for the automation workflow | +| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | #### Output @@ -643,7 +643,7 @@ Pause all emails in a Mailchimp automation workflow | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `workflowId` | string | Yes | The unique ID for the automation workflow | +| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | #### Output @@ -662,9 +662,9 @@ Manually add a subscriber to a workflow email queue | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `workflowId` | string | Yes | The unique ID for the automation workflow | -| `workflowEmailId` | string | Yes | The unique ID for the workflow email | -| `emailAddress` | string | Yes | Email address of the subscriber | +| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | +| `workflowEmailId` | string | Yes | The unique ID for the workflow email \(e.g., "xyz789"\) | +| `emailAddress` | string | Yes | Email address of the subscriber \(e.g., "user@example.com"\) | #### Output @@ -684,8 +684,8 @@ Retrieve a list of templates from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -706,7 +706,7 @@ Retrieve details of a specific template from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `templateId` | string | Yes | The unique ID for the template | +| `templateId` | string | Yes | The unique ID for the template \(e.g., "12345"\) | #### Output @@ -726,7 +726,7 @@ Create a new template in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `templateName` | string | Yes | The name of the template | +| `templateName` | string | Yes | The name of the template \(e.g., "Monthly Newsletter"\) | | `templateHtml` | string | Yes | The HTML content for the template | #### Output @@ -748,8 +748,8 @@ Update an existing template in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `templateId` | string | Yes | The unique ID for the template | -| `templateName` | string | No | The name of the template | +| `templateId` | string | Yes | The unique ID for the template \(e.g., "12345"\) | +| `templateName` | string | No | The name of the template \(e.g., "Monthly Newsletter"\) | | `templateHtml` | string | No | The HTML content for the template | #### Output @@ -771,7 +771,7 @@ Delete a template from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `templateId` | string | Yes | The unique ID for the template to delete | +| `templateId` | string | Yes | The unique ID for the template to delete \(e.g., "12345"\) | #### Output @@ -788,8 +788,8 @@ Retrieve a list of campaign reports from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -810,7 +810,7 @@ Retrieve the report for a specific campaign from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `campaignId` | string | Yes | The unique ID for the campaign | +| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | #### Output @@ -830,9 +830,9 @@ Retrieve a list of segments from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -853,8 +853,8 @@ Retrieve details of a specific segment from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentId` | string | Yes | The unique ID for the segment | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | #### Output @@ -874,9 +874,9 @@ Create a new segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentName` | string | Yes | The name of the segment | -| `segmentOptions` | string | No | JSON object of segment options | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentName` | string | Yes | The name of the segment \(e.g., "VIP Customers"\) | +| `segmentOptions` | string | No | JSON object of segment options for saved segments \(e.g., \{"match": "all", "conditions": \[...\]\}\) | #### Output @@ -897,10 +897,10 @@ Update an existing segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentId` | string | Yes | The unique ID for the segment | -| `segmentName` | string | No | The name of the segment | -| `segmentOptions` | string | No | JSON object of segment options | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | +| `segmentName` | string | No | The name of the segment \(e.g., "VIP Customers"\) | +| `segmentOptions` | string | No | JSON object of segment options \(e.g., \{"match": "all", "conditions": \[...\]\}\) | #### Output @@ -921,8 +921,8 @@ Delete a segment from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentId` | string | Yes | The unique ID for the segment to delete | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentId` | string | Yes | The unique ID for the segment to delete \(e.g., "12345"\) | #### Output @@ -939,10 +939,10 @@ Retrieve members of a specific segment from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentId` | string | Yes | The unique ID for the segment | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -963,9 +963,9 @@ Add a member to a specific segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentId` | string | Yes | The unique ID for the segment | -| `emailAddress` | string | Yes | Email address of the member | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | +| `emailAddress` | string | Yes | Email address of the member \(e.g., "user@example.com"\) | #### Output @@ -985,9 +985,9 @@ Remove a member from a specific segment in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `segmentId` | string | Yes | The unique ID for the segment | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | #### Output @@ -1006,8 +1006,8 @@ Retrieve tags associated with a member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | #### Output @@ -1028,9 +1028,9 @@ Add tags to a member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | -| `tags` | string | Yes | JSON array of tags | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | +| `tags` | string | Yes | JSON array of tag objects \(e.g., \[\{"name": "VIP", "status": "active"\}\]\) | #### Output @@ -1049,9 +1049,9 @@ Remove tags from a member in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `subscriberEmail` | string | Yes | Member email address or MD5 hash | -| `tags` | string | Yes | JSON array of tags with inactive status | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | +| `tags` | string | Yes | JSON array of tag objects with inactive status \(e.g., \[\{"name": "VIP", "status": "inactive"\}\]\) | #### Output @@ -1070,9 +1070,9 @@ Retrieve a list of merge fields from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -1093,8 +1093,8 @@ Retrieve details of a specific merge field from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `mergeId` | string | Yes | The unique ID for the merge field | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `mergeId` | string | Yes | The unique ID for the merge field \(e.g., "1" or "FNAME"\) | #### Output @@ -1114,9 +1114,9 @@ Create a new merge field in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `mergeName` | string | Yes | The name of the merge field | -| `mergeType` | string | Yes | The type of the merge field \(text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip\) | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `mergeName` | string | Yes | The name of the merge field \(e.g., "First Name"\) | +| `mergeType` | string | Yes | The type of the merge field: "text", "number", "address", "phone", "date", "url", "imageurl", "radio", "dropdown", "birthday", or "zip" | #### Output @@ -1137,9 +1137,9 @@ Update an existing merge field in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `mergeId` | string | Yes | The unique ID for the merge field | -| `mergeName` | string | No | The name of the merge field | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `mergeId` | string | Yes | The unique ID for the merge field \(e.g., "1" or "FNAME"\) | +| `mergeName` | string | No | The name of the merge field \(e.g., "First Name"\) | #### Output @@ -1160,8 +1160,8 @@ Delete a merge field from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `mergeId` | string | Yes | The unique ID for the merge field to delete | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `mergeId` | string | Yes | The unique ID for the merge field to delete \(e.g., "1" or "FNAME"\) | #### Output @@ -1178,9 +1178,9 @@ Retrieve a list of interest categories from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -1201,8 +1201,8 @@ Retrieve details of a specific interest category from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | #### Output @@ -1222,9 +1222,9 @@ Create a new interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryTitle` | string | Yes | The title of the interest category | -| `interestCategoryType` | string | Yes | The type of interest category \(checkboxes, dropdown, radio, hidden\) | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryTitle` | string | Yes | The title of the interest category \(e.g., "Email Preferences"\) | +| `interestCategoryType` | string | Yes | The type of interest category: "checkboxes", "dropdown", "radio", or "hidden" | #### Output @@ -1245,9 +1245,9 @@ Update an existing interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | -| `interestCategoryTitle` | string | No | The title of the interest category | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | +| `interestCategoryTitle` | string | No | The title of the interest category \(e.g., "Email Preferences"\) | #### Output @@ -1268,8 +1268,8 @@ Delete an interest category from a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category to delete | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category to delete \(e.g., "xyz789"\) | #### Output @@ -1286,10 +1286,10 @@ Retrieve a list of interests from an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -1310,9 +1310,9 @@ Retrieve details of a specific interest from an interest category in a Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | -| `interestId` | string | Yes | The unique ID for the interest | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | +| `interestId` | string | Yes | The unique ID for the interest \(e.g., "def456"\) | #### Output @@ -1332,9 +1332,9 @@ Create a new interest in an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | -| `interestName` | string | Yes | The name of the interest | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | +| `interestName` | string | Yes | The name of the interest \(e.g., "Weekly Updates"\) | #### Output @@ -1355,10 +1355,10 @@ Update an existing interest in an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | -| `interestId` | string | Yes | The unique ID for the interest | -| `interestName` | string | No | The name of the interest | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | +| `interestId` | string | Yes | The unique ID for the interest \(e.g., "def456"\) | +| `interestName` | string | No | The name of the interest \(e.g., "Weekly Updates"\) | #### Output @@ -1379,9 +1379,9 @@ Delete an interest from an interest category in a Mailchimp audience | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `listId` | string | Yes | The unique ID for the list | -| `interestCategoryId` | string | Yes | The unique ID for the interest category | -| `interestId` | string | Yes | The unique ID for the interest to delete | +| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | +| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | +| `interestId` | string | Yes | The unique ID for the interest to delete \(e.g., "def456"\) | #### Output @@ -1398,8 +1398,8 @@ Retrieve a list of landing pages from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -1420,7 +1420,7 @@ Retrieve details of a specific landing page from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `pageId` | string | Yes | The unique ID for the landing page | +| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | #### Output @@ -1440,8 +1440,8 @@ Create a new landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `landingPageType` | string | Yes | The type of landing page \(signup\) | -| `landingPageTitle` | string | No | The title of the landing page | +| `landingPageType` | string | Yes | The type of landing page: "signup" | +| `landingPageTitle` | string | No | The title of the landing page \(e.g., "Join Our Newsletter"\) | #### Output @@ -1462,8 +1462,8 @@ Update an existing landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `pageId` | string | Yes | The unique ID for the landing page | -| `landingPageTitle` | string | No | The title of the landing page | +| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | +| `landingPageTitle` | string | No | The title of the landing page \(e.g., "Join Our Newsletter"\) | #### Output @@ -1484,7 +1484,7 @@ Delete a landing page from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `pageId` | string | Yes | The unique ID for the landing page to delete | +| `pageId` | string | Yes | The unique ID for the landing page to delete \(e.g., "abc123def4"\) | #### Output @@ -1501,7 +1501,7 @@ Publish a landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `pageId` | string | Yes | The unique ID for the landing page | +| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | #### Output @@ -1520,7 +1520,7 @@ Unpublish a landing page in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `pageId` | string | Yes | The unique ID for the landing page | +| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | #### Output @@ -1539,8 +1539,8 @@ Retrieve a list of batch operations from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `count` | string | No | Number of results \(default: 10, max: 1000\) | -| `offset` | string | No | Number of results to skip | +| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | +| `offset` | string | No | Number of results to skip for pagination | #### Output @@ -1561,7 +1561,7 @@ Retrieve details of a specific batch operation from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `batchId` | string | Yes | The unique ID for the batch operation | +| `batchId` | string | Yes | The unique ID for the batch operation \(e.g., "abc123def4"\) | #### Output @@ -1581,7 +1581,7 @@ Create a new batch operation in Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `operations` | string | Yes | JSON array of operations | +| `operations` | string | Yes | JSON array of batch operations \(e.g., \[\{"method": "POST", "path": "/lists/\{list_id\}/members", "body": "..."\}\]\) | #### Output @@ -1602,7 +1602,7 @@ Delete a batch operation from Mailchimp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailchimp API key with server prefix | -| `batchId` | string | Yes | The unique ID for the batch operation to delete | +| `batchId` | string | Yes | The unique ID for the batch operation to delete \(e.g., "abc123def4"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/mailgun.mdx b/apps/docs/content/docs/en/tools/mailgun.mdx index 0d29cc9c5..547f52578 100644 --- a/apps/docs/content/docs/en/tools/mailgun.mdx +++ b/apps/docs/content/docs/en/tools/mailgun.mdx @@ -45,14 +45,14 @@ Send an email using Mailgun API | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `domain` | string | Yes | Mailgun domain \(e.g., mg.example.com\) | -| `from` | string | Yes | Sender email address | -| `to` | string | Yes | Recipient email address \(comma-separated for multiple\) | -| `subject` | string | Yes | Email subject | +| `domain` | string | Yes | Mailgun sending domain \(e.g., mg.example.com\) | +| `from` | string | Yes | Sender email address \(e.g., sender@example.com or "Name <sender@example.com>"\) | +| `to` | string | Yes | Recipient email address \(e.g., user@example.com\). Use comma-separated values for multiple recipients | +| `subject` | string | Yes | Email subject line | | `text` | string | No | Plain text body of the email | -| `html` | string | No | HTML body of the email | -| `cc` | string | No | CC email address \(comma-separated for multiple\) | -| `bcc` | string | No | BCC email address \(comma-separated for multiple\) | +| `html` | string | No | HTML body of the email \(e.g., "<h1>Hello</h1><p>Message content</p>"\) | +| `cc` | string | No | CC recipient email address \(e.g., cc@example.com\). Use comma-separated values for multiple recipients | +| `bcc` | string | No | BCC recipient email address \(e.g., bcc@example.com\). Use comma-separated values for multiple recipients | | `tags` | string | No | Tags for the email \(comma-separated\) | #### Output @@ -72,7 +72,7 @@ Retrieve a stored message by its key | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `domain` | string | Yes | Mailgun domain | +| `domain` | string | Yes | Mailgun domain for retrieving messages \(e.g., mg.example.com\) | | `messageKey` | string | Yes | Message storage key | #### Output @@ -102,7 +102,7 @@ List events (logs) for messages sent through Mailgun | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `domain` | string | Yes | Mailgun domain | +| `domain` | string | Yes | Mailgun domain for listing events \(e.g., mg.example.com\) | | `event` | string | No | Filter by event type \(accepted, delivered, failed, opened, clicked, etc.\) | | `limit` | number | No | Maximum number of events to return \(default: 100\) | @@ -123,7 +123,7 @@ Create a new mailing list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `address` | string | Yes | Mailing list address \(e.g., list@example.com\) | +| `address` | string | Yes | Mailing list address \(e.g., newsletter@mg.example.com\) | | `name` | string | No | Mailing list name | | `description` | string | No | Mailing list description | | `accessLevel` | string | No | Access level: readonly, members, or everyone | @@ -145,7 +145,7 @@ Get details of a mailing list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `address` | string | Yes | Mailing list address | +| `address` | string | Yes | Mailing list address to retrieve \(e.g., newsletter@mg.example.com\) | #### Output @@ -163,8 +163,8 @@ Add a member to a mailing list | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `listAddress` | string | Yes | Mailing list address | -| `address` | string | Yes | Member email address | +| `listAddress` | string | Yes | Mailing list address \(e.g., list@mg.example.com\) | +| `address` | string | Yes | Member email address to add \(e.g., user@example.com\) | | `name` | string | No | Member name | | `vars` | string | No | JSON string of custom variables | | `subscribed` | boolean | No | Whether the member is subscribed | @@ -204,7 +204,7 @@ Get details of a specific domain | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Mailgun API key | -| `domain` | string | Yes | Domain name | +| `domain` | string | Yes | Domain name to retrieve details for \(e.g., mg.example.com\) | #### Output diff --git a/apps/docs/content/docs/en/tools/mem0.mdx b/apps/docs/content/docs/en/tools/mem0.mdx index 120f825cb..5360e00c5 100644 --- a/apps/docs/content/docs/en/tools/mem0.mdx +++ b/apps/docs/content/docs/en/tools/mem0.mdx @@ -42,8 +42,8 @@ Add memories to Mem0 for persistent storage and retrieval | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | User ID associated with the memory | -| `messages` | json | Yes | Array of message objects with role and content | +| `userId` | string | Yes | User ID associated with the memory \(e.g., "user_123", "alice@example.com"\) | +| `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) | | `apiKey` | string | Yes | Your Mem0 API key | #### Output @@ -65,9 +65,9 @@ Search for memories in Mem0 using semantic search | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | User ID to search memories for | -| `query` | string | Yes | Search query to find relevant memories | -| `limit` | number | No | Maximum number of results to return | +| `userId` | string | Yes | User ID to search memories for \(e.g., "user_123", "alice@example.com"\) | +| `query` | string | Yes | Search query to find relevant memories \(e.g., "What are my favorite foods?"\) | +| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) | | `apiKey` | string | Yes | Your Mem0 API key | #### Output @@ -97,11 +97,11 @@ Retrieve memories from Mem0 by ID or filter criteria | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | User ID to retrieve memories for | -| `memoryId` | string | No | Specific memory ID to retrieve | -| `startDate` | string | No | Start date for filtering by created_at \(format: YYYY-MM-DD\) | -| `endDate` | string | No | End date for filtering by created_at \(format: YYYY-MM-DD\) | -| `limit` | number | No | Maximum number of results to return | +| `userId` | string | Yes | User ID to retrieve memories for \(e.g., "user_123", "alice@example.com"\) | +| `memoryId` | string | No | Specific memory ID to retrieve \(e.g., "mem_abc123"\) | +| `startDate` | string | No | Start date for filtering by created_at \(e.g., "2024-01-15"\) | +| `endDate` | string | No | End date for filtering by created_at \(e.g., "2024-12-31"\) | +| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) | | `apiKey` | string | Yes | Your Mem0 API key | #### Output diff --git a/apps/docs/content/docs/en/tools/microsoft_excel.mdx b/apps/docs/content/docs/en/tools/microsoft_excel.mdx index c93efc9ea..4da61a5b9 100644 --- a/apps/docs/content/docs/en/tools/microsoft_excel.mdx +++ b/apps/docs/content/docs/en/tools/microsoft_excel.mdx @@ -44,7 +44,7 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet to read from | +| `spreadsheetId` | string | Yes | The ID of the spreadsheet/workbook to read from \(e.g., "01ABC123DEF456"\) | | `range` | string | No | The range of cells to read from. Accepts "SheetName!A1:B2" for explicit ranges or just "SheetName" to read the used range of that sheet. If omitted, reads the used range of the first sheet. | #### Output @@ -66,9 +66,9 @@ Write data to a specific sheet in a Microsoft Excel spreadsheet | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `spreadsheetId` | string | Yes | The ID of the spreadsheet to write to | -| `range` | string | No | The range of cells to write to | -| `values` | array | Yes | The data to write to the spreadsheet | +| `spreadsheetId` | string | Yes | The ID of the spreadsheet/workbook to write to \(e.g., "01ABC123DEF456"\) | +| `range` | string | No | The range of cells to write to \(e.g., "Sheet1!A1:B2"\) | +| `values` | array | Yes | The data to write as a 2D array \(e.g., \[\["Name", "Age"\], \["Alice", 30\]\]\) or array of objects | | `valueInputOption` | string | No | The format of the data to write | | `includeValuesInResponse` | boolean | No | Whether to include the written values in the response | diff --git a/apps/docs/content/docs/en/tools/microsoft_planner.mdx b/apps/docs/content/docs/en/tools/microsoft_planner.mdx index 6067e8199..df2a12592 100644 --- a/apps/docs/content/docs/en/tools/microsoft_planner.mdx +++ b/apps/docs/content/docs/en/tools/microsoft_planner.mdx @@ -40,8 +40,8 @@ Read tasks from Microsoft Planner - get all user tasks or all tasks from a speci | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `planId` | string | No | The ID of the plan to get tasks from \(if not provided, gets all user tasks\) | -| `taskId` | string | No | The ID of the task to get | +| `planId` | string | No | The ID of the plan to get tasks from, if not provided gets all user tasks \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | +| `taskId` | string | No | The ID of the task to get \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | #### Output @@ -62,12 +62,12 @@ Create a new task in Microsoft Planner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `planId` | string | Yes | The ID of the plan where the task will be created | -| `title` | string | Yes | The title of the task | +| `planId` | string | Yes | The ID of the plan where the task will be created \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | +| `title` | string | Yes | The title of the task \(e.g., "Review quarterly report"\) | | `description` | string | No | The description of the task | -| `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) | -| `assigneeUserId` | string | No | The user ID to assign the task to | -| `bucketId` | string | No | The bucket ID to place the task in | +| `dueDateTime` | string | No | The due date and time for the task in ISO 8601 format \(e.g., "2025-03-15T17:00:00Z"\) | +| `assigneeUserId` | string | No | The user ID to assign the task to \(e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f"\) | +| `bucketId` | string | No | The bucket ID to place the task in \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | #### Output @@ -88,15 +88,15 @@ Update a task in Microsoft Planner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskId` | string | Yes | The ID of the task to update | +| `taskId` | string | Yes | The ID of the task to update \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `etag` | string | Yes | The ETag value from the task to update \(If-Match header\) | -| `title` | string | No | The new title of the task | -| `bucketId` | string | No | The bucket ID to move the task to | -| `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) | +| `title` | string | No | The new title of the task \(e.g., "Review quarterly report"\) | +| `bucketId` | string | No | The bucket ID to move the task to \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | +| `dueDateTime` | string | No | The due date and time for the task in ISO 8601 format \(e.g., "2025-03-15T17:00:00Z"\) | | `startDateTime` | string | No | The start date and time for the task \(ISO 8601 format\) | | `percentComplete` | number | No | The percentage of task completion \(0-100\) | | `priority` | number | No | The priority of the task \(0-10\) | -| `assigneeUserId` | string | No | The user ID to assign the task to | +| `assigneeUserId` | string | No | The user ID to assign the task to \(e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f"\) | #### Output @@ -120,7 +120,7 @@ Delete a task from Microsoft Planner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskId` | string | Yes | The ID of the task to delete | +| `taskId` | string | Yes | The ID of the task to delete \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `etag` | string | Yes | The ETag value from the task to delete \(If-Match header\) | #### Output @@ -158,7 +158,7 @@ Get details of a specific Microsoft Planner plan | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `planId` | string | Yes | The ID of the plan to retrieve | +| `planId` | string | Yes | The ID of the plan to retrieve \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | #### Output @@ -178,7 +178,7 @@ List all buckets in a Microsoft Planner plan | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `planId` | string | Yes | The ID of the plan | +| `planId` | string | Yes | The ID of the plan \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | #### Output @@ -198,7 +198,7 @@ Get details of a specific bucket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `bucketId` | string | Yes | The ID of the bucket to retrieve | +| `bucketId` | string | Yes | The ID of the bucket to retrieve \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | #### Output @@ -218,7 +218,7 @@ Create a new bucket in a Microsoft Planner plan | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `planId` | string | Yes | The ID of the plan where the bucket will be created | +| `planId` | string | Yes | The ID of the plan where the bucket will be created \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | | `name` | string | Yes | The name of the bucket | #### Output @@ -239,7 +239,7 @@ Update a bucket in Microsoft Planner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `bucketId` | string | Yes | The ID of the bucket to update | +| `bucketId` | string | Yes | The ID of the bucket to update \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `name` | string | No | The new name of the bucket | | `etag` | string | Yes | The ETag value from the bucket to update \(If-Match header\) | @@ -261,7 +261,7 @@ Delete a bucket from Microsoft Planner | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `bucketId` | string | Yes | The ID of the bucket to delete | +| `bucketId` | string | Yes | The ID of the bucket to delete \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `etag` | string | Yes | The ETag value from the bucket to delete \(If-Match header\) | #### Output @@ -280,7 +280,7 @@ Get detailed information about a task including checklist and references | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskId` | string | Yes | The ID of the task | +| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | #### Output @@ -300,7 +300,7 @@ Update task details including description, checklist items, and references in Mi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskId` | string | Yes | The ID of the task | +| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `etag` | string | Yes | The ETag value from the task details to update \(If-Match header\) | | `description` | string | No | The description of the task | | `checklist` | object | No | Checklist items as a JSON object | diff --git a/apps/docs/content/docs/en/tools/microsoft_teams.mdx b/apps/docs/content/docs/en/tools/microsoft_teams.mdx index 7603f76fc..f4964250e 100644 --- a/apps/docs/content/docs/en/tools/microsoft_teams.mdx +++ b/apps/docs/content/docs/en/tools/microsoft_teams.mdx @@ -43,7 +43,7 @@ Read content from a Microsoft Teams chat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `chatId` | string | Yes | The ID of the chat to read from | +| `chatId` | string | Yes | The ID of the chat to read from \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | | `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage | #### Output @@ -67,8 +67,8 @@ Write or update content in a Microsoft Teams chat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `chatId` | string | Yes | The ID of the chat to write to | -| `content` | string | Yes | The content to write to the message | +| `chatId` | string | Yes | The ID of the chat to write to \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | +| `content` | string | Yes | The content to write to the message \(plain text or HTML formatted, supports @mentions\) | | `files` | file[] | No | Files to attach to the message | #### Output @@ -90,8 +90,8 @@ Read content from a Microsoft Teams channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team to read from | -| `channelId` | string | Yes | The ID of the channel to read from | +| `teamId` | string | Yes | The ID of the team to read from \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | +| `channelId` | string | Yes | The ID of the channel to read from \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage | #### Output @@ -116,9 +116,9 @@ Write or send a message to a Microsoft Teams channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team to write to | -| `channelId` | string | Yes | The ID of the channel to write to | -| `content` | string | Yes | The content to write to the channel | +| `teamId` | string | Yes | The ID of the team to write to \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | +| `channelId` | string | Yes | The ID of the channel to write to \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | +| `content` | string | Yes | The content to write to the channel \(plain text or HTML formatted, supports @mentions\) | | `files` | file[] | No | Files to attach to the message | #### Output @@ -141,9 +141,9 @@ Update an existing message in a Microsoft Teams chat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `chatId` | string | Yes | The ID of the chat containing the message | -| `messageId` | string | Yes | The ID of the message to update | -| `content` | string | Yes | The new content for the message | +| `chatId` | string | Yes | The ID of the chat containing the message \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | +| `messageId` | string | Yes | The ID of the message to update \(e.g., "1234567890123" - a numeric string from message responses\) | +| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) | #### Output @@ -161,10 +161,10 @@ Update an existing message in a Microsoft Teams channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team | -| `channelId` | string | Yes | The ID of the channel containing the message | -| `messageId` | string | Yes | The ID of the message to update | -| `content` | string | Yes | The new content for the message | +| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) | +| `channelId` | string | Yes | The ID of the channel containing the message \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | +| `messageId` | string | Yes | The ID of the message to update \(e.g., "1234567890123" - a numeric string from message responses\) | +| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) | #### Output @@ -182,8 +182,8 @@ Soft delete a message in a Microsoft Teams chat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `chatId` | string | Yes | The ID of the chat containing the message | -| `messageId` | string | Yes | The ID of the message to delete | +| `chatId` | string | Yes | The ID of the chat containing the message \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | +| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) | #### Output @@ -201,9 +201,9 @@ Soft delete a message in a Microsoft Teams channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team | -| `channelId` | string | Yes | The ID of the channel containing the message | -| `messageId` | string | Yes | The ID of the message to delete | +| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) | +| `channelId` | string | Yes | The ID of the channel containing the message \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | +| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) | #### Output @@ -221,10 +221,10 @@ Reply to an existing message in a Microsoft Teams channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team | -| `channelId` | string | Yes | The ID of the channel | -| `messageId` | string | Yes | The ID of the message to reply to | -| `content` | string | Yes | The reply content | +| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) | +| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | +| `messageId` | string | Yes | The ID of the message to reply to \(e.g., "1234567890123" - a numeric string from message responses\) | +| `content` | string | Yes | The reply content \(plain text or HTML formatted message\) | #### Output @@ -242,10 +242,10 @@ Get a specific message from a Microsoft Teams chat or channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | No | The ID of the team \(for channel messages\) | -| `channelId` | string | No | The ID of the channel \(for channel messages\) | -| `chatId` | string | No | The ID of the chat \(for chat messages\) | -| `messageId` | string | Yes | The ID of the message to retrieve | +| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) | +| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) | +| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) | +| `messageId` | string | Yes | The ID of the message to retrieve \(e.g., "1234567890123" - a numeric string from message responses\) | #### Output @@ -272,10 +272,10 @@ Add an emoji reaction to a message in Microsoft Teams | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | No | The ID of the team \(for channel messages\) | -| `channelId` | string | No | The ID of the channel \(for channel messages\) | -| `chatId` | string | No | The ID of the chat \(for chat messages\) | -| `messageId` | string | Yes | The ID of the message to react to | +| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) | +| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) | +| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) | +| `messageId` | string | Yes | The ID of the message to react to \(e.g., "1234567890123" - a numeric string from message responses\) | | `reactionType` | string | Yes | The emoji reaction \(e.g., ❤️, 👍, 😊\) | #### Output @@ -294,10 +294,10 @@ Remove an emoji reaction from a message in Microsoft Teams | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | No | The ID of the team \(for channel messages\) | -| `channelId` | string | No | The ID of the channel \(for channel messages\) | -| `chatId` | string | No | The ID of the chat \(for chat messages\) | -| `messageId` | string | Yes | The ID of the message | +| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) | +| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) | +| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) | +| `messageId` | string | Yes | The ID of the message \(e.g., "1234567890123" - a numeric string from message responses\) | | `reactionType` | string | Yes | The emoji reaction to remove \(e.g., ❤️, 👍, 😊\) | #### Output @@ -316,7 +316,7 @@ List all members of a Microsoft Teams team | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team | +| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | #### Output @@ -334,8 +334,8 @@ List all members of a Microsoft Teams channel | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `teamId` | string | Yes | The ID of the team | -| `channelId` | string | Yes | The ID of the channel | +| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | +| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | #### Output diff --git a/apps/docs/content/docs/en/tools/mongodb.mdx b/apps/docs/content/docs/en/tools/mongodb.mdx index dc69d59d1..e785fa34c 100644 --- a/apps/docs/content/docs/en/tools/mongodb.mdx +++ b/apps/docs/content/docs/en/tools/mongodb.mdx @@ -43,7 +43,7 @@ Execute find operation on MongoDB collection | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MongoDB server hostname or IP address | | `port` | number | Yes | MongoDB server port \(default: 27017\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `username` | string | No | MongoDB username | | `password` | string | No | MongoDB password | | `authSource` | string | No | Authentication database | @@ -71,7 +71,7 @@ Insert documents into MongoDB collection | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MongoDB server hostname or IP address | | `port` | number | Yes | MongoDB server port \(default: 27017\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `username` | string | No | MongoDB username | | `password` | string | No | MongoDB password | | `authSource` | string | No | Authentication database | @@ -98,7 +98,7 @@ Update documents in MongoDB collection | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MongoDB server hostname or IP address | | `port` | number | Yes | MongoDB server port \(default: 27017\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `username` | string | No | MongoDB username | | `password` | string | No | MongoDB password | | `authSource` | string | No | Authentication database | @@ -129,7 +129,7 @@ Delete documents from MongoDB collection | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MongoDB server hostname or IP address | | `port` | number | Yes | MongoDB server port \(default: 27017\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `username` | string | No | MongoDB username | | `password` | string | No | MongoDB password | | `authSource` | string | No | Authentication database | @@ -156,7 +156,7 @@ Execute MongoDB aggregation pipeline | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MongoDB server hostname or IP address | | `port` | number | Yes | MongoDB server port \(default: 27017\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `username` | string | No | MongoDB username | | `password` | string | No | MongoDB password | | `authSource` | string | No | Authentication database | @@ -182,7 +182,7 @@ Introspect MongoDB database to list databases, collections, and indexes | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MongoDB server hostname or IP address | | `port` | number | Yes | MongoDB server port \(default: 27017\) | -| `database` | string | No | Database name to introspect \(optional - if not provided, lists all databases\) | +| `database` | string | No | Database name to introspect \(e.g., "mydb"\). If not provided, lists all databases | | `username` | string | No | MongoDB username | | `password` | string | No | MongoDB password | | `authSource` | string | No | Authentication database | diff --git a/apps/docs/content/docs/en/tools/mysql.mdx b/apps/docs/content/docs/en/tools/mysql.mdx index 1d9d6c1d8..27e34d190 100644 --- a/apps/docs/content/docs/en/tools/mysql.mdx +++ b/apps/docs/content/docs/en/tools/mysql.mdx @@ -43,11 +43,11 @@ Execute SELECT query on MySQL database | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MySQL server hostname or IP address | | `port` | number | Yes | MySQL server port \(default: 3306\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `username` | string | Yes | Database username | | `password` | string | Yes | Database password | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | -| `query` | string | Yes | SQL SELECT query to execute | +| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE active = 1\) | #### Output @@ -67,11 +67,11 @@ Insert new record into MySQL database | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MySQL server hostname or IP address | | `port` | number | Yes | MySQL server port \(default: 3306\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `username` | string | Yes | Database username | | `password` | string | Yes | Database password | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | -| `table` | string | Yes | Table name to insert into | +| `table` | string | Yes | Table name to insert into \(e.g., users, orders\) | | `data` | object | Yes | Data to insert as key-value pairs | #### Output @@ -92,11 +92,11 @@ Update existing records in MySQL database | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MySQL server hostname or IP address | | `port` | number | Yes | MySQL server port \(default: 3306\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `username` | string | Yes | Database username | | `password` | string | Yes | Database password | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | -| `table` | string | Yes | Table name to update | +| `table` | string | Yes | Table name to update \(e.g., users, orders\) | | `data` | object | Yes | Data to update as key-value pairs | | `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) | @@ -118,11 +118,11 @@ Delete records from MySQL database | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MySQL server hostname or IP address | | `port` | number | Yes | MySQL server port \(default: 3306\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `username` | string | Yes | Database username | | `password` | string | Yes | Database password | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | -| `table` | string | Yes | Table name to delete from | +| `table` | string | Yes | Table name to delete from \(e.g., users, orders\) | | `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) | #### Output @@ -143,11 +143,11 @@ Execute raw SQL query on MySQL database | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MySQL server hostname or IP address | | `port` | number | Yes | MySQL server port \(default: 3306\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `username` | string | Yes | Database username | | `password` | string | Yes | Database password | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | -| `query` | string | Yes | Raw SQL query to execute | +| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id INT PRIMARY KEY, name VARCHAR\(255\)\)\) | #### Output @@ -167,7 +167,7 @@ Introspect MySQL database schema to retrieve table structures, columns, and rela | --------- | ---- | -------- | ----------- | | `host` | string | Yes | MySQL server hostname or IP address | | `port` | number | Yes | MySQL server port \(default: 3306\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `username` | string | Yes | Database username | | `password` | string | Yes | Database password | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | diff --git a/apps/docs/content/docs/en/tools/neo4j.mdx b/apps/docs/content/docs/en/tools/neo4j.mdx index 9c81431eb..944117c21 100644 --- a/apps/docs/content/docs/en/tools/neo4j.mdx +++ b/apps/docs/content/docs/en/tools/neo4j.mdx @@ -44,11 +44,11 @@ Execute MATCH queries to read nodes and relationships from Neo4j graph database. | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | -| `cypherQuery` | string | Yes | Cypher query to execute \(typically MATCH statements\) | +| `cypherQuery` | string | Yes | Cypher query to execute \(e.g., "MATCH \(n:Person\) RETURN n LIMIT 10", "MATCH \(a\)-\[r\]->\(b\) WHERE a.name = $name RETURN a, r, b"\) | | `parameters` | object | No | Parameters for the Cypher query as a JSON object. Use for any dynamic values including LIMIT \(e.g., query: "MATCH \(n\) RETURN n LIMIT $limit", parameters: \{limit: 100\}\). | | `parameters` | string | No | No description | @@ -71,12 +71,12 @@ Execute CREATE statements to add new nodes and relationships to Neo4j graph data | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | -| `cypherQuery` | string | Yes | Cypher CREATE statement to execute | -| `parameters` | object | No | Parameters for the Cypher query as a JSON object | +| `cypherQuery` | string | Yes | Cypher CREATE statement to execute \(e.g., "CREATE \(n:Person \{name: $name, age: $age\}\)", "CREATE \(a\)-\[:KNOWS\]->\(b\)"\) | +| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 30\}\) | #### Output @@ -95,12 +95,12 @@ Execute MERGE statements to find or create nodes and relationships in Neo4j (ups | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | -| `cypherQuery` | string | Yes | Cypher MERGE statement to execute | -| `parameters` | object | No | Parameters for the Cypher query as a JSON object | +| `cypherQuery` | string | Yes | Cypher MERGE statement to execute \(e.g., "MERGE \(n:Person \{name: $name\}\) ON CREATE SET n.created = timestamp\(\)", "MERGE \(a\)-\[r:KNOWS\]->\(b\)"\) | +| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "email": "alice@example.com"\}\) | #### Output @@ -119,12 +119,12 @@ Execute SET statements to update properties of existing nodes and relationships | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | -| `cypherQuery` | string | Yes | Cypher query with MATCH and SET statements to update properties | -| `parameters` | object | No | Parameters for the Cypher query as a JSON object | +| `cypherQuery` | string | Yes | Cypher query with MATCH and SET statements to update properties \(e.g., "MATCH \(n:Person \{name: $name\}\) SET n.age = $age", "MATCH \(n\) WHERE n.id = $id SET n += $props"\) | +| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 31, "props": \{"city": "NYC"\}\}\) | #### Output @@ -143,12 +143,12 @@ Execute DELETE or DETACH DELETE statements to remove nodes and relationships fro | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | -| `cypherQuery` | string | Yes | Cypher query with MATCH and DELETE/DETACH DELETE statements | -| `parameters` | object | No | Parameters for the Cypher query as a JSON object | +| `cypherQuery` | string | Yes | Cypher query with MATCH and DELETE/DETACH DELETE statements \(e.g., "MATCH \(n:Person \{name: $name\}\) DELETE n", "MATCH \(n\) DETACH DELETE n"\) | +| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "id": 123\}\) | | `detach` | boolean | No | Whether to use DETACH DELETE to remove relationships before deleting nodes | #### Output @@ -168,12 +168,12 @@ Execute arbitrary Cypher queries on Neo4j graph database for complex operations | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | -| `cypherQuery` | string | Yes | Cypher query to execute \(any valid Cypher statement\) | -| `parameters` | object | No | Parameters for the Cypher query as a JSON object | +| `cypherQuery` | string | Yes | Cypher query to execute \(e.g., "CALL db.labels\(\)", "MATCH \(n\) RETURN count\(n\)", "CREATE INDEX FOR \(n:Person\) ON \(n.name\)"\) | +| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "limit": 100\}\) | #### Output @@ -194,7 +194,7 @@ Introspect a Neo4j database to discover its schema including node labels, relati | --------- | ---- | -------- | ----------- | | `host` | string | Yes | Neo4j server hostname or IP address | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | -| `database` | string | Yes | Database name to connect to | +| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `username` | string | Yes | Neo4j username | | `password` | string | Yes | Neo4j password | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | diff --git a/apps/docs/content/docs/en/tools/notion.mdx b/apps/docs/content/docs/en/tools/notion.mdx index a64ef1744..63529a832 100644 --- a/apps/docs/content/docs/en/tools/notion.mdx +++ b/apps/docs/content/docs/en/tools/notion.mdx @@ -26,7 +26,7 @@ Read content from a Notion page | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `pageId` | string | Yes | The ID of the Notion page to read | +| `pageId` | string | Yes | The UUID of the Notion page to read | #### Output @@ -46,7 +46,7 @@ Read database information and structure from Notion | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `databaseId` | string | Yes | The ID of the Notion database to read | +| `databaseId` | string | Yes | The UUID of the Notion database to read | #### Output @@ -67,7 +67,7 @@ Append content to a Notion page | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `pageId` | string | Yes | The ID of the Notion page to append content to | +| `pageId` | string | Yes | The UUID of the Notion page to append content to | | `content` | string | Yes | The content to append to the page | #### Output @@ -84,7 +84,7 @@ Create a new page in Notion | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `parentId` | string | Yes | ID of the parent page | +| `parentId` | string | Yes | The UUID of the parent Notion page where this page will be created | | `title` | string | No | Title of the new page | | `content` | string | No | Optional content to add to the page upon creation | @@ -106,7 +106,7 @@ Query and filter Notion database entries with advanced filtering | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `databaseId` | string | Yes | The ID of the database to query | +| `databaseId` | string | Yes | The UUID of the Notion database to query | | `filter` | string | No | Filter conditions as JSON \(optional\) | | `sorts` | string | No | Sort criteria as JSON array \(optional\) | | `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) | @@ -162,8 +162,8 @@ Search across all pages and databases in Notion workspace | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | No | Search terms \(leave empty to get all pages\) | -| `filterType` | string | No | Filter by object type: page, database, or leave empty for all | +| `query` | string | No | Search terms to find pages and databases \(leave empty to get all pages\) | +| `filterType` | string | No | Filter by object type: "page", "database", or leave empty for all | | `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) | #### Output diff --git a/apps/docs/content/docs/en/tools/onedrive.mdx b/apps/docs/content/docs/en/tools/onedrive.mdx index 5e8f4b04b..2326f5e0f 100644 --- a/apps/docs/content/docs/en/tools/onedrive.mdx +++ b/apps/docs/content/docs/en/tools/onedrive.mdx @@ -44,11 +44,11 @@ Upload a file to OneDrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `fileName` | string | Yes | The name of the file to upload | +| `fileName` | string | Yes | The name of the file to upload \(e.g., "report.pdf", "data.xlsx"\) | | `file` | file | No | The file to upload \(binary\) | | `content` | string | No | The text content to upload \(if no file is provided\) | | `mimeType` | string | No | The MIME type of the file to create \(e.g., text/plain for .txt, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for .xlsx\) | -| `folderSelector` | string | No | Select the folder to upload the file to | +| `folderSelector` | string | No | Folder ID to upload the file to \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `manualFolderId` | string | No | Manually entered folder ID \(advanced mode\) | #### Output @@ -66,8 +66,8 @@ Create a new folder in OneDrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `folderName` | string | Yes | Name of the folder to create | -| `folderSelector` | string | No | Select the parent folder to create the folder in | +| `folderName` | string | Yes | Name of the folder to create \(e.g., "My Documents", "Project Files"\) | +| `folderSelector` | string | No | Parent folder ID to create the folder in \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) | #### Output @@ -85,8 +85,8 @@ Download a file from OneDrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `fileId` | string | Yes | The ID of the file to download | -| `fileName` | string | No | Optional filename override | +| `fileId` | string | Yes | The ID of the file to download \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | +| `fileName` | string | No | Optional filename override \(e.g., "report.pdf", "data.xlsx"\) | #### Output @@ -102,10 +102,10 @@ List files and folders in OneDrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `folderSelector` | string | No | Select the folder to list files from | +| `folderSelector` | string | No | Folder ID to list files from \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `manualFolderId` | string | No | The manually entered folder ID \(advanced mode\) | -| `query` | string | No | A query to filter the files | -| `pageSize` | number | No | The number of files to return | +| `query` | string | No | Filter files by name prefix \(e.g., "report", "invoice_2024"\) | +| `pageSize` | number | No | Maximum number of files to return \(e.g., 10, 50, 100\) | #### Output @@ -123,7 +123,7 @@ Delete a file or folder from OneDrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `fileId` | string | Yes | The ID of the file or folder to delete | +| `fileId` | string | Yes | The ID of the file or folder to delete \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/outlook.mdx b/apps/docs/content/docs/en/tools/outlook.mdx index df2326693..67123f889 100644 --- a/apps/docs/content/docs/en/tools/outlook.mdx +++ b/apps/docs/content/docs/en/tools/outlook.mdx @@ -51,7 +51,7 @@ Send emails using Outlook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `to` | string | Yes | Recipient email address | +| `to` | string | Yes | Recipient email address \(comma-separated for multiple recipients\) | | `subject` | string | Yes | Email subject | | `body` | string | Yes | Email body content | | `contentType` | string | No | Content type for the email body \(text or html\) | @@ -105,9 +105,9 @@ Read emails from Outlook | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `folder` | string | No | Folder ID to read emails from \(default: Inbox\) | +| `folder` | string | No | Folder ID to read emails from \(e.g., "Inbox", "Drafts", or a folder ID\) | | `maxResults` | number | No | Maximum number of emails to retrieve \(default: 1, max: 10\) | -| `includeAttachments` | boolean | No | Download and include email attachments | +| `includeAttachments` | boolean | No | Whether to download and include email attachments | #### Output diff --git a/apps/docs/content/docs/en/tools/perplexity.mdx b/apps/docs/content/docs/en/tools/perplexity.mdx index 10311c030..75efe7a48 100644 --- a/apps/docs/content/docs/en/tools/perplexity.mdx +++ b/apps/docs/content/docs/en/tools/perplexity.mdx @@ -45,9 +45,9 @@ Generate completions using Perplexity AI chat models | --------- | ---- | -------- | ----------- | | `systemPrompt` | string | No | System prompt to guide the model behavior | | `content` | string | Yes | The user message content to send to the model | -| `model` | string | Yes | Model to use for chat completions \(e.g., sonar, mistral\) | -| `max_tokens` | number | No | Maximum number of tokens to generate | -| `temperature` | number | No | Sampling temperature between 0 and 1 | +| `model` | string | Yes | Model to use for chat completions \(e.g., "sonar", "sonar-pro", "sonar-reasoning"\) | +| `max_tokens` | number | No | Maximum number of tokens to generate \(e.g., 1024, 2048, 4096\) | +| `temperature` | number | No | Sampling temperature between 0 and 1 \(e.g., 0.0 for deterministic, 0.7 for creative\) | | `apiKey` | string | Yes | Perplexity API key | #### Output @@ -71,10 +71,10 @@ Get ranked search results from Perplexity | --------- | ---- | -------- | ----------- | | `query` | string | Yes | A search query or array of queries \(max 5 for multi-query search\) | | `max_results` | number | No | Maximum number of search results to return \(1-20, default: 10\) | -| `search_domain_filter` | array | No | List of domains/URLs to limit search results to \(max 20\) | +| `search_domain_filter` | array | No | List of domains/URLs to limit search results to \(e.g., \["github.com", "stackoverflow.com"\], max 20\) | | `max_tokens_per_page` | number | No | Maximum number of tokens retrieved from each webpage \(default: 1024\) | | `country` | string | No | Country code to filter search results \(e.g., US, GB, DE\) | -| `search_recency_filter` | string | No | Filter results by recency: hour, day, week, month, or year | +| `search_recency_filter` | string | No | Filter results by recency \(e.g., "hour", "day", "week", "month", "year"\) | | `search_after_date` | string | No | Include only content published after this date \(format: MM/DD/YYYY\) | | `search_before_date` | string | No | Include only content published before this date \(format: MM/DD/YYYY\) | | `apiKey` | string | Yes | Perplexity API key | diff --git a/apps/docs/content/docs/en/tools/pinecone.mdx b/apps/docs/content/docs/en/tools/pinecone.mdx index bb6b35b4e..abda1f1f6 100644 --- a/apps/docs/content/docs/en/tools/pinecone.mdx +++ b/apps/docs/content/docs/en/tools/pinecone.mdx @@ -64,8 +64,8 @@ Insert or update text records in a Pinecone index | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `indexHost` | string | Yes | Full Pinecone index host URL | -| `namespace` | string | Yes | Namespace to upsert records into | +| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | +| `namespace` | string | Yes | Namespace to upsert records into \(e.g., "documents", "embeddings"\) | | `records` | array | Yes | Record or array of records to upsert, each containing _id, text, and optional metadata | | `apiKey` | string | Yes | Pinecone API key | @@ -83,12 +83,12 @@ Search for similar text in a Pinecone index | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `indexHost` | string | Yes | Full Pinecone index host URL | -| `namespace` | string | No | Namespace to search in | +| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | +| `namespace` | string | No | Namespace to search in \(e.g., "documents", "embeddings"\) | | `searchQuery` | string | Yes | Text to search for | -| `topK` | string | No | Number of results to return | +| `topK` | string | No | Number of results to return \(e.g., "10", "25"\) | | `fields` | array | No | Fields to return in the results | -| `filter` | object | No | Filter to apply to the search | +| `filter` | object | No | Filter to apply to the search \(e.g., \{"category": "tech", "year": \{"$gte": 2020\}\}\) | | `rerank` | object | No | Reranking parameters | | `apiKey` | string | Yes | Pinecone API key | @@ -113,13 +113,13 @@ Search for similar vectors in a Pinecone index | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `indexHost` | string | Yes | Full Pinecone index host URL | -| `namespace` | string | No | Namespace to search in | +| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | +| `namespace` | string | No | Namespace to search in \(e.g., "documents", "embeddings"\) | | `vector` | array | Yes | Vector to search for | -| `topK` | number | No | Number of results to return | -| `filter` | object | No | Filter to apply to the search | +| `topK` | number | No | Number of results to return \(e.g., 10, 25\) | +| `filter` | object | No | Filter to apply to the search \(e.g., \{"category": "tech", "year": \{"$gte": 2020\}\}\) | | `includeValues` | boolean | No | Include vector values in response | -| `includeMetadata` | boolean | No | Include metadata in response | +| `includeMetadata` | boolean | No | Include metadata in response \(true/false\) | | `apiKey` | string | Yes | Pinecone API key | #### Output @@ -137,9 +137,9 @@ Fetch vectors by ID from a Pinecone index | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `indexHost` | string | Yes | Full Pinecone index host URL | -| `ids` | array | Yes | Array of vector IDs to fetch | -| `namespace` | string | No | Namespace to fetch vectors from | +| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | +| `ids` | array | Yes | Array of vector IDs to fetch \(e.g., \["vec-001", "vec-002"\]\) | +| `namespace` | string | No | Namespace to fetch vectors from \(e.g., "documents", "embeddings"\) | | `apiKey` | string | Yes | Pinecone API key | #### Output diff --git a/apps/docs/content/docs/en/tools/pipedrive.mdx b/apps/docs/content/docs/en/tools/pipedrive.mdx index 16db1bc99..fcaf58cef 100644 --- a/apps/docs/content/docs/en/tools/pipedrive.mdx +++ b/apps/docs/content/docs/en/tools/pipedrive.mdx @@ -44,11 +44,11 @@ Retrieve all deals from Pipedrive with optional filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `status` | string | No | Only fetch deals with a specific status. Values: open, won, lost. If omitted, all not deleted deals are returned | -| `person_id` | string | No | If supplied, only deals linked to the specified person are returned | -| `org_id` | string | No | If supplied, only deals linked to the specified organization are returned | -| `pipeline_id` | string | No | If supplied, only deals in the specified pipeline are returned | +| `person_id` | string | No | If supplied, only deals linked to the specified person are returned \(e.g., "456"\) | +| `org_id` | string | No | If supplied, only deals linked to the specified organization are returned \(e.g., "789"\) | +| `pipeline_id` | string | No | If supplied, only deals in the specified pipeline are returned \(e.g., "1"\) | | `updated_since` | string | No | If set, only deals updated after this time are returned. Format: 2025-01-01T10:20:00Z | -| `limit` | string | No | Number of results to return \(default: 100, max: 500\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | #### Output @@ -84,7 +84,7 @@ Retrieve detailed information about a specific deal | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `deal_id` | string | Yes | The ID of the deal to retrieve | +| `deal_id` | string | Yes | The ID of the deal to retrieve \(e.g., "123"\) | #### Output @@ -101,15 +101,15 @@ Create a new deal in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `title` | string | Yes | The title of the deal | -| `value` | string | No | The monetary value of the deal | -| `currency` | string | No | Currency code \(e.g., USD, EUR\) | -| `person_id` | string | No | ID of the person this deal is associated with | -| `org_id` | string | No | ID of the organization this deal is associated with | -| `pipeline_id` | string | No | ID of the pipeline this deal should be placed in | -| `stage_id` | string | No | ID of the stage this deal should be placed in | +| `title` | string | Yes | The title of the deal \(e.g., "Enterprise Software License"\) | +| `value` | string | No | The monetary value of the deal \(e.g., "5000"\) | +| `currency` | string | No | Currency code \(e.g., "USD", "EUR", "GBP"\) | +| `person_id` | string | No | ID of the person this deal is associated with \(e.g., "456"\) | +| `org_id` | string | No | ID of the organization this deal is associated with \(e.g., "789"\) | +| `pipeline_id` | string | No | ID of the pipeline this deal should be placed in \(e.g., "1"\) | +| `stage_id` | string | No | ID of the stage this deal should be placed in \(e.g., "2"\) | | `status` | string | No | Status of the deal: open, won, lost | -| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format | +| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format \(e.g., "2025-06-30"\) | #### Output @@ -126,12 +126,12 @@ Update an existing deal in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `deal_id` | string | Yes | The ID of the deal to update | -| `title` | string | No | New title for the deal | -| `value` | string | No | New monetary value for the deal | +| `deal_id` | string | Yes | The ID of the deal to update \(e.g., "123"\) | +| `title` | string | No | New title for the deal \(e.g., "Updated Enterprise License"\) | +| `value` | string | No | New monetary value for the deal \(e.g., "7500"\) | | `status` | string | No | New status: open, won, lost | -| `stage_id` | string | No | New stage ID for the deal | -| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format | +| `stage_id` | string | No | New stage ID for the deal \(e.g., "3"\) | +| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format \(e.g., "2025-07-15"\) | #### Output @@ -148,10 +148,10 @@ Retrieve files from Pipedrive with optional filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `deal_id` | string | No | Filter files by deal ID | -| `person_id` | string | No | Filter files by person ID | -| `org_id` | string | No | Filter files by organization ID | -| `limit` | string | No | Number of results to return \(default: 100, max: 500\) | +| `deal_id` | string | No | Filter files by deal ID \(e.g., "123"\) | +| `person_id` | string | No | Filter files by person ID \(e.g., "456"\) | +| `org_id` | string | No | Filter files by organization ID \(e.g., "789"\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | #### Output @@ -180,7 +180,7 @@ Retrieve mail threads from Pipedrive mailbox | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `folder` | string | No | Filter by folder: inbox, drafts, sent, archive \(default: inbox\) | -| `limit` | string | No | Number of results to return \(default: 50\) | +| `limit` | string | No | Number of results to return \(e.g., "25", default: 50\) | #### Output @@ -198,7 +198,7 @@ Retrieve all messages from a specific mail thread | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `thread_id` | string | Yes | The ID of the mail thread | +| `thread_id` | string | Yes | The ID of the mail thread \(e.g., "12345"\) | #### Output @@ -218,7 +218,7 @@ Retrieve all pipelines from Pipedrive | --------- | ---- | -------- | ----------- | | `sort_by` | string | No | Field to sort by: id, update_time, add_time \(default: id\) | | `sort_direction` | string | No | Sorting direction: asc, desc \(default: asc\) | -| `limit` | string | No | Number of results to return \(default: 100, max: 500\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | | `cursor` | string | No | For pagination, the marker representing the first item on the next page | #### Output @@ -245,10 +245,10 @@ Retrieve all deals in a specific pipeline | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `pipeline_id` | string | Yes | The ID of the pipeline | -| `stage_id` | string | No | Filter by specific stage within the pipeline | +| `pipeline_id` | string | Yes | The ID of the pipeline \(e.g., "1"\) | +| `stage_id` | string | No | Filter by specific stage within the pipeline \(e.g., "2"\) | | `status` | string | No | Filter by deal status: open, won, lost | -| `limit` | string | No | Number of results to return \(default: 100, max: 500\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | #### Output @@ -266,9 +266,9 @@ Retrieve all projects or a specific project from Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `project_id` | string | No | Optional: ID of a specific project to retrieve | +| `project_id` | string | No | Optional: ID of a specific project to retrieve \(e.g., "123"\) | | `status` | string | No | Filter by project status: open, completed, deleted \(only for listing all\) | -| `limit` | string | No | Number of results to return \(default: 100, max: 500, only for listing all\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500, only for listing all\) | #### Output @@ -287,10 +287,10 @@ Create a new project in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `title` | string | Yes | The title of the project | +| `title` | string | Yes | The title of the project \(e.g., "Q2 Marketing Campaign"\) | | `description` | string | No | Description of the project | -| `start_date` | string | No | Project start date in YYYY-MM-DD format | -| `end_date` | string | No | Project end date in YYYY-MM-DD format | +| `start_date` | string | No | Project start date in YYYY-MM-DD format \(e.g., "2025-04-01"\) | +| `end_date` | string | No | Project end date in YYYY-MM-DD format \(e.g., "2025-06-30"\) | #### Output @@ -307,12 +307,12 @@ Retrieve activities (tasks) from Pipedrive with optional filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `deal_id` | string | No | Filter activities by deal ID | -| `person_id` | string | No | Filter activities by person ID | -| `org_id` | string | No | Filter activities by organization ID | +| `deal_id` | string | No | Filter activities by deal ID \(e.g., "123"\) | +| `person_id` | string | No | Filter activities by person ID \(e.g., "456"\) | +| `org_id` | string | No | Filter activities by organization ID \(e.g., "789"\) | | `type` | string | No | Filter by activity type \(call, meeting, task, deadline, email, lunch\) | | `done` | string | No | Filter by completion status: 0 for not done, 1 for done | -| `limit` | string | No | Number of results to return \(default: 100, max: 500\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | #### Output @@ -343,14 +343,14 @@ Create a new activity (task) in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `subject` | string | Yes | The subject/title of the activity | +| `subject` | string | Yes | The subject/title of the activity \(e.g., "Follow up call with John"\) | | `type` | string | Yes | Activity type: call, meeting, task, deadline, email, lunch | -| `due_date` | string | Yes | Due date in YYYY-MM-DD format | -| `due_time` | string | No | Due time in HH:MM format | -| `duration` | string | No | Duration in HH:MM format | -| `deal_id` | string | No | ID of the deal to associate with | -| `person_id` | string | No | ID of the person to associate with | -| `org_id` | string | No | ID of the organization to associate with | +| `due_date` | string | Yes | Due date in YYYY-MM-DD format \(e.g., "2025-03-15"\) | +| `due_time` | string | No | Due time in HH:MM format \(e.g., "14:30"\) | +| `duration` | string | No | Duration in HH:MM format \(e.g., "01:00" for 1 hour\) | +| `deal_id` | string | No | ID of the deal to associate with \(e.g., "123"\) | +| `person_id` | string | No | ID of the person to associate with \(e.g., "456"\) | +| `org_id` | string | No | ID of the organization to associate with \(e.g., "789"\) | | `note` | string | No | Notes for the activity | #### Output @@ -368,11 +368,11 @@ Update an existing activity (task) in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `activity_id` | string | Yes | The ID of the activity to update | -| `subject` | string | No | New subject/title for the activity | -| `due_date` | string | No | New due date in YYYY-MM-DD format | -| `due_time` | string | No | New due time in HH:MM format | -| `duration` | string | No | New duration in HH:MM format | +| `activity_id` | string | Yes | The ID of the activity to update \(e.g., "12345"\) | +| `subject` | string | No | New subject/title for the activity \(e.g., "Updated meeting with client"\) | +| `due_date` | string | No | New due date in YYYY-MM-DD format \(e.g., "2025-03-20"\) | +| `due_time` | string | No | New due time in HH:MM format \(e.g., "15:00"\) | +| `duration` | string | No | New duration in HH:MM format \(e.g., "00:30" for 30 minutes\) | | `done` | string | No | Mark as done: 0 for not done, 1 for done | | `note` | string | No | New notes for the activity | @@ -391,12 +391,12 @@ Retrieve all leads or a specific lead from Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `lead_id` | string | No | Optional: ID of a specific lead to retrieve | -| `archived` | string | No | Get archived leads instead of active ones | -| `owner_id` | string | No | Filter by owner user ID | -| `person_id` | string | No | Filter by person ID | -| `organization_id` | string | No | Filter by organization ID | -| `limit` | string | No | Number of results to return \(default: 100, max: 500\) | +| `lead_id` | string | No | Optional: ID of a specific lead to retrieve \(e.g., "abc123-def456-ghi789"\) | +| `archived` | string | No | Get archived leads instead of active ones \(e.g., "true" or "false"\) | +| `owner_id` | string | No | Filter by owner user ID \(e.g., "123"\) | +| `person_id` | string | No | Filter by person ID \(e.g., "456"\) | +| `organization_id` | string | No | Filter by organization ID \(e.g., "789"\) | +| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | #### Output @@ -441,13 +441,13 @@ Create a new lead in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `title` | string | Yes | The name of the lead | -| `person_id` | string | No | ID of the person \(REQUIRED unless organization_id is provided\) | -| `organization_id` | string | No | ID of the organization \(REQUIRED unless person_id is provided\) | -| `owner_id` | string | No | ID of the user who will own the lead | -| `value_amount` | string | No | Potential value amount | -| `value_currency` | string | No | Currency code \(e.g., USD, EUR\) | -| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format | +| `title` | string | Yes | The name of the lead \(e.g., "Acme Corp - Website Redesign"\) | +| `person_id` | string | No | ID of the person \(REQUIRED unless organization_id is provided\) \(e.g., "456"\) | +| `organization_id` | string | No | ID of the organization \(REQUIRED unless person_id is provided\) \(e.g., "789"\) | +| `owner_id` | string | No | ID of the user who will own the lead \(e.g., "123"\) | +| `value_amount` | string | No | Potential value amount \(e.g., "10000"\) | +| `value_currency` | string | No | Currency code \(e.g., "USD", "EUR", "GBP"\) | +| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format \(e.g., "2025-04-15"\) | | `visible_to` | string | No | Visibility: 1 \(Owner & followers\), 3 \(Entire company\) | #### Output @@ -465,14 +465,14 @@ Update an existing lead in Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `lead_id` | string | Yes | The ID of the lead to update | -| `title` | string | No | New name for the lead | -| `person_id` | string | No | New person ID | -| `organization_id` | string | No | New organization ID | -| `owner_id` | string | No | New owner user ID | -| `value_amount` | string | No | New value amount | -| `value_currency` | string | No | New currency code \(e.g., USD, EUR\) | -| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format | +| `lead_id` | string | Yes | The ID of the lead to update \(e.g., "abc123-def456-ghi789"\) | +| `title` | string | No | New name for the lead \(e.g., "Updated Lead - Premium Package"\) | +| `person_id` | string | No | New person ID \(e.g., "456"\) | +| `organization_id` | string | No | New organization ID \(e.g., "789"\) | +| `owner_id` | string | No | New owner user ID \(e.g., "123"\) | +| `value_amount` | string | No | New value amount \(e.g., "15000"\) | +| `value_currency` | string | No | New currency code \(e.g., "USD", "EUR", "GBP"\) | +| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format \(e.g., "2025-05-01"\) | | `is_archived` | string | No | Archive the lead: true or false | #### Output @@ -490,7 +490,7 @@ Delete a specific lead from Pipedrive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `lead_id` | string | Yes | The ID of the lead to delete | +| `lead_id` | string | Yes | The ID of the lead to delete \(e.g., "abc123-def456-ghi789"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/polymarket.mdx b/apps/docs/content/docs/en/tools/polymarket.mdx index 0e9296b87..1a730f1c2 100644 --- a/apps/docs/content/docs/en/tools/polymarket.mdx +++ b/apps/docs/content/docs/en/tools/polymarket.mdx @@ -47,8 +47,8 @@ Retrieve a list of prediction markets from Polymarket with optional filtering | `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) | | `ascending` | string | No | Sort direction \(true for ascending, false for descending\) | | `tagId` | string | No | Filter by tag ID | -| `limit` | string | No | Number of results per page \(max 50\) | -| `offset` | string | No | Pagination offset \(skip this many results\) | +| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | #### Output @@ -79,8 +79,8 @@ Retrieve details of a specific prediction market by ID or slug | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `marketId` | string | No | The market ID. Required if slug is not provided. | -| `slug` | string | No | The market slug \(e.g., "will-trump-win"\). Required if marketId is not provided. | +| `marketId` | string | No | The market ID \(e.g., "0x1234...abcd" condition ID format\). Required if slug is not provided. | +| `slug` | string | No | The market slug \(e.g., "will-trump-win"\). URL-friendly identifier. Required if marketId is not provided. | #### Output @@ -122,8 +122,8 @@ Retrieve a list of events from Polymarket with optional filtering | `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) | | `ascending` | string | No | Sort direction \(true for ascending, false for descending\) | | `tagId` | string | No | Filter by tag ID | -| `limit` | string | No | Number of results per page \(max 50\) | -| `offset` | string | No | Pagination offset \(skip this many results\) | +| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | #### Output @@ -154,8 +154,8 @@ Retrieve details of a specific event by ID or slug | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `eventId` | string | No | The event ID. Required if slug is not provided. | -| `slug` | string | No | The event slug \(e.g., "2024-presidential-election"\). Required if eventId is not provided. | +| `eventId` | string | No | The event ID \(e.g., "12345" or UUID format\). Required if slug is not provided. | +| `slug` | string | No | The event slug \(e.g., "2024-presidential-election"\). URL-friendly identifier. Required if eventId is not provided. | #### Output @@ -189,8 +189,8 @@ Retrieve available tags for filtering markets from Polymarket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `limit` | string | No | Number of results per page \(max 50\) | -| `offset` | string | No | Pagination offset \(skip this many results\) | +| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | #### Output @@ -211,9 +211,9 @@ Search for markets, events, and profiles on Polymarket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | Search query term | -| `limit` | string | No | Number of results per page \(max 50\) | -| `page` | string | No | Page number for pagination \(1-indexed\) | +| `query` | string | Yes | Search query term \(e.g., "presidential election", "bitcoin price"\). | +| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | +| `page` | string | No | Page number for pagination \(e.g., "2"\). 1-indexed. | | `cache` | string | No | Enable caching \(true/false\) | | `eventsStatus` | string | No | Filter events by status | | `limitPerType` | string | No | Limit results per type \(markets, events, profiles\) | @@ -244,8 +244,8 @@ Retrieve series (related market groups) from Polymarket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `limit` | string | No | Number of results per page \(max 50\) | -| `offset` | string | No | Pagination offset \(skip this many results\) | +| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | #### Output @@ -276,7 +276,7 @@ Retrieve a specific series (related market group) by ID from Polymarket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `seriesId` | string | Yes | The series ID | +| `seriesId` | string | Yes | The series ID \(e.g., "12345" or UUID format\). | #### Output @@ -309,7 +309,7 @@ Retrieve the order book summary for a specific token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | #### Output @@ -338,8 +338,8 @@ Retrieve the market price for a specific token and side | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | -| `side` | string | Yes | Order side: buy or sell | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | +| `side` | string | Yes | Order side: "buy" or "sell". | #### Output @@ -355,7 +355,7 @@ Retrieve the midpoint price for a specific token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | #### Output @@ -371,7 +371,7 @@ Retrieve historical price data for a specific market token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `interval` | string | No | Duration ending at current time \(1m, 1h, 6h, 1d, 1w, max\). Mutually exclusive with startTs/endTs. | | `fidelity` | number | No | Data resolution in minutes \(e.g., 60 for hourly\) | | `startTs` | number | No | Start timestamp \(Unix seconds UTC\) | @@ -393,7 +393,7 @@ Retrieve the last trade price for a specific token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | #### Output @@ -410,7 +410,7 @@ Retrieve the bid-ask spread for a specific token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | #### Output @@ -427,7 +427,7 @@ Retrieve the minimum tick size for a specific token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) | +| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | #### Output @@ -444,16 +444,16 @@ Retrieve user positions from Polymarket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `user` | string | Yes | User wallet address | -| `market` | string | No | Condition IDs to filter positions \(comma-separated, mutually exclusive with eventId\) | -| `eventId` | string | No | Event ID to filter positions \(mutually exclusive with market\) | +| `market` | string | No | Condition IDs to filter positions \(e.g., "0x1234...abcd,0x5678...efgh"\). Mutually exclusive with eventId. | +| `eventId` | string | No | Event ID to filter positions \(e.g., "12345"\). Mutually exclusive with market. | | `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) | | `redeemable` | string | No | Filter for redeemable positions only \(true/false\) | | `mergeable` | string | No | Filter for mergeable positions only \(true/false\) | | `sortBy` | string | No | Sort field \(TOKENS, CURRENT, INITIAL, CASHPNL, PERCENTPNL, TITLE, RESOLVING, PRICE, AVGPRICE\) | | `sortDirection` | string | No | Sort direction \(ASC or DESC\) | | `title` | string | No | Search filter by title | -| `limit` | string | No | Number of results per page | -| `offset` | string | No | Pagination offset | +| `limit` | string | No | Number of results per page \(e.g., "25"\). | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | #### Output @@ -495,14 +495,14 @@ Retrieve trade history from Polymarket | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `user` | string | No | User wallet address to filter trades | -| `market` | string | No | Market/condition ID to filter trades \(mutually exclusive with eventId\) | -| `eventId` | string | No | Event ID to filter trades \(mutually exclusive with market\) | +| `market` | string | No | Market/condition ID to filter trades \(e.g., "0x1234...abcd"\). Mutually exclusive with eventId. | +| `eventId` | string | No | Event ID to filter trades \(e.g., "12345"\). Mutually exclusive with market. | | `side` | string | No | Trade direction filter \(BUY or SELL\) | | `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) | | `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount | | `filterAmount` | string | No | Filter amount threshold - requires filterType | -| `limit` | string | No | Number of results per page \(default: 100, max: 10000\) | -| `offset` | string | No | Pagination offset \(skip this many results\) | +| `limit` | string | No | Number of results per page \(e.g., "50"\). Default: 100, max: 10000. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "100"\). | #### Output @@ -538,10 +538,10 @@ Retrieve on-chain activity for a user including trades, splits, merges, redempti | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `user` | string | Yes | User wallet address \(0x-prefixed\) | -| `limit` | string | No | Maximum results \(default: 100, max: 500\) | -| `offset` | string | No | Pagination offset \(default: 0, max: 10000\) | -| `market` | string | No | Comma-separated condition IDs \(mutually exclusive with eventId\) | -| `eventId` | string | No | Comma-separated event IDs \(mutually exclusive with market\) | +| `limit` | string | No | Maximum results to return \(e.g., "50"\). Default: 100, max: 500. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "100"\). Default: 0, max: 10000. | +| `market` | string | No | Comma-separated condition IDs \(e.g., "0x1234...abcd,0x5678...efgh"\). Mutually exclusive with eventId. | +| `eventId` | string | No | Comma-separated event IDs \(e.g., "12345,67890"\). Mutually exclusive with market. | | `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE | | `start` | number | No | Start timestamp \(Unix seconds\) | | `end` | number | No | End timestamp \(Unix seconds\) | @@ -587,8 +587,8 @@ Retrieve trader leaderboard rankings by profit/loss or volume | `category` | string | No | Category filter: OVERALL, POLITICS, SPORTS, CRYPTO, CULTURE, MENTIONS, WEATHER, ECONOMICS, TECH, FINANCE \(default: OVERALL\) | | `timePeriod` | string | No | Time period: DAY, WEEK, MONTH, ALL \(default: DAY\) | | `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) | -| `limit` | string | No | Number of results \(1-50, default: 25\) | -| `offset` | string | No | Pagination offset \(0-1000, default: 0\) | +| `limit` | string | No | Number of results to return \(e.g., "10"\). Range: 1-50, default: 25. | +| `offset` | string | No | Number of results to skip for pagination \(e.g., "25"\). Range: 0-1000, default: 0. | | `user` | string | No | Filter by specific user wallet address | | `userName` | string | No | Filter by username | @@ -614,8 +614,8 @@ Retrieve top holders of a specific market token | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `market` | string | Yes | Comma-separated list of condition IDs | -| `limit` | string | No | Number of holders to return \(0-20, default: 20\) | +| `market` | string | Yes | Comma-separated list of condition IDs \(e.g., "0x1234...abcd" or "0x1234...abcd,0x5678...efgh"\). | +| `limit` | string | No | Number of holders to return \(e.g., "10"\). Range: 0-20, default: 20. | | `minBalance` | string | No | Minimum balance threshold \(default: 1\) | #### Output diff --git a/apps/docs/content/docs/en/tools/posthog.mdx b/apps/docs/content/docs/en/tools/posthog.mdx index 394a8eb90..78916bbc2 100644 --- a/apps/docs/content/docs/en/tools/posthog.mdx +++ b/apps/docs/content/docs/en/tools/posthog.mdx @@ -50,7 +50,7 @@ Capture a single event in PostHog. Use this to track user actions, page views, o | `projectApiKey` | string | Yes | PostHog Project API Key \(public token for event ingestion\) | | `region` | string | No | PostHog region: us \(default\) or eu | | `event` | string | Yes | The name of the event to capture \(e.g., "page_view", "button_clicked"\) | -| `distinctId` | string | Yes | Unique identifier for the user or device. Can be user ID, device ID, or anonymous ID | +| `distinctId` | string | Yes | Unique identifier for the user or device \(e.g., "user123", email, or device UUID\) | | `properties` | string | No | JSON string of event properties \(e.g., \{"button_name": "signup", "page": "homepage"\}\) | | `timestamp` | string | No | ISO 8601 timestamp for when the event occurred. If not provided, uses current time | @@ -89,9 +89,9 @@ List persons (users) in PostHog. Returns user profiles with their properties and | --------- | ---- | -------- | ----------- | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) | | `region` | string | No | PostHog region: us \(default\) or eu | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `limit` | number | No | Number of persons to return \(default: 100, max: 100\) | -| `offset` | number | No | Number of persons to skip for pagination | +| `offset` | number | No | Number of persons to skip for pagination \(e.g., 0, 100, 200\) | | `search` | string | No | Search persons by email, name, or distinct ID | | `distinctId` | string | No | Filter by specific distinct_id | @@ -117,8 +117,8 @@ Get detailed information about a specific person in PostHog by their ID or UUID. | --------- | ---- | -------- | ----------- | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) | | `region` | string | No | PostHog region: us \(default\) or eu | -| `projectId` | string | Yes | PostHog Project ID | -| `personId` | string | Yes | Person ID or UUID to retrieve | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | +| `personId` | string | Yes | Person ID or UUID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | #### Output @@ -141,8 +141,8 @@ Delete a person from PostHog. This will remove all associated events and data. U | --------- | ---- | -------- | ----------- | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) | | `region` | string | No | PostHog region: us \(default\) or eu | -| `projectId` | string | Yes | PostHog Project ID | -| `personId` | string | Yes | Person ID or UUID to delete | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | +| `personId` | string | Yes | Person ID or UUID to delete \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | #### Output @@ -160,7 +160,7 @@ Execute a HogQL query in PostHog. HogQL is PostHog | --------- | ---- | -------- | ----------- | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) | | `region` | string | No | PostHog region: us \(default\) or eu | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `query` | string | Yes | HogQL query to execute. Example: \{"kind": "HogQLQuery", "query": "SELECT event, count\(\) FROM events WHERE timestamp > now\(\) - INTERVAL 1 DAY GROUP BY event"\} | | `Example` | string | No | No description | | `values` | string | No | Optional JSON string of parameter values for parameterized queries. Example: \{"user_id": "123"\} | @@ -185,10 +185,10 @@ List all insights in a PostHog project. Returns insight configurations, filters, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -219,8 +219,8 @@ Get a specific insight by ID from PostHog. Returns detailed insight configuratio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | -| `insightId` | string | Yes | The insight ID to retrieve | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `insightId` | string | Yes | The insight ID to retrieve \(e.g., "42" or short ID like "abc123"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | #### Output @@ -250,7 +250,7 @@ Create a new insight in PostHog. Requires insight name and configuration filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `name` | string | No | Name for the insight \(optional - PostHog will generate a derived name if not provided\) | | `description` | string | No | Description of the insight | @@ -284,10 +284,10 @@ List all dashboards in a PostHog project. Returns dashboard configurations, tile | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -318,8 +318,8 @@ Get a specific dashboard by ID from PostHog. Returns detailed dashboard configur | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | -| `dashboardId` | string | Yes | The dashboard ID to retrieve | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `dashboardId` | string | Yes | The dashboard ID to retrieve \(e.g., "42"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | #### Output @@ -348,10 +348,10 @@ List all actions in a PostHog project. Returns action definitions, steps, and me | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -383,10 +383,10 @@ List all cohorts in a PostHog project. Returns cohort definitions, filters, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -420,8 +420,8 @@ Get a specific cohort by ID from PostHog. Returns detailed cohort definition, fi | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | -| `cohortId` | string | Yes | The cohort ID to retrieve | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `cohortId` | string | Yes | The cohort ID to retrieve \(e.g., "42"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | #### Output @@ -453,7 +453,7 @@ Create a new cohort in PostHog. Requires cohort name and filter or query configu | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `name` | string | No | Name for the cohort \(optional - PostHog will use "Untitled cohort" if not provided\) | | `description` | string | No | Description of the cohort | @@ -489,10 +489,10 @@ List all annotations in a PostHog project. Returns annotation content, timestamp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -523,7 +523,7 @@ Create a new annotation in PostHog. Mark important events on your graphs with da | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `content` | string | Yes | Content/text of the annotation | | `date_marker` | string | Yes | ISO timestamp marking when the annotation applies \(e.g., "2024-01-15T10:00:00Z"\) | @@ -555,11 +555,11 @@ List all feature flags in a PostHog project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | -| `limit` | number | No | Number of results to return | -| `offset` | number | No | Number of results to skip | +| `limit` | number | No | Number of results to return \(e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -589,8 +589,8 @@ Get details of a specific feature flag | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | -| `flagId` | string | Yes | The feature flag ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `flagId` | string | Yes | The feature flag ID \(e.g., "42"\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -621,7 +621,7 @@ Create a new feature flag in PostHog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | | `name` | string | No | Feature flag name \(optional - can be empty\) | @@ -656,8 +656,8 @@ Update an existing feature flag in PostHog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | -| `flagId` | string | Yes | The feature flag ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `flagId` | string | Yes | The feature flag ID \(e.g., "42"\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | | `name` | string | No | Feature flag name | @@ -692,8 +692,8 @@ Delete a feature flag from PostHog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | -| `flagId` | string | Yes | The feature flag ID to delete | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `flagId` | string | Yes | The feature flag ID to delete \(e.g., "42"\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -714,7 +714,7 @@ Evaluate feature flags for a specific user or group. This is a public endpoint t | --------- | ---- | -------- | ----------- | | `region` | string | Yes | PostHog cloud region: us or eu | | `projectApiKey` | string | Yes | PostHog Project API Key \(not personal API key\) | -| `distinctId` | string | Yes | The distinct ID of the user to evaluate flags for | +| `distinctId` | string | Yes | The distinct ID of the user to evaluate flags for \(e.g., "user123" or email\) | | `groups` | string | No | Groups as JSON string \(e.g., \{"company": "company_id_in_your_db"\}\) | | `personProperties` | string | No | Person properties as JSON string | | `groupProperties` | string | No | Group properties as JSON string | @@ -735,11 +735,11 @@ List all experiments in a PostHog project | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | -| `limit` | number | No | Number of results to return | -| `offset` | number | No | Number of results to skip | +| `limit` | number | No | Number of results to return \(e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -771,8 +771,8 @@ Get details of a specific experiment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | -| `experimentId` | string | Yes | The experiment ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | +| `experimentId` | string | Yes | The experiment ID \(e.g., "42"\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -805,7 +805,7 @@ Create a new experiment in PostHog | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | The PostHog project ID | +| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | | `name` | string | No | Experiment name \(optional\) | @@ -845,10 +845,10 @@ List all surveys in a PostHog project. Surveys allow you to collect feedback fro | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | -| `limit` | number | No | Number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -877,8 +877,8 @@ Get details of a specific survey in PostHog by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | -| `surveyId` | string | Yes | Survey ID to retrieve | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | +| `surveyId` | string | Yes | Survey ID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | #### Output @@ -909,7 +909,7 @@ Create a new survey in PostHog. Supports question types: Basic (open), Link, Rat | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `name` | string | No | Survey name \(optional\) | | `description` | string | No | Survey description | @@ -946,8 +946,8 @@ Update an existing survey in PostHog. Can modify questions, appearance, conditio | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | -| `surveyId` | string | Yes | Survey ID to update | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | +| `surveyId` | string | Yes | Survey ID to update \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `name` | string | No | Survey name | | `description` | string | No | Survey description | @@ -986,10 +986,10 @@ List session recordings in a PostHog project. Session recordings capture user in | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | -| `limit` | number | No | Number of results to return \(default: 50\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return \(default: 50, e.g., 10, 25, 50\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 50, 100\) | #### Output @@ -1023,8 +1023,8 @@ Get details of a specific session recording in PostHog by ID. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | -| `recordingId` | string | Yes | Session recording ID to retrieve | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | +| `recordingId` | string | Yes | Session recording ID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | #### Output @@ -1058,10 +1058,10 @@ List session recording playlists in a PostHog project. Playlists allow you to or | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | PostHog Personal API Key | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) | -| `limit` | number | No | Number of results to return \(default: 100\) | -| `offset` | number | No | Number of results to skip for pagination | +| `limit` | number | No | Number of results to return \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | #### Output @@ -1091,11 +1091,11 @@ List all event definitions in a PostHog project. Event definitions represent tra | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | The initial index from which to return results | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | The initial index from which to return results \(e.g., 0, 100, 200\) | | `search` | string | No | Search term to filter event definitions by name | #### Output @@ -1125,7 +1125,7 @@ Get details of a specific event definition in PostHog. Returns comprehensive inf | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `eventDefinitionId` | string | Yes | Event Definition ID to retrieve | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -1156,7 +1156,7 @@ Update an event definition in PostHog. Can modify description, tags, and verific | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `eventDefinitionId` | string | Yes | Event Definition ID to update | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -1190,11 +1190,11 @@ List all property definitions in a PostHog project. Property definitions represe | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | -| `limit` | number | No | Number of results to return per page \(default: 100\) | -| `offset` | number | No | The initial index from which to return results | +| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | +| `offset` | number | No | The initial index from which to return results \(e.g., 0, 100, 200\) | | `search` | string | No | Search term to filter property definitions by name | | `type` | string | No | Filter by property type: event, person, or group | @@ -1228,7 +1228,7 @@ Get details of a specific property definition in PostHog. Returns comprehensive | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `propertyDefinitionId` | string | Yes | Property Definition ID to retrieve | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -1263,7 +1263,7 @@ Update a property definition in PostHog. Can modify description, tags, property | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | PostHog Project ID | +| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `propertyDefinitionId` | string | Yes | Property Definition ID to update | | `region` | string | Yes | PostHog cloud region: us or eu | | `apiKey` | string | Yes | PostHog Personal API Key | @@ -1335,7 +1335,7 @@ Get detailed information about a specific project by ID. Returns comprehensive p | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `projectId` | string | Yes | Project ID \(numeric ID or UUID\) | +| `projectId` | string | Yes | Project ID \(e.g., "12345" or project UUID\) | | `apiKey` | string | Yes | PostHog Personal API Key | | `region` | string | No | Cloud region: us or eu \(default: us\) | @@ -1402,7 +1402,7 @@ Get detailed information about a specific organization by ID. Returns comprehens | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `organizationId` | string | Yes | Organization ID \(UUID\) | +| `organizationId` | string | Yes | Organization ID \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `apiKey` | string | Yes | PostHog Personal API Key | | `region` | string | No | Cloud region: us or eu \(default: us\) | diff --git a/apps/docs/content/docs/en/tools/qdrant.mdx b/apps/docs/content/docs/en/tools/qdrant.mdx index a0a0c00e0..a902750b8 100644 --- a/apps/docs/content/docs/en/tools/qdrant.mdx +++ b/apps/docs/content/docs/en/tools/qdrant.mdx @@ -47,9 +47,9 @@ Insert or update points in a Qdrant collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | Qdrant base URL | -| `apiKey` | string | No | Qdrant API key \(optional\) | -| `collection` | string | Yes | Collection name | +| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) | +| `apiKey` | string | No | Qdrant API key for authentication | +| `collection` | string | Yes | Collection name for upsert \(e.g., "my_collection"\) | | `points` | array | Yes | Array of points to upsert | #### Output @@ -69,12 +69,12 @@ Search for similar vectors in a Qdrant collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | Qdrant base URL | -| `apiKey` | string | No | Qdrant API key \(optional\) | -| `collection` | string | Yes | Collection name | -| `vector` | array | Yes | Vector to search for | -| `limit` | number | No | Number of results to return | -| `filter` | object | No | Filter to apply to the search | +| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) | +| `apiKey` | string | No | Qdrant API key for authentication | +| `collection` | string | Yes | Collection name to search \(e.g., "my_collection"\) | +| `vector` | array | Yes | Query vector for similarity search \(e.g., \[0.1, 0.2, 0.3, ...\]\) | +| `limit` | number | No | Maximum number of results to return \(e.g., 10\) | +| `filter` | object | No | Qdrant filter object \(e.g., \{"must": \[\{"key": "field", "match": \{"value": "val"\}\}\]\}\) | | `search_return_data` | string | No | Data to return from search | | `with_payload` | boolean | No | Include payload in response | | `with_vector` | boolean | No | Include vector in response | @@ -101,10 +101,10 @@ Fetch points by ID from a Qdrant collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `url` | string | Yes | Qdrant base URL | -| `apiKey` | string | No | Qdrant API key \(optional\) | -| `collection` | string | Yes | Collection name | -| `ids` | array | Yes | Array of point IDs to fetch | +| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) | +| `apiKey` | string | No | Qdrant API key for authentication | +| `collection` | string | Yes | Collection name to fetch from \(e.g., "my_collection"\) | +| `ids` | array | Yes | Array of point IDs to fetch \(e.g., \["id1", "id2"\] or \[1, 2\]\) | | `fetch_return_data` | string | No | Data to return from fetch | | `with_payload` | boolean | No | Include payload in response | | `with_vector` | boolean | No | Include vector in response | diff --git a/apps/docs/content/docs/en/tools/rds.mdx b/apps/docs/content/docs/en/tools/rds.mdx index ec1f31869..9a383557d 100644 --- a/apps/docs/content/docs/en/tools/rds.mdx +++ b/apps/docs/content/docs/en/tools/rds.mdx @@ -52,10 +52,10 @@ Execute a SELECT query on Amazon RDS using the Data API | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `resourceArn` | string | Yes | ARN of the Aurora DB cluster | +| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | -| `database` | string | No | Database name \(optional\) | -| `query` | string | Yes | SQL SELECT query to execute | +| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | +| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE status = :status\) | #### Output @@ -76,9 +76,9 @@ Insert data into an Amazon RDS table using the Data API | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `resourceArn` | string | Yes | ARN of the Aurora DB cluster | +| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | -| `database` | string | No | Database name \(optional\) | +| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `table` | string | Yes | Table name to insert into | | `data` | object | Yes | Data to insert as key-value pairs | @@ -101,9 +101,9 @@ Update data in an Amazon RDS table using the Data API | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `resourceArn` | string | Yes | ARN of the Aurora DB cluster | +| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | -| `database` | string | No | Database name \(optional\) | +| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `table` | string | Yes | Table name to update | | `data` | object | Yes | Data to update as key-value pairs | | `conditions` | object | Yes | Conditions for the update \(e.g., \{"id": 1\}\) | @@ -127,9 +127,9 @@ Delete data from an Amazon RDS table using the Data API | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `resourceArn` | string | Yes | ARN of the Aurora DB cluster | +| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | -| `database` | string | No | Database name \(optional\) | +| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `table` | string | Yes | Table name to delete from | | `conditions` | object | Yes | Conditions for the delete \(e.g., \{"id": 1\}\) | @@ -152,10 +152,10 @@ Execute raw SQL on Amazon RDS using the Data API | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `resourceArn` | string | Yes | ARN of the Aurora DB cluster | +| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | -| `database` | string | No | Database name \(optional\) | -| `query` | string | Yes | Raw SQL query to execute | +| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | +| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id SERIAL PRIMARY KEY, name VARCHAR\(255\)\)\) | #### Output @@ -176,9 +176,9 @@ Introspect Amazon RDS Aurora database schema to retrieve table structures, colum | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `resourceArn` | string | Yes | ARN of the Aurora DB cluster | +| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | -| `database` | string | No | Database name \(optional\) | +| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `schema` | string | No | Schema to introspect \(default: public for PostgreSQL, database name for MySQL\) | | `engine` | string | No | Database engine \(aurora-postgresql or aurora-mysql\). Auto-detected if not provided. | diff --git a/apps/docs/content/docs/en/tools/reddit.mdx b/apps/docs/content/docs/en/tools/reddit.mdx index a0f139af8..cf466f508 100644 --- a/apps/docs/content/docs/en/tools/reddit.mdx +++ b/apps/docs/content/docs/en/tools/reddit.mdx @@ -38,9 +38,9 @@ Fetch posts from a subreddit with different sorting options | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) | -| `sort` | string | No | Sort method for posts: "hot", "new", "top", or "rising" \(default: "hot"\) | -| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) | +| `subreddit` | string | Yes | The subreddit to fetch posts from \(e.g., "technology", "news"\) | +| `sort` | string | No | Sort method for posts \(e.g., "hot", "new", "top", "rising"\). Default: "hot" | +| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 | | `time` | string | No | Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" \(default: "day"\) | | `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) | | `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) | @@ -75,10 +75,10 @@ Fetch comments from a specific Reddit post | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `postId` | string | Yes | The ID of the Reddit post to fetch comments from | -| `subreddit` | string | Yes | The subreddit where the post is located \(without the r/ prefix\) | +| `postId` | string | Yes | The ID of the Reddit post to fetch comments from \(e.g., "abc123"\) | +| `subreddit` | string | Yes | The subreddit where the post is located \(e.g., "technology", "programming"\) | | `sort` | string | No | Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" \(default: "confidence"\) | -| `limit` | number | No | Maximum number of comments to return \(default: 50, max: 100\) | +| `limit` | number | No | Maximum number of comments to return \(e.g., 25\). Default: 50, max: 100 | | `depth` | number | No | Maximum depth of subtrees in the thread \(controls nested comment levels\) | | `context` | number | No | Number of parent comments to include | | `showedits` | boolean | No | Show edit information for comments | @@ -119,9 +119,9 @@ Fetch controversial posts from a subreddit | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) | +| `subreddit` | string | Yes | The subreddit to fetch posts from \(e.g., "technology", "news"\) | | `time` | string | No | Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) | -| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) | +| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 | | `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) | | `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) | | `count` | number | No | A count of items already seen in the listing \(used for numbering\) | @@ -155,11 +155,11 @@ Search for posts within a subreddit | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `subreddit` | string | Yes | The name of the subreddit to search in \(without the r/ prefix\) | -| `query` | string | Yes | Search query text | -| `sort` | string | No | Sort method for search results: "relevance", "hot", "top", "new", or "comments" \(default: "relevance"\) | +| `subreddit` | string | Yes | The subreddit to search in \(e.g., "technology", "programming"\) | +| `query` | string | Yes | Search query text \(e.g., "artificial intelligence", "machine learning tutorial"\) | +| `sort` | string | No | Sort method for search results \(e.g., "relevance", "hot", "top", "new", "comments"\). Default: "relevance" | | `time` | string | No | Time filter for search results: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) | -| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) | +| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 | | `restrict_sr` | boolean | No | Restrict search to the specified subreddit only \(default: true\) | | `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) | | `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) | @@ -193,9 +193,9 @@ Submit a new post to a subreddit (text or link) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `subreddit` | string | Yes | The name of the subreddit to post to \(without the r/ prefix\) | -| `title` | string | Yes | Title of the submission \(max 300 characters\) | -| `text` | string | No | Text content for a self post \(markdown supported\) | +| `subreddit` | string | Yes | The subreddit to post to \(e.g., "technology", "programming"\) | +| `title` | string | Yes | Title of the submission \(e.g., "Check out this new AI tool"\). Max 300 characters | +| `text` | string | No | Text content for a self post in markdown format \(e.g., "This is the **body** of my post"\) | | `url` | string | No | URL for a link post \(cannot be used with text\) | | `nsfw` | boolean | No | Mark post as NSFW | | `spoiler` | boolean | No | Mark post as spoiler | @@ -221,7 +221,7 @@ Upvote, downvote, or unvote a Reddit post or comment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | string | Yes | Thing fullname to vote on \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) | +| `id` | string | Yes | Thing fullname to vote on \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `dir` | number | Yes | Vote direction: 1 \(upvote\), 0 \(unvote\), or -1 \(downvote\) | #### Output @@ -239,7 +239,7 @@ Save a Reddit post or comment to your saved items | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | string | Yes | Thing fullname to save \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) | +| `id` | string | Yes | Thing fullname to save \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `category` | string | No | Category to save under \(Reddit Gold feature\) | #### Output @@ -273,8 +273,8 @@ Add a comment reply to a Reddit post or comment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `parent_id` | string | Yes | Thing fullname to reply to \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) | -| `text` | string | Yes | Comment text in markdown format | +| `parent_id` | string | Yes | Thing fullname to reply to \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | +| `text` | string | Yes | Comment text in markdown format \(e.g., "Great post! Here is my **reply**"\) | #### Output @@ -296,8 +296,8 @@ Edit the text of your own Reddit post or comment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `thing_id` | string | Yes | Thing fullname to edit \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) | -| `text` | string | Yes | New text content in markdown format | +| `thing_id` | string | Yes | Thing fullname to edit \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | +| `text` | string | Yes | New text content in markdown format \(e.g., "Updated **content** here"\) | #### Output @@ -318,7 +318,7 @@ Delete your own Reddit post or comment | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | string | Yes | Thing fullname to delete \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) | +| `id` | string | Yes | Thing fullname to delete \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | #### Output @@ -335,7 +335,7 @@ Subscribe or unsubscribe from a subreddit | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `subreddit` | string | Yes | The name of the subreddit \(without the r/ prefix\) | +| `subreddit` | string | Yes | The subreddit to subscribe to or unsubscribe from \(e.g., "technology", "programming"\) | | `action` | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe | #### Output diff --git a/apps/docs/content/docs/en/tools/resend.mdx b/apps/docs/content/docs/en/tools/resend.mdx index eb0bc6a32..8ddc4e933 100644 --- a/apps/docs/content/docs/en/tools/resend.mdx +++ b/apps/docs/content/docs/en/tools/resend.mdx @@ -41,11 +41,11 @@ Send an email using your own Resend API key and from address | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `fromAddress` | string | Yes | Email address to send from | -| `to` | string | Yes | Recipient email address | -| `subject` | string | Yes | Email subject | -| `body` | string | Yes | Email body content | -| `contentType` | string | No | Content type for the email body \(text or html\) | +| `fromAddress` | string | Yes | Email address to send from \(e.g., "sender@example.com" or "Sender Name <sender@example.com>"\) | +| `to` | string | Yes | Recipient email address \(e.g., "recipient@example.com" or "Recipient Name <recipient@example.com>"\) | +| `subject` | string | Yes | Email subject line | +| `body` | string | Yes | Email body content \(plain text or HTML based on contentType\) | +| `contentType` | string | No | Content type for the email body: "text" for plain text or "html" for HTML content | | `resendApiKey` | string | Yes | Resend API key for sending emails | #### Output diff --git a/apps/docs/content/docs/en/tools/s3.mdx b/apps/docs/content/docs/en/tools/s3.mdx index 55ca4be64..b4cf8ffa6 100644 --- a/apps/docs/content/docs/en/tools/s3.mdx +++ b/apps/docs/content/docs/en/tools/s3.mdx @@ -46,7 +46,7 @@ Upload a file to an AWS S3 bucket | `accessKeyId` | string | Yes | Your AWS Access Key ID | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `bucketName` | string | Yes | S3 bucket name | +| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `objectKey` | string | Yes | Object key/path in S3 \(e.g., folder/filename.ext\) | | `file` | file | No | File to upload | | `content` | string | No | Text content to upload \(alternative to file\) | @@ -71,7 +71,7 @@ Retrieve an object from an AWS S3 bucket | --------- | ---- | -------- | ----------- | | `accessKeyId` | string | Yes | Your AWS Access Key ID | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key | -| `s3Uri` | string | Yes | S3 Object URL | +| `s3Uri` | string | Yes | S3 Object URL \(e.g., https://bucket.s3.region.amazonaws.com/path/to/file\) | #### Output @@ -91,10 +91,10 @@ List objects in an AWS S3 bucket | `accessKeyId` | string | Yes | Your AWS Access Key ID | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `bucketName` | string | Yes | S3 bucket name | -| `prefix` | string | No | Prefix to filter objects \(e.g., folder/\) | +| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | +| `prefix` | string | No | Prefix to filter objects \(e.g., folder/, images/2024/\) | | `maxKeys` | number | No | Maximum number of objects to return \(default: 1000\) | -| `continuationToken` | string | No | Token for pagination | +| `continuationToken` | string | No | Token for pagination from previous list response | #### Output @@ -118,8 +118,8 @@ Delete an object from an AWS S3 bucket | `accessKeyId` | string | Yes | Your AWS Access Key ID | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `bucketName` | string | Yes | S3 bucket name | -| `objectKey` | string | Yes | Object key/path to delete | +| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | +| `objectKey` | string | Yes | Object key/path to delete \(e.g., folder/file.txt\) | #### Output @@ -139,10 +139,10 @@ Copy an object within or between AWS S3 buckets | `accessKeyId` | string | Yes | Your AWS Access Key ID | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `region` | string | Yes | AWS region \(e.g., us-east-1\) | -| `sourceBucket` | string | Yes | Source bucket name | -| `sourceKey` | string | Yes | Source object key/path | -| `destinationBucket` | string | Yes | Destination bucket name | -| `destinationKey` | string | Yes | Destination object key/path | +| `sourceBucket` | string | Yes | Source bucket name \(e.g., my-bucket\) | +| `sourceKey` | string | Yes | Source object key/path \(e.g., folder/file.txt\) | +| `destinationBucket` | string | Yes | Destination bucket name \(e.g., my-other-bucket\) | +| `destinationKey` | string | Yes | Destination object key/path \(e.g., backup/file.txt\) | | `acl` | string | No | Access control list for the copied object \(e.g., private, public-read\) | #### Output diff --git a/apps/docs/content/docs/en/tools/salesforce.mdx b/apps/docs/content/docs/en/tools/salesforce.mdx index ed8548f88..4cb3e0103 100644 --- a/apps/docs/content/docs/en/tools/salesforce.mdx +++ b/apps/docs/content/docs/en/tools/salesforce.mdx @@ -43,9 +43,9 @@ Retrieve accounts from Salesforce CRM | --------- | ---- | -------- | ----------- | | `idToken` | string | No | The ID token from Salesforce OAuth \(contains instance URL\) | | `instanceUrl` | string | No | The Salesforce instance URL | -| `limit` | string | No | Number of results to return \(default: 100, max: 2000\) | -| `fields` | string | No | Comma-separated list of fields to return \(e.g., "Id,Name,Industry,Phone"\) | -| `orderBy` | string | No | Field to order by \(e.g., "Name ASC" or "CreatedDate DESC"\) | +| `limit` | string | No | Maximum number of results \(default: 100, max: 2000\) | +| `fields` | string | No | Comma-separated field API names \(e.g., "Id,Name,Industry,Phone"\) | +| `orderBy` | string | No | Field and direction for sorting \(e.g., "Name ASC" or "CreatedDate DESC"\) | #### Output @@ -84,8 +84,8 @@ Create a new account in Salesforce CRM | `billingPostalCode` | string | No | Billing postal code | | `billingCountry` | string | No | Billing country | | `description` | string | No | Account description | -| `annualRevenue` | string | No | Annual revenue \(number\) | -| `numberOfEmployees` | string | No | Number of employees \(number\) | +| `annualRevenue` | string | No | Annual revenue as a number | +| `numberOfEmployees` | string | No | Number of employees as an integer | #### Output @@ -107,10 +107,10 @@ Update an existing account in Salesforce CRM | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `accountId` | string | Yes | Account ID to update \(required\) | +| `accountId` | string | Yes | Salesforce Account ID to update \(18-character string starting with 001\) | | `name` | string | No | Account name | -| `type` | string | No | Account type | -| `industry` | string | No | Industry | +| `type` | string | No | Account type \(e.g., Customer, Partner, Prospect\) | +| `industry` | string | No | Industry \(e.g., Technology, Healthcare, Finance\) | | `phone` | string | No | Phone number | | `website` | string | No | Website URL | | `billingStreet` | string | No | Billing street address | @@ -119,8 +119,8 @@ Update an existing account in Salesforce CRM | `billingPostalCode` | string | No | Billing postal code | | `billingCountry` | string | No | Billing country | | `description` | string | No | Account description | -| `annualRevenue` | string | No | Annual revenue \(number\) | -| `numberOfEmployees` | string | No | Number of employees \(number\) | +| `annualRevenue` | string | No | Annual revenue as a number | +| `numberOfEmployees` | string | No | Number of employees as an integer | #### Output @@ -141,7 +141,7 @@ Delete an account from Salesforce CRM | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `accountId` | string | Yes | Account ID to delete \(required\) | +| `accountId` | string | Yes | Salesforce Account ID to delete \(18-character string starting with 001\) | #### Output @@ -162,10 +162,10 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `contactId` | string | No | Contact ID \(if provided, returns single contact\) | -| `limit` | string | No | Number of results \(default: 100, max: 2000\). Only for list query. | -| `fields` | string | No | Comma-separated fields \(e.g., "Id,FirstName,LastName,Email,Phone"\) | -| `orderBy` | string | No | Order by field \(e.g., "LastName ASC"\). Only for list query. | +| `contactId` | string | No | Salesforce Contact ID \(18-character string starting with 003\) to get a single contact | +| `limit` | string | No | Maximum number of results \(default: 100, max: 2000\). Only for list query. | +| `fields` | string | No | Comma-separated field API names \(e.g., "Id,FirstName,LastName,Email,Phone"\) | +| `orderBy` | string | No | Field and direction for sorting \(e.g., "LastName ASC"\). Only for list query. | #### Output @@ -199,7 +199,7 @@ Create a new contact in Salesforce CRM | `firstName` | string | No | First name | | `email` | string | No | Email address | | `phone` | string | No | Phone number | -| `accountId` | string | No | Account ID to associate contact with | +| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `title` | string | No | No description | | `department` | string | No | Department | | `mailingStreet` | string | No | Mailing street | @@ -229,12 +229,12 @@ Update an existing contact in Salesforce CRM | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `contactId` | string | Yes | Contact ID to update \(required\) | +| `contactId` | string | Yes | Salesforce Contact ID to update \(18-character string starting with 003\) | | `lastName` | string | No | Last name | | `firstName` | string | No | First name | | `email` | string | No | Email address | | `phone` | string | No | Phone number | -| `accountId` | string | No | Account ID to associate with | +| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `title` | string | No | No description | | `department` | string | No | Department | | `mailingStreet` | string | No | Mailing street | @@ -242,7 +242,7 @@ Update an existing contact in Salesforce CRM | `mailingState` | string | No | Mailing state | | `mailingPostalCode` | string | No | Mailing postal code | | `mailingCountry` | string | No | Mailing country | -| `description` | string | No | Description | +| `description` | string | No | Contact description | #### Output @@ -263,7 +263,7 @@ Delete a contact from Salesforce CRM | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `contactId` | string | Yes | Contact ID to delete \(required\) | +| `contactId` | string | Yes | Salesforce Contact ID to delete \(18-character string starting with 003\) | #### Output @@ -284,10 +284,10 @@ Get lead(s) from Salesforce | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `leadId` | string | No | Lead ID \(optional\) | -| `limit` | string | No | Max results \(default: 100\) | -| `fields` | string | No | Comma-separated fields | -| `orderBy` | string | No | Order by field | +| `leadId` | string | No | Salesforce Lead ID \(18-character string starting with 00Q\) to get a single lead | +| `limit` | string | No | Maximum number of results to return \(default: 100\) | +| `fields` | string | No | Comma-separated list of field API names to return | +| `orderBy` | string | No | Field and direction for sorting \(e.g., LastName ASC\) | #### Output @@ -318,14 +318,14 @@ Create a new lead | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | | `lastName` | string | Yes | Last name \(required\) | -| `company` | string | Yes | Company \(required\) | +| `company` | string | Yes | Company name \(required\) | | `firstName` | string | No | First name | -| `email` | string | No | No description | -| `phone` | string | No | No description | -| `status` | string | No | Lead status | -| `leadSource` | string | No | Lead source | +| `email` | string | No | Email address | +| `phone` | string | No | Phone number | +| `status` | string | No | Lead status \(e.g., Open, Working, Closed\) | +| `leadSource` | string | No | Lead source \(e.g., Web, Referral, Campaign\) | | `title` | string | No | No description | -| `description` | string | No | Description | +| `description` | string | No | Lead description | #### Output @@ -347,16 +347,16 @@ Update an existing lead | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `leadId` | string | Yes | Lead ID \(required\) | +| `leadId` | string | Yes | Salesforce Lead ID to update \(18-character string starting with 00Q\) | | `lastName` | string | No | Last name | -| `company` | string | No | No description | +| `company` | string | No | Company name | | `firstName` | string | No | First name | -| `email` | string | No | No description | -| `phone` | string | No | No description | -| `status` | string | No | Lead status | -| `leadSource` | string | No | Lead source | +| `email` | string | No | Email address | +| `phone` | string | No | Phone number | +| `status` | string | No | Lead status \(e.g., Open, Working, Closed\) | +| `leadSource` | string | No | Lead source \(e.g., Web, Referral, Campaign\) | | `title` | string | No | No description | -| `description` | string | No | Description | +| `description` | string | No | Lead description | #### Output @@ -377,7 +377,7 @@ Delete a lead | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `leadId` | string | Yes | Lead ID \(required\) | +| `leadId` | string | Yes | Salesforce Lead ID to delete \(18-character string starting with 00Q\) | #### Output @@ -398,10 +398,10 @@ Get opportunity(ies) from Salesforce | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `opportunityId` | string | No | Opportunity ID \(optional\) | -| `limit` | string | No | Max results \(default: 100\) | -| `fields` | string | No | Comma-separated fields | -| `orderBy` | string | No | Order by field | +| `opportunityId` | string | No | Salesforce Opportunity ID \(18-character string starting with 006\) to get a single opportunity | +| `limit` | string | No | Maximum number of results to return \(default: 100\) | +| `fields` | string | No | Comma-separated list of field API names to return | +| `orderBy` | string | No | Field and direction for sorting \(e.g., CloseDate DESC\) | #### Output @@ -431,12 +431,12 @@ Create a new opportunity | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | | `name` | string | Yes | Opportunity name \(required\) | -| `stageName` | string | Yes | Stage name \(required\) | -| `closeDate` | string | Yes | Close date YYYY-MM-DD \(required\) | -| `accountId` | string | No | Account ID | -| `amount` | string | No | Amount \(number\) | -| `probability` | string | No | Probability \(0-100\) | -| `description` | string | No | Description | +| `stageName` | string | Yes | Stage name \(required, e.g., Prospecting, Qualification, Closed Won\) | +| `closeDate` | string | Yes | Close date in YYYY-MM-DD format \(required\) | +| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | +| `amount` | string | No | Deal amount as a number | +| `probability` | string | No | Win probability as integer \(0-100\) | +| `description` | string | No | Opportunity description | #### Output @@ -458,14 +458,14 @@ Update an existing opportunity | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `opportunityId` | string | Yes | Opportunity ID \(required\) | +| `opportunityId` | string | Yes | Salesforce Opportunity ID to update \(18-character string starting with 006\) | | `name` | string | No | Opportunity name | -| `stageName` | string | No | Stage name | -| `closeDate` | string | No | Close date YYYY-MM-DD | -| `accountId` | string | No | Account ID | -| `amount` | string | No | No description | -| `probability` | string | No | Probability \(0-100\) | -| `description` | string | No | Description | +| `stageName` | string | No | Stage name \(e.g., Prospecting, Qualification, Closed Won\) | +| `closeDate` | string | No | Close date in YYYY-MM-DD format | +| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | +| `amount` | string | No | Deal amount as a number | +| `probability` | string | No | Win probability as integer \(0-100\) | +| `description` | string | No | Opportunity description | #### Output @@ -486,7 +486,7 @@ Delete an opportunity | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `opportunityId` | string | Yes | Opportunity ID \(required\) | +| `opportunityId` | string | Yes | Salesforce Opportunity ID to delete \(18-character string starting with 006\) | #### Output @@ -507,10 +507,10 @@ Get case(s) from Salesforce | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `caseId` | string | No | Case ID \(optional\) | -| `limit` | string | No | Max results \(default: 100\) | -| `fields` | string | No | Comma-separated fields | -| `orderBy` | string | No | Order by field | +| `caseId` | string | No | Salesforce Case ID \(18-character string starting with 500\) to get a single case | +| `limit` | string | No | Maximum number of results to return \(default: 100\) | +| `fields` | string | No | Comma-separated list of field API names to return | +| `orderBy` | string | No | Field and direction for sorting \(e.g., CreatedDate DESC\) | #### Output @@ -543,9 +543,9 @@ Create a new case | `status` | string | No | Status \(e.g., New, Working, Escalated\) | | `priority` | string | No | Priority \(e.g., Low, Medium, High\) | | `origin` | string | No | Origin \(e.g., Phone, Email, Web\) | -| `contactId` | string | No | Contact ID | -| `accountId` | string | No | Account ID | -| `description` | string | No | Description | +| `contactId` | string | No | Salesforce Contact ID \(18-character string starting with 003\) | +| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | +| `description` | string | No | Case description | #### Output @@ -567,11 +567,11 @@ Update an existing case | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `caseId` | string | Yes | Case ID \(required\) | +| `caseId` | string | Yes | Salesforce Case ID to update \(18-character string starting with 500\) | | `subject` | string | No | Case subject | -| `status` | string | No | Status | -| `priority` | string | No | Priority | -| `description` | string | No | Description | +| `status` | string | No | Status \(e.g., New, Working, Escalated, Closed\) | +| `priority` | string | No | Priority \(e.g., Low, Medium, High\) | +| `description` | string | No | Case description | #### Output @@ -592,7 +592,7 @@ Delete a case | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `caseId` | string | Yes | Case ID \(required\) | +| `caseId` | string | Yes | Salesforce Case ID to delete \(18-character string starting with 500\) | #### Output @@ -613,10 +613,10 @@ Get task(s) from Salesforce | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `taskId` | string | No | Task ID \(optional\) | -| `limit` | string | No | Max results \(default: 100\) | -| `fields` | string | No | Comma-separated fields | -| `orderBy` | string | No | Order by field | +| `taskId` | string | No | Salesforce Task ID \(18-character string starting with 00T\) to get a single task | +| `limit` | string | No | Maximum number of results to return \(default: 100\) | +| `fields` | string | No | Comma-separated list of field API names to return | +| `orderBy` | string | No | Field and direction for sorting \(e.g., ActivityDate DESC\) | #### Output @@ -648,10 +648,10 @@ Create a new task | `subject` | string | Yes | Task subject \(required\) | | `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) | | `priority` | string | No | Priority \(e.g., Low, Normal, High\) | -| `activityDate` | string | No | Due date YYYY-MM-DD | -| `whoId` | string | No | Related Contact/Lead ID | -| `whatId` | string | No | Related Account/Opportunity ID | -| `description` | string | No | Description | +| `activityDate` | string | No | Due date in YYYY-MM-DD format | +| `whoId` | string | No | Related Contact ID \(003...\) or Lead ID \(00Q...\) | +| `whatId` | string | No | Related Account ID \(001...\) or Opportunity ID \(006...\) | +| `description` | string | No | Task description | #### Output @@ -673,12 +673,12 @@ Update an existing task | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `taskId` | string | Yes | Task ID \(required\) | +| `taskId` | string | Yes | Salesforce Task ID to update \(18-character string starting with 00T\) | | `subject` | string | No | Task subject | -| `status` | string | No | Status | -| `priority` | string | No | Priority | -| `activityDate` | string | No | Due date YYYY-MM-DD | -| `description` | string | No | Description | +| `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) | +| `priority` | string | No | Priority \(e.g., Low, Normal, High\) | +| `activityDate` | string | No | Due date in YYYY-MM-DD format | +| `description` | string | No | Task description | #### Output @@ -699,7 +699,7 @@ Delete a task | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `taskId` | string | Yes | Task ID \(required\) | +| `taskId` | string | Yes | Salesforce Task ID to delete \(18-character string starting with 00T\) | #### Output @@ -720,8 +720,8 @@ Get a list of reports accessible by the current user | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `folderName` | string | No | Filter by folder name | -| `searchTerm` | string | No | Search term to filter reports by name | +| `folderName` | string | No | Filter reports by folder name \(case-insensitive partial match\) | +| `searchTerm` | string | No | Search term to filter reports by name or description | #### Output @@ -743,7 +743,7 @@ Get metadata and describe information for a specific report | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `reportId` | string | Yes | Report ID \(required\) | +| `reportId` | string | Yes | Salesforce Report ID \(18-character string starting with 00O\) | #### Output @@ -765,9 +765,9 @@ Execute a report and retrieve the results | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `reportId` | string | Yes | Report ID \(required\) | +| `reportId` | string | Yes | Salesforce Report ID \(18-character string starting with 00O\) | | `includeDetails` | string | No | Include detail rows \(true/false, default: true\) | -| `filters` | string | No | JSON string of report filters to apply | +| `filters` | string | No | JSON array of report filter objects to apply | #### Output @@ -818,7 +818,7 @@ Get a list of dashboards accessible by the current user | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `folderName` | string | No | Filter by folder name | +| `folderName` | string | No | Filter dashboards by folder name \(case-insensitive partial match\) | #### Output @@ -840,7 +840,7 @@ Get details and results for a specific dashboard | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `dashboardId` | string | Yes | Dashboard ID \(required\) | +| `dashboardId` | string | Yes | Salesforce Dashboard ID \(18-character string starting with 01Z\) | #### Output @@ -866,7 +866,7 @@ Refresh a dashboard to get the latest data | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `dashboardId` | string | Yes | Dashboard ID \(required\) | +| `dashboardId` | string | Yes | Salesforce Dashboard ID \(18-character string starting with 01Z\) | #### Output @@ -917,7 +917,7 @@ Retrieve additional query results using the nextRecordsUrl from a previous query | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `nextRecordsUrl` | string | Yes | The nextRecordsUrl from a previous query response | +| `nextRecordsUrl` | string | Yes | The nextRecordsUrl value from a previous query response \(e.g., /services/data/v59.0/query/01g...\) | #### Output @@ -941,7 +941,7 @@ Get metadata and field information for a Salesforce object | --------- | ---- | -------- | ----------- | | `idToken` | string | No | No description | | `instanceUrl` | string | No | No description | -| `objectName` | string | Yes | API name of the object \(e.g., Account, Contact, Lead, Custom_Object__c\) | +| `objectName` | string | Yes | Salesforce object API name \(e.g., Account, Contact, Lead, Custom_Object__c\) | #### Output diff --git a/apps/docs/content/docs/en/tools/sendgrid.mdx b/apps/docs/content/docs/en/tools/sendgrid.mdx index 40aec3bb0..a8e25a288 100644 --- a/apps/docs/content/docs/en/tools/sendgrid.mdx +++ b/apps/docs/content/docs/en/tools/sendgrid.mdx @@ -62,7 +62,7 @@ Send an email using SendGrid API | `bcc` | string | No | BCC email address | | `replyTo` | string | No | Reply-to email address | | `replyToName` | string | No | Reply-to name | -| `attachments` | file[] | No | Files to attach to the email | +| `attachments` | file[] | No | Files to attach to the email as an array of attachment objects | | `templateId` | string | No | SendGrid template ID to use | | `dynamicTemplateData` | json | No | JSON object of dynamic template data | diff --git a/apps/docs/content/docs/en/tools/sentry.mdx b/apps/docs/content/docs/en/tools/sentry.mdx index a2e6f020a..724915e98 100644 --- a/apps/docs/content/docs/en/tools/sentry.mdx +++ b/apps/docs/content/docs/en/tools/sentry.mdx @@ -54,8 +54,8 @@ List issues from Sentry for a specific organization and optionally a specific pr | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `projectSlug` | string | No | Filter issues by specific project slug \(optional\) | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `projectSlug` | string | No | Filter issues by specific project slug \(e.g., "my-project"\) | | `query` | string | No | Search query to filter issues. Supports Sentry search syntax \(e.g., "is:unresolved", "level:error"\) | | `statsPeriod` | string | No | Time period for stats \(e.g., "24h", "7d", "30d"\). Defaults to 24h if not specified. | | `cursor` | string | No | Pagination cursor for retrieving next page of results | @@ -117,8 +117,8 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `issueId` | string | Yes | The unique ID of the issue to retrieve | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `issueId` | string | Yes | The unique ID of the issue to retrieve \(e.g., "12345"\) | #### Output @@ -171,8 +171,8 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `issueId` | string | Yes | The unique ID of the issue to update | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `issueId` | string | Yes | The unique ID of the issue to update \(e.g., "12345"\) | | `status` | string | No | New status for the issue: resolved, unresolved, ignored, or resolvedInNextRelease | | `assignedTo` | string | No | User ID or email to assign the issue to. Use empty string to unassign. | | `isBookmarked` | boolean | No | Whether to bookmark the issue | @@ -206,7 +206,7 @@ List all projects in a Sentry organization. Returns project details including na | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `cursor` | string | No | Pagination cursor for retrieving next page of results | | `limit` | number | No | Number of projects to return per page \(default: 25, max: 100\) | @@ -246,8 +246,8 @@ Retrieve detailed information about a specific Sentry project by its slug. Retur | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `projectSlug` | string | Yes | The ID or slug of the project to retrieve | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `projectSlug` | string | Yes | The slug of the project to retrieve \(e.g., "my-project"\) | #### Output @@ -297,7 +297,7 @@ Create a new Sentry project in an organization. Requires a team to associate the | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `name` | string | Yes | The name of the project | | `teamSlug` | string | Yes | The slug of the team that will own this project | | `slug` | string | No | URL-friendly project identifier \(auto-generated from name if not provided\) | @@ -344,8 +344,8 @@ Update a Sentry project by changing its name, slug, platform, or other settings. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `projectSlug` | string | Yes | The slug of the project to update | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `projectSlug` | string | Yes | The slug of the project to update \(e.g., "my-project"\) | | `name` | string | No | New name for the project | | `slug` | string | No | New URL-friendly project identifier | | `platform` | string | No | New platform/language for the project \(e.g., javascript, python, node\) | @@ -381,9 +381,9 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `projectSlug` | string | Yes | The slug of the project to list events from | -| `issueId` | string | No | Filter events by a specific issue ID | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `projectSlug` | string | Yes | The slug of the project to list events from \(e.g., "my-project"\) | +| `issueId` | string | No | Filter events by a specific issue ID \(e.g., "12345"\) | | `query` | string | No | Search query to filter events. Supports Sentry search syntax \(e.g., "user.email:*@example.com"\) | | `cursor` | string | No | Pagination cursor for retrieving next page of results | | `limit` | number | No | Number of events to return per page \(default: 50, max: 100\) | @@ -440,9 +440,9 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `projectSlug` | string | Yes | The slug of the project | -| `eventId` | string | Yes | The unique ID of the event to retrieve | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `projectSlug` | string | Yes | The slug of the project \(e.g., "my-project"\) | +| `eventId` | string | Yes | The unique ID of the event to retrieve \(e.g., "abc123def456"\) | #### Output @@ -492,9 +492,9 @@ List releases for a Sentry organization or project. Returns release details incl | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `projectSlug` | string | No | Filter releases by specific project slug \(optional\) | -| `query` | string | No | Search query to filter releases \(e.g., version name pattern\) | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `projectSlug` | string | No | Filter releases by specific project slug \(e.g., "my-project"\) | +| `query` | string | No | Search query to filter releases \(e.g., "1.0" to match version patterns\) | | `cursor` | string | No | Pagination cursor for retrieving next page of results | | `limit` | number | No | Number of releases to return per page \(default: 25, max: 100\) | @@ -556,7 +556,7 @@ Create a new release in Sentry. A release is a version of your code deployed to | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `version` | string | Yes | Version identifier for the release \(e.g., "2.0.0", "my-app@1.0.0", or a git commit SHA\) | | `projects` | string | Yes | Comma-separated list of project slugs to associate with this release | | `ref` | string | No | Git reference \(commit SHA, tag, or branch\) for this release | @@ -619,8 +619,8 @@ Create a deploy record for a Sentry release in a specific environment. Deploys t | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Sentry API authentication token | -| `organizationSlug` | string | Yes | The slug of the organization | -| `version` | string | Yes | Version identifier of the release being deployed | +| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | +| `version` | string | Yes | Version identifier of the release being deployed \(e.g., "1.0.0" or "abc123"\) | | `environment` | string | Yes | Environment name where the release is being deployed \(e.g., "production", "staging"\) | | `name` | string | No | Optional name for this deploy \(e.g., "Deploy v2.0 to Production"\) | | `url` | string | No | URL pointing to the deploy \(e.g., CI/CD pipeline URL\) | diff --git a/apps/docs/content/docs/en/tools/serper.mdx b/apps/docs/content/docs/en/tools/serper.mdx index 33706b662..ccc21f34e 100644 --- a/apps/docs/content/docs/en/tools/serper.mdx +++ b/apps/docs/content/docs/en/tools/serper.mdx @@ -41,11 +41,11 @@ A powerful web search tool that provides access to Google search results through | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | The search query | -| `num` | number | No | Number of results to return | -| `gl` | string | No | Country code for search results | -| `hl` | string | No | Language code for search results | -| `type` | string | No | Type of search to perform | +| `query` | string | Yes | The search query \(e.g., "latest AI news", "best restaurants in NYC"\) | +| `num` | number | No | Number of results to return \(e.g., 10, 20, 50\) | +| `gl` | string | No | Country code for search results \(e.g., "us", "uk", "de", "fr"\) | +| `hl` | string | No | Language code for search results \(e.g., "en", "es", "de", "fr"\) | +| `type` | string | No | Type of search to perform \(e.g., "search", "news", "images", "videos", "places", "shopping"\) | | `apiKey` | string | Yes | Serper API Key | #### Output diff --git a/apps/docs/content/docs/en/tools/servicenow.mdx b/apps/docs/content/docs/en/tools/servicenow.mdx index 879e80812..f2d831458 100644 --- a/apps/docs/content/docs/en/tools/servicenow.mdx +++ b/apps/docs/content/docs/en/tools/servicenow.mdx @@ -44,7 +44,7 @@ Create a new record in a ServiceNow table | `username` | string | Yes | ServiceNow username | | `password` | string | Yes | ServiceNow password | | `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user\) | -| `fields` | json | Yes | Fields to set on the record \(JSON object\) | +| `fields` | json | Yes | Fields to set on the record as JSON object \(e.g., \{"short_description": "Issue title", "priority": "1"\}\) | #### Output @@ -64,12 +64,12 @@ Read records from a ServiceNow table | `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) | | `username` | string | Yes | ServiceNow username | | `password` | string | Yes | ServiceNow password | -| `tableName` | string | Yes | Table name | -| `sysId` | string | No | Specific record sys_id | +| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) | +| `sysId` | string | No | Specific record sys_id \(e.g., 6816f79cc0a8016401c5a33be04be441\) | | `number` | string | No | Record number \(e.g., INC0010001\) | | `query` | string | No | Encoded query string \(e.g., "active=true^priority=1"\) | -| `limit` | number | No | Maximum number of records to return | -| `fields` | string | No | Comma-separated list of fields to return | +| `limit` | number | No | Maximum number of records to return \(e.g., 10, 50, 100\) | +| `fields` | string | No | Comma-separated list of fields to return \(e.g., sys_id,number,short_description,state\) | #### Output @@ -89,9 +89,9 @@ Update an existing record in a ServiceNow table | `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) | | `username` | string | Yes | ServiceNow username | | `password` | string | Yes | ServiceNow password | -| `tableName` | string | Yes | Table name | -| `sysId` | string | Yes | Record sys_id to update | -| `fields` | json | Yes | Fields to update \(JSON object\) | +| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) | +| `sysId` | string | Yes | Record sys_id to update \(e.g., 6816f79cc0a8016401c5a33be04be441\) | +| `fields` | json | Yes | Fields to update as JSON object \(e.g., \{"state": "2", "priority": "1"\}\) | #### Output @@ -111,8 +111,8 @@ Delete a record from a ServiceNow table | `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) | | `username` | string | Yes | ServiceNow username | | `password` | string | Yes | ServiceNow password | -| `tableName` | string | Yes | Table name | -| `sysId` | string | Yes | Record sys_id to delete | +| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) | +| `sysId` | string | Yes | Record sys_id to delete \(e.g., 6816f79cc0a8016401c5a33be04be441\) | #### Output diff --git a/apps/docs/content/docs/en/tools/sharepoint.mdx b/apps/docs/content/docs/en/tools/sharepoint.mdx index 397fc2fb9..d348a0f90 100644 --- a/apps/docs/content/docs/en/tools/sharepoint.mdx +++ b/apps/docs/content/docs/en/tools/sharepoint.mdx @@ -43,7 +43,7 @@ Create a new page in a SharePoint site | --------- | ---- | -------- | ----------- | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteSelector` | string | No | Select the SharePoint site | -| `pageName` | string | Yes | The name of the page to create | +| `pageName` | string | Yes | The name of the page to create. Example: My-New-Page.aspx or Report-2024.aspx | | `pageTitle` | string | No | The title of the page \(defaults to page name if not provided\) | | `pageContent` | string | No | The content of the page | @@ -70,8 +70,8 @@ Read a specific page from a SharePoint site | --------- | ---- | -------- | ----------- | | `siteSelector` | string | No | Select the SharePoint site | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) | -| `pageId` | string | No | The ID of the page to read | -| `pageName` | string | No | The name of the page to read \(alternative to pageId\) | +| `pageId` | string | No | The ID of the page to read. Example: a GUID like 12345678-1234-1234-1234-123456789012 | +| `pageName` | string | No | The name of the page to read \(alternative to pageId\). Example: Home.aspx or About-Us.aspx | | `maxPages` | number | No | Maximum number of pages to return when listing all pages \(default: 10, max: 50\) | #### Output @@ -112,7 +112,7 @@ List details of all SharePoint sites | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteSelector` | string | No | Select the SharePoint site | -| `groupId` | string | No | The group ID for accessing a group team site | +| `groupId` | string | No | The group ID for accessing a group team site. Example: a GUID like 12345678-1234-1234-1234-123456789012 | #### Output @@ -150,7 +150,7 @@ Create a new list in a SharePoint site | --------- | ---- | -------- | ----------- | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteSelector` | string | No | Select the SharePoint site | -| `listDisplayName` | string | Yes | Display name of the list to create | +| `listDisplayName` | string | Yes | Display name of the list to create. Example: Project Tasks or Customer Contacts | | `listDescription` | string | No | Description of the list | | `listTemplate` | string | No | List template name \(e.g., 'genericList'\) | | `pageContent` | string | No | Optional JSON of columns. Either a top-level array of column definitions or an object with \{ columns: \[...\] \}. | @@ -178,7 +178,7 @@ Get metadata (and optionally columns/items) for a SharePoint list | --------- | ---- | -------- | ----------- | | `siteSelector` | string | No | Select the SharePoint site | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) | -| `listId` | string | No | The ID of the list to retrieve | +| `listId` | string | No | The ID of the list to retrieve. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 | #### Output @@ -205,8 +205,8 @@ Update the properties (fields) on a SharePoint list item | --------- | ---- | -------- | ----------- | | `siteSelector` | string | No | Select the SharePoint site | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) | -| `listId` | string | No | The ID of the list containing the item | -| `itemId` | string | Yes | The ID of the list item to update | +| `listId` | string | No | The ID of the list containing the item. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 | +| `itemId` | string | Yes | The ID of the list item to update. Example: 1, 42, or 123 | | `listItemFields` | object | Yes | Field values to update on the list item | #### Output @@ -227,7 +227,7 @@ Add a new item to a SharePoint list | --------- | ---- | -------- | ----------- | | `siteSelector` | string | No | Select the SharePoint site | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) | -| `listId` | string | Yes | The ID of the list to add the item to | +| `listId` | string | Yes | The ID of the list to add the item to. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 | | `listItemFields` | object | Yes | Field values for the new list item | #### Output @@ -247,9 +247,9 @@ Upload files to a SharePoint document library | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | No | The ID of the SharePoint site | -| `driveId` | string | No | The ID of the document library \(drive\). If not provided, uses default drive. | -| `folderPath` | string | No | Optional folder path within the document library \(e.g., /Documents/Subfolder\) | -| `fileName` | string | No | Optional: override the uploaded file name | +| `driveId` | string | No | The ID of the document library \(drive\). If not provided, uses default drive. Example: b!abc123def456 | +| `folderPath` | string | No | Optional folder path within the document library. Example: /Documents/Subfolder or /Shared Documents/Reports | +| `fileName` | string | No | Optional: override the uploaded file name. Example: report-2024.pdf | | `files` | file[] | No | Files to upload to SharePoint | #### Output diff --git a/apps/docs/content/docs/en/tools/similarweb.mdx b/apps/docs/content/docs/en/tools/similarweb.mdx index e1c41260b..57eb457dd 100644 --- a/apps/docs/content/docs/en/tools/similarweb.mdx +++ b/apps/docs/content/docs/en/tools/similarweb.mdx @@ -41,7 +41,7 @@ Get comprehensive website analytics including traffic, rankings, engagement, and | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | SimilarWeb API key | -| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) | +| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | #### Output @@ -61,12 +61,12 @@ Get comprehensive website analytics including traffic, rankings, engagement, and | ↳ `country` | string | Country code | | ↳ `share` | number | Traffic share \(0-1\) | | `trafficSources` | json | Traffic source breakdown | -| ↳ `direct` | number | Direct traffic share | -| ↳ `referrals` | number | Referral traffic share | -| ↳ `search` | number | Search traffic share | -| ↳ `social` | number | Social traffic share | -| ↳ `mail` | number | Email traffic share | -| ↳ `paidReferrals` | number | Paid referral traffic share | +| ↳ `direct` | number | Direct traffic share | +| ↳ `referrals` | number | Referral traffic share | +| ↳ `search` | number | Search traffic share | +| ↳ `social` | number | Social traffic share | +| ↳ `mail` | number | Email traffic share | +| ↳ `paidReferrals` | number | Paid referral traffic share | ### `similarweb_traffic_visits` @@ -77,11 +77,11 @@ Get total website visits over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | SimilarWeb API key | -| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) | -| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data | +| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | +| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | -| `startDate` | string | No | Start date in YYYY-MM format | -| `endDate` | string | No | End date in YYYY-MM format | +| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) | +| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output @@ -105,11 +105,11 @@ Get website bounce rate over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | SimilarWeb API key | -| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) | -| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data | +| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | +| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | -| `startDate` | string | No | Start date in YYYY-MM format | -| `endDate` | string | No | End date in YYYY-MM format | +| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) | +| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output @@ -133,11 +133,11 @@ Get average pages per visit over time (desktop and mobile combined) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | SimilarWeb API key | -| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) | -| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data | +| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | +| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | -| `startDate` | string | No | Start date in YYYY-MM format | -| `endDate` | string | No | End date in YYYY-MM format | +| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) | +| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output @@ -161,11 +161,11 @@ Get average desktop visit duration over time (in seconds) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | SimilarWeb API key | -| `domain` | string | Yes | Website domain to analyze \(without www or protocol\) | -| `country` | string | Yes | 2-letter ISO country code or "world" for worldwide data | +| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) | +| `country` | string | Yes | 2-letter ISO country code \(e.g., "us", "gb", "de"\) or "world" for worldwide data | | `granularity` | string | Yes | Data granularity: daily, weekly, or monthly | -| `startDate` | string | No | Start date in YYYY-MM format | -| `endDate` | string | No | End date in YYYY-MM format | +| `startDate` | string | No | Start date in YYYY-MM format \(e.g., "2024-01"\) | +| `endDate` | string | No | End date in YYYY-MM format \(e.g., "2024-12"\) | | `mainDomainOnly` | boolean | No | Exclude subdomains from results | #### Output diff --git a/apps/docs/content/docs/en/tools/slack.mdx b/apps/docs/content/docs/en/tools/slack.mdx index 9bef68c1f..f741ca3c6 100644 --- a/apps/docs/content/docs/en/tools/slack.mdx +++ b/apps/docs/content/docs/en/tools/slack.mdx @@ -86,8 +86,8 @@ Send messages to Slack channels or direct messages. Supports Slack mrkdwn format | `authMethod` | string | No | Authentication method: oauth or bot_token | | `destinationType` | string | No | Destination type: channel or dm | | `botToken` | string | No | Bot token for Custom Bot | -| `channel` | string | No | Target Slack channel \(e.g., #general\) | -| `dmUserId` | string | No | Target Slack user for direct messages | +| `channel` | string | No | Slack channel ID \(e.g., C1234567890\) | +| `dmUserId` | string | No | Slack user ID for direct messages \(e.g., U1234567890\) | | `text` | string | Yes | Message text to send \(supports Slack mrkdwn formatting\) | | `thread_ts` | string | No | Thread timestamp to reply to \(creates thread reply\) | | `files` | file[] | No | Files to attach to the message | @@ -165,7 +165,7 @@ Create and share Slack canvases in channels. Canvases are collaborative document | --------- | ---- | -------- | ----------- | | `authMethod` | string | No | Authentication method: oauth or bot_token | | `botToken` | string | No | Bot token for Custom Bot | -| `channel` | string | Yes | Target Slack channel \(e.g., #general\) | +| `channel` | string | Yes | Slack channel ID \(e.g., C1234567890\) | | `title` | string | Yes | Title of the canvas | | `content` | string | Yes | Canvas content in markdown format | | `document_content` | object | No | Structured canvas document content | @@ -189,8 +189,8 @@ Read the latest messages from Slack channels. Retrieve conversation history with | `authMethod` | string | No | Authentication method: oauth or bot_token | | `destinationType` | string | No | Destination type: channel or dm | | `botToken` | string | No | Bot token for Custom Bot | -| `channel` | string | No | Slack channel to read messages from \(e.g., #general\) | -| `dmUserId` | string | No | Target Slack user for DM conversation | +| `channel` | string | No | Slack channel ID to read messages from \(e.g., C1234567890\) | +| `dmUserId` | string | No | Slack user ID for DM conversation \(e.g., U1234567890\) | | `limit` | number | No | Number of messages to retrieve \(default: 10, max: 15\) | | `oldest` | string | No | Start of time range \(timestamp\) | | `latest` | string | No | End of time range \(timestamp\) | diff --git a/apps/docs/content/docs/en/tools/sqs.mdx b/apps/docs/content/docs/en/tools/sqs.mdx index 36820cf01..bd90c9562 100644 --- a/apps/docs/content/docs/en/tools/sqs.mdx +++ b/apps/docs/content/docs/en/tools/sqs.mdx @@ -48,10 +48,10 @@ Send a message to an Amazon SQS queue | `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `accessKeyId` | string | Yes | AWS access key ID | | `secretAccessKey` | string | Yes | AWS secret access key | -| `queueUrl` | string | Yes | Queue URL | -| `data` | object | Yes | Message body to send | -| `messageGroupId` | string | No | Message group ID \(optional\) | -| `messageDeduplicationId` | string | No | Message deduplication ID \(optional\) | +| `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\) | +| `data` | object | Yes | Message body to send as JSON object \(e.g., \{ "action": "process", "payload": \{...\} \}\) | +| `messageGroupId` | string | No | Message group ID for FIFO queues \(e.g., "order-processing-group"\) | +| `messageDeduplicationId` | string | No | Message deduplication ID for FIFO queues \(e.g., "order-12345-v1"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/stt.mdx b/apps/docs/content/docs/en/tools/stt.mdx index 6a75f2f65..3026810a3 100644 --- a/apps/docs/content/docs/en/tools/stt.mdx +++ b/apps/docs/content/docs/en/tools/stt.mdx @@ -59,7 +59,7 @@ Transcribe audio to text using OpenAI Whisper | `provider` | string | Yes | STT provider \(whisper\) | | `apiKey` | string | Yes | OpenAI API key | | `model` | string | No | Whisper model to use \(default: whisper-1\) | -| `audioFile` | file | No | Audio or video file to transcribe | +| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioUrl` | string | No | URL to audio or video file | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | @@ -67,6 +67,7 @@ Transcribe audio to text using OpenAI Whisper | `translateToEnglish` | boolean | No | Translate audio to English | | `prompt` | string | No | Optional text to guide the model's style or continue a previous audio segment. Helps with proper nouns and context. | | `temperature` | number | No | Sampling temperature between 0 and 1. Higher values make output more random, lower values more focused and deterministic. | +| `responseFormat` | string | No | Output format for the transcription \(e.g., "json", "text", "srt", "verbose_json", "vtt"\) | #### Output @@ -93,7 +94,7 @@ Transcribe audio to text using Deepgram | `provider` | string | Yes | STT provider \(deepgram\) | | `apiKey` | string | Yes | Deepgram API key | | `model` | string | No | Deepgram model to use \(nova-3, nova-2, whisper-large, etc.\) | -| `audioFile` | file | No | Audio or video file to transcribe | +| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioUrl` | string | No | URL to audio or video file | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | @@ -126,7 +127,7 @@ Transcribe audio to text using ElevenLabs | `provider` | string | Yes | STT provider \(elevenlabs\) | | `apiKey` | string | Yes | ElevenLabs API key | | `model` | string | No | ElevenLabs model to use \(scribe_v1, scribe_v1_experimental\) | -| `audioFile` | file | No | Audio or video file to transcribe | +| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioUrl` | string | No | URL to audio or video file | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | @@ -153,7 +154,7 @@ Transcribe audio to text using AssemblyAI with advanced NLP features | `provider` | string | Yes | STT provider \(assemblyai\) | | `apiKey` | string | Yes | AssemblyAI API key | | `model` | string | No | AssemblyAI model to use \(default: best\) | -| `audioFile` | file | No | Audio or video file to transcribe | +| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioUrl` | string | No | URL to audio or video file | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | @@ -202,7 +203,7 @@ Transcribe audio to text using Google Gemini with multimodal capabilities | `provider` | string | Yes | STT provider \(gemini\) | | `apiKey` | string | Yes | Google API key | | `model` | string | No | Gemini model to use \(default: gemini-2.5-flash\) | -| `audioFile` | file | No | Audio or video file to transcribe | +| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioUrl` | string | No | URL to audio or video file | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | diff --git a/apps/docs/content/docs/en/tools/tavily.mdx b/apps/docs/content/docs/en/tools/tavily.mdx index 44c347a98..1ad469709 100644 --- a/apps/docs/content/docs/en/tools/tavily.mdx +++ b/apps/docs/content/docs/en/tools/tavily.mdx @@ -41,12 +41,12 @@ Perform AI-powered web searches using Tavily | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | The search query to execute | -| `max_results` | number | No | Maximum number of results \(1-20\) | -| `topic` | string | No | Category type: general, news, or finance \(default: general\) | -| `search_depth` | string | No | Search scope: basic \(1 credit\) or advanced \(2 credits\) \(default: basic\) | -| `include_answer` | string | No | LLM-generated response: true/basic for quick answer or advanced for detailed | -| `include_raw_content` | string | No | Parsed HTML content: true/markdown or text format | +| `query` | string | Yes | The search query to execute \(e.g., "latest AI research papers 2024"\) | +| `max_results` | number | No | Maximum number of results \(1-20, e.g., 5\) | +| `topic` | string | No | Category type: general, news, or finance \(e.g., "news"\) | +| `search_depth` | string | No | Search scope: basic \(1 credit\) or advanced \(2 credits\) \(e.g., "advanced"\) | +| `include_answer` | string | No | LLM-generated response: true/basic for quick answer or advanced for detailed \(e.g., "advanced"\) | +| `include_raw_content` | string | No | Parsed HTML content: true/markdown or text format \(e.g., "markdown"\) | | `include_images` | boolean | No | Include image search results | | `include_image_descriptions` | boolean | No | Add descriptive text for images | | `include_favicon` | boolean | No | Include favicon URLs | @@ -54,8 +54,8 @@ Perform AI-powered web searches using Tavily | `time_range` | string | No | Filter by recency: day/d, week/w, month/m, year/y | | `start_date` | string | No | Earliest publication date \(YYYY-MM-DD format\) | | `end_date` | string | No | Latest publication date \(YYYY-MM-DD format\) | -| `include_domains` | string | No | Comma-separated list of domains to whitelist \(max 300\) | -| `exclude_domains` | string | No | Comma-separated list of domains to blacklist \(max 150\) | +| `include_domains` | string | No | Comma-separated list of domains to whitelist \(e.g., "github.com,stackoverflow.com"\) | +| `exclude_domains` | string | No | Comma-separated list of domains to blacklist \(e.g., "pinterest.com,reddit.com"\) | | `country` | string | No | Boost results from specified country \(general topic only\) | | `auto_parameters` | boolean | No | Automatic parameter configuration based on query intent | | `apiKey` | string | Yes | Tavily API Key | diff --git a/apps/docs/content/docs/en/tools/telegram.mdx b/apps/docs/content/docs/en/tools/telegram.mdx index dd1a18fff..0a0301789 100644 --- a/apps/docs/content/docs/en/tools/telegram.mdx +++ b/apps/docs/content/docs/en/tools/telegram.mdx @@ -67,7 +67,7 @@ Send messages to Telegram channels or users through the Telegram Bot API. Enable | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | | `text` | string | Yes | Message text to send | #### Output @@ -99,8 +99,8 @@ Delete messages in Telegram channels or chats through the Telegram Bot API. Requ | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | -| `messageId` | string | Yes | Message ID to delete | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | +| `messageId` | string | Yes | Telegram message ID \(numeric identifier of the message to delete\) | #### Output @@ -120,7 +120,7 @@ Send photos to Telegram channels or users through the Telegram Bot API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | | `photo` | string | Yes | Photo to send. Pass a file_id or HTTP URL | | `caption` | string | No | Photo caption \(optional\) | @@ -159,7 +159,7 @@ Send videos to Telegram channels or users through the Telegram Bot API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | | `video` | string | Yes | Video to send. Pass a file_id or HTTP URL | | `caption` | string | No | Video caption \(optional\) | @@ -231,7 +231,7 @@ Send audio files to Telegram channels or users through the Telegram Bot API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | | `audio` | string | Yes | Audio file to send. Pass a file_id or HTTP URL | | `caption` | string | No | Audio caption \(optional\) | @@ -273,7 +273,7 @@ Send animations (GIFs) to Telegram channels or users through the Telegram Bot AP | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | | `animation` | string | Yes | Animation to send. Pass a file_id or HTTP URL | | `caption` | string | No | Animation caption \(optional\) | @@ -345,7 +345,7 @@ Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the T | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `botToken` | string | Yes | Your Telegram Bot API Token | -| `chatId` | string | Yes | Target Telegram chat ID | +| `chatId` | string | Yes | Telegram chat ID \(numeric, can be negative for groups\) | | `files` | file[] | No | Document file to send \(PDF, ZIP, DOC, etc.\). Max size: 50MB | | `caption` | string | No | Document caption \(optional\) | diff --git a/apps/docs/content/docs/en/tools/tinybird.mdx b/apps/docs/content/docs/en/tools/tinybird.mdx index f36109a37..560c9458a 100644 --- a/apps/docs/content/docs/en/tools/tinybird.mdx +++ b/apps/docs/content/docs/en/tools/tinybird.mdx @@ -45,8 +45,9 @@ Send events to a Tinybird Data Source using the Events API. Supports JSON and ND | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `base_url` | string | Yes | Tinybird API base URL \(e.g., https://api.tinybird.co or https://api.us-east.tinybird.co\) | -| `datasource` | string | Yes | Name of the Tinybird Data Source to send events to | -| `data` | string | Yes | Data to send as NDJSON \(newline-delimited JSON\) or JSON string. Each event should be a valid JSON object. | +| `datasource` | string | Yes | Name of the Tinybird Data Source to send events to. Example: "events_raw", "user_analytics" | +| `data` | string | Yes | Data to send as NDJSON \(newline-delimited JSON\) or JSON string. Each event should be a valid JSON object. Example NDJSON: \{"user_id": 1, "event": "click"\}\\n\{"user_id": 2, "event": "view"\} | +| `NDJSON` | string | No | No description | | `wait` | boolean | No | Wait for database acknowledgment before responding. Enables safer retries but introduces latency. Defaults to false. | | `format` | string | No | Format of the events data: "ndjson" \(default\) or "json" | | `compression` | string | No | Compression format: "none" \(default\) or "gzip" | @@ -68,8 +69,8 @@ Execute SQL queries against Tinybird Pipes and Data Sources using the Query API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `base_url` | string | Yes | Tinybird API base URL \(e.g., https://api.tinybird.co\) | -| `query` | string | Yes | SQL query to execute. Specify your desired output format \(e.g., FORMAT JSON, FORMAT CSV, FORMAT TSV\). JSON format provides structured data, while other formats return raw text. | -| `pipeline` | string | No | Optional pipe name. When provided, enables SELECT * FROM _ syntax | +| `query` | string | Yes | SQL query to execute. Specify your desired output format \(e.g., FORMAT JSON, FORMAT CSV, FORMAT TSV\). JSON format provides structured data, while other formats return raw text. Example: "SELECT * FROM my_datasource LIMIT 100 FORMAT JSON" | +| `pipeline` | string | No | Optional pipe name. When provided, enables SELECT * FROM _ syntax. Example: "my_pipe", "analytics_pipe" | | `token` | string | Yes | Tinybird API Token with PIPE:READ scope | #### Output diff --git a/apps/docs/content/docs/en/tools/trello.mdx b/apps/docs/content/docs/en/tools/trello.mdx index 91d76f752..e4d377f65 100644 --- a/apps/docs/content/docs/en/tools/trello.mdx +++ b/apps/docs/content/docs/en/tools/trello.mdx @@ -42,7 +42,7 @@ List all lists on a Trello board | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `boardId` | string | Yes | ID of the board to list lists from | +| `boardId` | string | Yes | Trello board ID \(24-character hex string\) | #### Output @@ -59,8 +59,8 @@ List all cards on a Trello board | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `boardId` | string | Yes | ID of the board to list cards from | -| `listId` | string | No | Optional: Filter cards by list ID | +| `boardId` | string | Yes | Trello board ID \(24-character hex string\) | +| `listId` | string | No | Trello list ID to filter cards \(24-character hex string\) | #### Output @@ -77,13 +77,13 @@ Create a new card on a Trello board | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `boardId` | string | Yes | ID of the board to create the card on | -| `listId` | string | Yes | ID of the list to create the card in | +| `boardId` | string | Yes | Trello board ID \(24-character hex string\) | +| `listId` | string | Yes | Trello list ID \(24-character hex string\) | | `name` | string | Yes | Name/title of the card | | `desc` | string | No | Description of the card | | `pos` | string | No | Position of the card \(top, bottom, or positive float\) | | `due` | string | No | Due date \(ISO 8601 format\) | -| `labels` | string | No | Comma-separated list of label IDs | +| `labels` | string | No | Comma-separated list of label IDs \(24-character hex strings\) | #### Output @@ -99,11 +99,11 @@ Update an existing card on Trello | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `cardId` | string | Yes | ID of the card to update | +| `cardId` | string | Yes | Trello card ID \(24-character hex string\) | | `name` | string | No | New name/title of the card | | `desc` | string | No | New description of the card | | `closed` | boolean | No | Archive/close the card \(true\) or reopen it \(false\) | -| `idList` | string | No | Move card to a different list | +| `idList` | string | No | Trello list ID to move card to \(24-character hex string\) | | `due` | string | No | Due date \(ISO 8601 format\) | | `dueComplete` | boolean | No | Mark the due date as complete | @@ -121,8 +121,8 @@ Get activity/actions from a board or card | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `boardId` | string | No | ID of the board to get actions from \(either boardId or cardId required\) | -| `cardId` | string | No | ID of the card to get actions from \(either boardId or cardId required\) | +| `boardId` | string | No | Trello board ID \(24-character hex string\). Either boardId or cardId required | +| `cardId` | string | No | Trello card ID \(24-character hex string\). Either boardId or cardId required | | `filter` | string | No | Filter actions by type \(e.g., "commentCard,updateCard,createCard" or "all"\) | | `limit` | number | No | Maximum number of actions to return \(default: 50, max: 1000\) | @@ -141,7 +141,7 @@ Add a comment to a Trello card | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `cardId` | string | Yes | ID of the card to comment on | +| `cardId` | string | Yes | Trello card ID \(24-character hex string\) | | `text` | string | Yes | Comment text | #### Output diff --git a/apps/docs/content/docs/en/tools/tts.mdx b/apps/docs/content/docs/en/tools/tts.mdx index f4c1ea4cc..62d3f6ffb 100644 --- a/apps/docs/content/docs/en/tools/tts.mdx +++ b/apps/docs/content/docs/en/tools/tts.mdx @@ -59,12 +59,12 @@ Convert text to speech using OpenAI TTS models | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `apiKey` | string | Yes | OpenAI API key | -| `model` | string | No | TTS model to use \(tts-1, tts-1-hd, or gpt-4o-mini-tts\) | -| `voice` | string | No | Voice to use \(alloy, ash, ballad, cedar, coral, echo, marin, sage, shimmer, verse\) | +| `model` | string | No | OpenAI TTS model identifier \(e.g., "tts-1", "tts-1-hd", "gpt-4o-mini-tts"\) | +| `voice` | string | No | OpenAI voice identifier \(e.g., "alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer"\) | | `responseFormat` | string | No | Audio format \(mp3, opus, aac, flac, wav, pcm\) | -| `speed` | number | No | Speech speed \(0.25 to 4.0, default: 1.0\) | +| `speed` | number | No | Speech speed multiplier from 0.25 to 4.0 \(e.g., 0.5 for slower, 1.0 for normal, 2.0 for faster\) | #### Output @@ -85,10 +85,10 @@ Convert text to speech using Deepgram Aura | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `apiKey` | string | Yes | Deepgram API key | -| `model` | string | No | Deepgram model/voice \(e.g., aura-asteria-en, aura-luna-en\) | -| `voice` | string | No | Voice identifier \(alternative to model param\) | +| `model` | string | No | Deepgram model/voice identifier \(e.g., "aura-asteria-en", "aura-luna-en", "aura-2-luna-en"\) | +| `voice` | string | No | Deepgram voice identifier, alternative to model param \(e.g., "aura-asteria-en", "aura-orion-en"\) | | `encoding` | string | No | Audio encoding \(linear16, mp3, opus, aac, flac\) | | `sampleRate` | number | No | Sample rate \(8000, 16000, 24000, 48000\) | | `bitRate` | number | No | Bit rate for compressed formats | @@ -113,10 +113,10 @@ Convert text to speech using ElevenLabs voices | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | -| `voiceId` | string | Yes | The ID of the voice to use | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | +| `voiceId` | string | Yes | ElevenLabs voice identifier \(e.g., "21m00Tcm4TlvDq8ikWAM", "AZnzlk1XvdvUeBnXmlld"\) | | `apiKey` | string | Yes | ElevenLabs API key | -| `modelId` | string | No | Model to use \(e.g., eleven_monolingual_v1, eleven_turbo_v2_5, eleven_flash_v2_5\) | +| `modelId` | string | No | ElevenLabs model identifier \(e.g., "eleven_turbo_v2_5", "eleven_flash_v2_5", "eleven_multilingual_v2"\) | | `stability` | number | No | Voice stability \(0.0 to 1.0, default: 0.5\) | | `similarityBoost` | number | No | Similarity boost \(0.0 to 1.0, default: 0.8\) | | `style` | number | No | Style exaggeration \(0.0 to 1.0\) | @@ -141,13 +141,13 @@ Convert text to speech using Cartesia Sonic (ultra-low latency) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `apiKey` | string | Yes | Cartesia API key | -| `modelId` | string | No | Model ID \(sonic-english, sonic-multilingual\) | -| `voice` | string | No | Voice ID or embedding | -| `language` | string | No | Language code \(en, es, fr, de, it, pt, etc.\) | +| `modelId` | string | No | Cartesia model identifier \(e.g., "sonic", "sonic-2", "sonic-3", "sonic-multilingual"\) | +| `voice` | string | No | Cartesia voice identifier or embedding \(e.g., "a0e99841-438c-4a64-b679-ae501e7d6091"\) | +| `language` | string | No | Language code for speech synthesis \(e.g., "en", "es", "fr", "de", "it", "pt"\) | | `outputFormat` | json | No | Output format configuration \(container, encoding, sampleRate\) | -| `speed` | number | No | Speed multiplier | +| `speed` | number | No | Speech speed multiplier \(e.g., 0.5 for slower, 1.0 for normal, 2.0 for faster\) | | `emotion` | array | No | Emotion tags for Sonic-3 \(e.g., \['positivity:high'\]\) | #### Output @@ -169,13 +169,13 @@ Convert text to speech using Google Cloud Text-to-Speech | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `apiKey` | string | Yes | Google Cloud API key | -| `voiceId` | string | No | Voice ID \(e.g., en-US-Neural2-A, en-US-Wavenet-D\) | -| `languageCode` | string | Yes | Language code \(e.g., en-US, es-ES, fr-FR\) | +| `voiceId` | string | No | Google Cloud voice identifier \(e.g., "en-US-Neural2-A", "en-US-Wavenet-D", "en-GB-Neural2-B"\) | +| `languageCode` | string | Yes | BCP-47 language code for speech synthesis \(e.g., "en-US", "es-ES", "fr-FR", "de-DE"\) | | `gender` | string | No | Voice gender \(MALE, FEMALE, NEUTRAL\) | | `audioEncoding` | string | No | Audio encoding \(LINEAR16, MP3, OGG_OPUS, MULAW, ALAW\) | -| `speakingRate` | number | No | Speaking rate \(0.25 to 2.0, default: 1.0\) | +| `speakingRate` | number | No | Speaking rate multiplier from 0.25 to 2.0 \(e.g., 0.5 for slower, 1.0 for normal, 1.5 for faster\) | | `pitch` | number | No | Voice pitch \(-20.0 to 20.0, default: 0.0\) | | `volumeGainDb` | number | No | Volume gain in dB \(-96.0 to 16.0\) | | `sampleRateHertz` | number | No | Sample rate in Hz | @@ -200,9 +200,9 @@ Convert text to speech using Azure Cognitive Services | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `apiKey` | string | Yes | Azure Speech Services API key | -| `voiceId` | string | No | Voice ID \(e.g., en-US-JennyNeural, en-US-GuyNeural\) | +| `voiceId` | string | No | Azure voice identifier \(e.g., "en-US-JennyNeural", "en-US-GuyNeural", "en-GB-SoniaNeural"\) | | `region` | string | No | Azure region \(e.g., eastus, westus, westeurope\) | | `outputFormat` | string | No | Output audio format | | `rate` | string | No | Speaking rate \(e.g., +10%, -20%, 1.5\) | @@ -230,13 +230,13 @@ Convert text to speech using PlayHT (voice cloning) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text to convert to speech | +| `text` | string | Yes | The text content to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `apiKey` | string | Yes | PlayHT API key \(AUTHORIZATION header\) | | `userId` | string | Yes | PlayHT user ID \(X-USER-ID header\) | -| `voice` | string | No | Voice ID or manifest URL | +| `voice` | string | No | PlayHT voice identifier or manifest URL \(e.g., "s3://voice-cloning-zero-shot/..."\) | | `quality` | string | No | Quality level \(draft, standard, premium\) | | `outputFormat` | string | No | Output format \(mp3, wav, ogg, flac, mulaw\) | -| `speed` | number | No | Speed multiplier \(0.5 to 2.0\) | +| `speed` | number | No | Speech speed multiplier from 0.5 to 2.0 \(e.g., 0.5 for slower, 1.0 for normal, 1.5 for faster\) | | `temperature` | number | No | Creativity/randomness \(0.0 to 2.0\) | | `voiceGuidance` | number | No | Voice stability \(1.0 to 6.0\) | | `textGuidance` | number | No | Text adherence \(1.0 to 6.0\) | diff --git a/apps/docs/content/docs/en/tools/twilio_sms.mdx b/apps/docs/content/docs/en/tools/twilio_sms.mdx index 2b7f6f82e..42bfc08cb 100644 --- a/apps/docs/content/docs/en/tools/twilio_sms.mdx +++ b/apps/docs/content/docs/en/tools/twilio_sms.mdx @@ -41,11 +41,11 @@ Send text messages to single or multiple recipients using the Twilio API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `phoneNumbers` | string | Yes | Phone numbers to send the message to, separated by newlines | +| `phoneNumbers` | string | Yes | Phone numbers to send the message to in E.164 format \(e.g., +15551234567\), separated by newlines | | `message` | string | Yes | Message to send | | `accountSid` | string | Yes | Twilio Account SID | | `authToken` | string | Yes | Twilio Auth Token | -| `fromNumber` | string | Yes | Twilio phone number to send the message from | +| `fromNumber` | string | Yes | Twilio phone number to send the message from in E.164 format \(e.g., +15551234567\) | #### Output diff --git a/apps/docs/content/docs/en/tools/twilio_voice.mdx b/apps/docs/content/docs/en/tools/twilio_voice.mdx index 892e0e7a2..6eb2e716f 100644 --- a/apps/docs/content/docs/en/tools/twilio_voice.mdx +++ b/apps/docs/content/docs/en/tools/twilio_voice.mdx @@ -42,10 +42,10 @@ Make an outbound phone call using Twilio Voice API. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `to` | string | Yes | Phone number to call \(E.164 format, e.g., +14155551234\) | -| `from` | string | Yes | Your Twilio phone number to call from \(E.164 format\) | -| `url` | string | No | URL that returns TwiML instructions for the call | -| `twiml` | string | No | TwiML instructions to execute \(alternative to URL\). Use square brackets instead of angle brackets, e.g., \[Response\]\[Say\]Hello\[/Say\]\[/Response\] | +| `to` | string | Yes | Phone number to call in E.164 format \(e.g., +14155551234\) | +| `from` | string | Yes | Your Twilio phone number to call from in E.164 format \(e.g., +14155559876\) | +| `url` | string | No | Webhook URL that returns TwiML instructions for the call \(e.g., https://example.com/twiml\) | +| `twiml` | string | No | TwiML instructions to execute. Use square brackets instead of angle brackets \(e.g., \[Response\]\[Say\]Hello\[/Say\]\[/Response\]\) | | `statusCallback` | string | No | Webhook URL for call status updates | | `statusCallbackMethod` | string | No | HTTP method for status callback \(GET or POST\) | | `accountSid` | string | Yes | Twilio Account SID | @@ -80,9 +80,9 @@ Retrieve a list of calls made to and from an account. | --------- | ---- | -------- | ----------- | | `accountSid` | string | Yes | Twilio Account SID | | `authToken` | string | Yes | Twilio Auth Token | -| `to` | string | No | Filter by calls to this phone number | -| `from` | string | No | Filter by calls from this phone number | -| `status` | string | No | Filter by call status \(queued, ringing, in-progress, completed, etc.\) | +| `to` | string | No | Filter by calls to this phone number in E.164 format \(e.g., +14155551234\) | +| `from` | string | No | Filter by calls from this phone number in E.164 format \(e.g., +14155559876\) | +| `status` | string | No | Filter by call status \(e.g., queued, ringing, in-progress, completed, busy, failed, no-answer, canceled\) | | `startTimeAfter` | string | No | Filter calls that started on or after this date \(YYYY-MM-DD\) | | `startTimeBefore` | string | No | Filter calls that started on or before this date \(YYYY-MM-DD\) | | `pageSize` | number | No | Number of records to return \(max 1000, default 50\) | @@ -106,7 +106,7 @@ Retrieve call recording information and transcription (if enabled via TwiML). | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `recordingSid` | string | Yes | Recording SID to retrieve | +| `recordingSid` | string | Yes | Recording SID to retrieve \(e.g., RExxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\) | | `accountSid` | string | Yes | Twilio Account SID | | `authToken` | string | Yes | Twilio Auth Token | diff --git a/apps/docs/content/docs/en/tools/typeform.mdx b/apps/docs/content/docs/en/tools/typeform.mdx index b9456544d..99998842d 100644 --- a/apps/docs/content/docs/en/tools/typeform.mdx +++ b/apps/docs/content/docs/en/tools/typeform.mdx @@ -40,12 +40,12 @@ Retrieve form responses from Typeform | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | Typeform form ID | +| `formId` | string | Yes | Typeform form ID \(e.g., "abc123XYZ"\) | | `apiKey` | string | Yes | Typeform Personal Access Token | -| `pageSize` | number | No | Number of responses to retrieve \(default: 25\) | -| `since` | string | No | Retrieve responses submitted after this date \(ISO 8601 format\) | -| `until` | string | No | Retrieve responses submitted before this date \(ISO 8601 format\) | -| `completed` | string | No | Filter by completion status \(true/false\) | +| `pageSize` | number | No | Number of responses to retrieve \(e.g., 10, 25, 50\) | +| `since` | string | No | Retrieve responses submitted after this date \(e.g., "2024-01-01T00:00:00Z"\) | +| `until` | string | No | Retrieve responses submitted before this date \(e.g., "2024-12-31T23:59:59Z"\) | +| `completed` | string | No | Filter by completion status \(e.g., "true", "false", "all"\) | #### Output @@ -63,8 +63,8 @@ Download files uploaded in Typeform responses | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | Typeform form ID | -| `responseId` | string | Yes | Response ID containing the files | +| `formId` | string | Yes | Typeform form ID \(e.g., "abc123XYZ"\) | +| `responseId` | string | Yes | Response ID containing the files \(e.g., "resp_xyz789"\) | | `fieldId` | string | Yes | Unique ID of the file upload field | | `filename` | string | Yes | Filename of the uploaded file | | `inline` | boolean | No | Whether to request the file with inline Content-Disposition | @@ -86,7 +86,7 @@ Retrieve insights and analytics for Typeform forms | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `formId` | string | Yes | Typeform form ID | +| `formId` | string | Yes | Typeform form ID \(e.g., "abc123XYZ"\) | | `apiKey` | string | Yes | Typeform Personal Access Token | #### Output @@ -125,10 +125,10 @@ Retrieve a list of all forms in your Typeform account | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Typeform Personal Access Token | -| `search` | string | No | Search query to filter forms by title | -| `page` | number | No | Page number \(default: 1\) | -| `pageSize` | number | No | Number of forms per page \(default: 10, max: 200\) | -| `workspaceId` | string | No | Filter forms by workspace ID | +| `search` | string | No | Search query to filter forms by title \(e.g., "Customer Feedback"\) | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `pageSize` | number | No | Number of forms per page \(e.g., 10, 25, 50, max: 200\) | +| `workspaceId` | string | No | Filter forms by workspace ID \(e.g., "ws_abc123"\) | #### Output @@ -147,7 +147,7 @@ Retrieve complete details and structure of a specific form | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Typeform Personal Access Token | -| `formId` | string | Yes | Form unique identifier | +| `formId` | string | Yes | Form unique identifier \(e.g., "abc123XYZ"\) | #### Output @@ -178,7 +178,7 @@ Create a new form with fields and settings | `apiKey` | string | Yes | Typeform Personal Access Token | | `title` | string | Yes | Form title | | `type` | string | No | Form type \(default: "form"\). Options: "form", "quiz" | -| `workspaceId` | string | No | Workspace ID to create the form in | +| `workspaceId` | string | No | Workspace ID to create the form in \(e.g., "ws_abc123"\) | | `fields` | json | No | Array of field objects defining the form structure. Each field needs: type, title, and optional properties/validations | | `settings` | json | No | Form settings object \(language, progress_bar, etc.\) | | `themeId` | string | No | Theme ID to apply to the form | @@ -207,7 +207,7 @@ Update an existing form using JSON Patch operations | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Typeform Personal Access Token | -| `formId` | string | Yes | Form unique identifier to update | +| `formId` | string | Yes | Form unique identifier to update \(e.g., "abc123XYZ"\) | | `operations` | json | Yes | Array of JSON Patch operations \(RFC 6902\). Each operation needs: op \(add/remove/replace\), path, and value \(for add/replace\) | #### Output @@ -225,7 +225,7 @@ Permanently delete a form and all its responses | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `apiKey` | string | Yes | Typeform Personal Access Token | -| `formId` | string | Yes | Form unique identifier to delete | +| `formId` | string | Yes | Form unique identifier to delete \(e.g., "abc123XYZ"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/wealthbox.mdx b/apps/docs/content/docs/en/tools/wealthbox.mdx index c5dfdc7cf..1a4db1c13 100644 --- a/apps/docs/content/docs/en/tools/wealthbox.mdx +++ b/apps/docs/content/docs/en/tools/wealthbox.mdx @@ -42,7 +42,7 @@ Read content from a Wealthbox note | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `noteId` | string | No | The ID of the note to read | +| `noteId` | string | No | The ID of the note to read \(e.g., "11111"\) | #### Output @@ -66,7 +66,7 @@ Create or update a Wealthbox note | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `content` | string | Yes | The main body of the note | -| `contactId` | string | No | ID of contact to link to this note | +| `contactId` | string | No | ID of contact to link to this note \(e.g., "12345"\) | #### Output @@ -89,7 +89,7 @@ Read content from a Wealthbox contact | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `contactId` | string | No | The ID of the contact to read | +| `contactId` | string | No | The ID of the contact to read \(e.g., "12345"\) | #### Output @@ -138,7 +138,7 @@ Read content from a Wealthbox task | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `taskId` | string | No | The ID of the task to read | +| `taskId` | string | No | The ID of the task to read \(e.g., "67890"\) | #### Output @@ -163,7 +163,7 @@ Create or update a Wealthbox task | --------- | ---- | -------- | ----------- | | `title` | string | Yes | The name/title of the task | | `dueDate` | string | Yes | The due date and time of the task \(format: "YYYY-MM-DD HH:MM AM/PM -HHMM", e.g., "2015-05-24 11:00 AM -0400"\) | -| `contactId` | string | No | ID of contact to link to this task | +| `contactId` | string | No | ID of contact to link to this task \(e.g., "12345"\) | | `description` | string | No | Description or notes about the task | #### Output diff --git a/apps/docs/content/docs/en/tools/webflow.mdx b/apps/docs/content/docs/en/tools/webflow.mdx index da81d3c71..def273f64 100644 --- a/apps/docs/content/docs/en/tools/webflow.mdx +++ b/apps/docs/content/docs/en/tools/webflow.mdx @@ -42,10 +42,10 @@ List all items from a Webflow CMS collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `siteId` | string | Yes | ID of the Webflow site | -| `collectionId` | string | Yes | ID of the collection | -| `offset` | number | No | Offset for pagination \(optional\) | -| `limit` | number | No | Maximum number of items to return \(optional, default: 100\) | +| `siteId` | string | Yes | ID of the Webflow site \(e.g., "580e63e98c9a982ac9b8b741"\) | +| `collectionId` | string | Yes | ID of the collection \(e.g., "580e63fc8c9a982ac9b8b745"\) | +| `offset` | number | No | Offset for pagination \(e.g., 0, 100, 200\) | +| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100; default: 100\) | #### Output @@ -73,9 +73,9 @@ Get a single item from a Webflow CMS collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `siteId` | string | Yes | ID of the Webflow site | -| `collectionId` | string | Yes | ID of the collection | -| `itemId` | string | Yes | ID of the item to retrieve | +| `siteId` | string | Yes | ID of the Webflow site \(e.g., "580e63e98c9a982ac9b8b741"\) | +| `collectionId` | string | Yes | ID of the collection \(e.g., "580e63fc8c9a982ac9b8b745"\) | +| `itemId` | string | Yes | ID of the item to retrieve \(e.g., "580e64008c9a982ac9b8b754"\) | #### Output @@ -92,8 +92,8 @@ Create a new item in a Webflow CMS collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `siteId` | string | Yes | ID of the Webflow site | -| `collectionId` | string | Yes | ID of the collection | +| `siteId` | string | Yes | ID of the Webflow site \(e.g., "580e63e98c9a982ac9b8b741"\) | +| `collectionId` | string | Yes | ID of the collection \(e.g., "580e63fc8c9a982ac9b8b745"\) | | `fieldData` | json | Yes | Field data for the new item as a JSON object. Keys should match collection field names. | #### Output @@ -111,9 +111,9 @@ Update an existing item in a Webflow CMS collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `siteId` | string | Yes | ID of the Webflow site | -| `collectionId` | string | Yes | ID of the collection | -| `itemId` | string | Yes | ID of the item to update | +| `siteId` | string | Yes | ID of the Webflow site \(e.g., "580e63e98c9a982ac9b8b741"\) | +| `collectionId` | string | Yes | ID of the collection \(e.g., "580e63fc8c9a982ac9b8b745"\) | +| `itemId` | string | Yes | ID of the item to update \(e.g., "580e64008c9a982ac9b8b754"\) | | `fieldData` | json | Yes | Field data to update as a JSON object. Only include fields you want to change. | #### Output @@ -131,9 +131,9 @@ Delete an item from a Webflow CMS collection | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `siteId` | string | Yes | ID of the Webflow site | -| `collectionId` | string | Yes | ID of the collection | -| `itemId` | string | Yes | ID of the item to delete | +| `siteId` | string | Yes | ID of the Webflow site \(e.g., "580e63e98c9a982ac9b8b741"\) | +| `collectionId` | string | Yes | ID of the collection \(e.g., "580e63fc8c9a982ac9b8b745"\) | +| `itemId` | string | Yes | ID of the item to delete \(e.g., "580e64008c9a982ac9b8b754"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/whatsapp.mdx b/apps/docs/content/docs/en/tools/whatsapp.mdx index 2c04af3ef..959cd540b 100644 --- a/apps/docs/content/docs/en/tools/whatsapp.mdx +++ b/apps/docs/content/docs/en/tools/whatsapp.mdx @@ -40,9 +40,9 @@ Send WhatsApp messages | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `phoneNumber` | string | Yes | Recipient phone number with country code | -| `message` | string | Yes | Message content to send | -| `phoneNumberId` | string | Yes | WhatsApp Business Phone Number ID | +| `phoneNumber` | string | Yes | Recipient phone number with country code \(e.g., +14155552671\) | +| `message` | string | Yes | Message content to send \(plain text or template content\) | +| `phoneNumberId` | string | Yes | WhatsApp Business Phone Number ID \(from Meta Business Suite\) | #### Output diff --git a/apps/docs/content/docs/en/tools/wordpress.mdx b/apps/docs/content/docs/en/tools/wordpress.mdx index 92ebab38f..a6e853b53 100644 --- a/apps/docs/content/docs/en/tools/wordpress.mdx +++ b/apps/docs/content/docs/en/tools/wordpress.mdx @@ -177,13 +177,13 @@ List blog posts from WordPress.com with optional filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of posts per page \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | +| `perPage` | number | No | Number of posts per page \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `status` | string | No | Post status filter: publish, draft, pending, private | -| `author` | number | No | Filter by author ID | -| `categories` | string | No | Comma-separated category IDs to filter by | -| `tags` | string | No | Comma-separated tag IDs to filter by | -| `search` | string | No | Search term to filter posts | +| `author` | number | No | Filter by author ID \(e.g., 1, 42\) | +| `categories` | string | No | Comma-separated category IDs to filter by \(e.g., "1,2,3"\) | +| `tags` | string | No | Comma-separated tag IDs to filter by \(e.g., "5,10,15"\) | +| `search` | string | No | Search term to filter posts \(e.g., "tutorial", "announcement"\) | | `orderBy` | string | No | Order by field: date, id, title, slug, modified | | `order` | string | No | Order direction: asc or desc | @@ -359,11 +359,11 @@ List pages from WordPress.com with optional filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of pages per request \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | +| `perPage` | number | No | Number of pages per request \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `status` | string | No | Page status filter: publish, draft, pending, private | -| `parent` | number | No | Filter by parent page ID | -| `search` | string | No | Search term to filter pages | +| `parent` | number | No | Filter by parent page ID \(e.g., 123\) | +| `search` | string | No | Search term to filter pages \(e.g., "about", "contact"\) | | `orderBy` | string | No | Order by field: date, id, title, slug, modified, menu_order | | `order` | string | No | Order direction: asc or desc | @@ -461,11 +461,11 @@ List media items from the WordPress.com media library | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of media items per request \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | -| `search` | string | No | Search term to filter media | +| `perPage` | number | No | Number of media items per request \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `search` | string | No | Search term to filter media \(e.g., "logo", "banner"\) | | `mediaType` | string | No | Filter by media type: image, video, audio, application | -| `mimeType` | string | No | Filter by specific MIME type \(e.g., image/jpeg\) | +| `mimeType` | string | No | Filter by specific MIME type \(e.g., image/jpeg, image/png\) | | `orderBy` | string | No | Order by field: date, id, title, slug | | `order` | string | No | Order direction: asc or desc | @@ -562,11 +562,11 @@ List comments from WordPress.com with optional filters | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of comments per request \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | -| `postId` | number | No | Filter by post ID | +| `perPage` | number | No | Number of comments per request \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `postId` | number | No | Filter by post ID \(e.g., 123, 456\) | | `status` | string | No | Filter by comment status: approved, hold, spam, trash | -| `search` | string | No | Search term to filter comments | +| `search` | string | No | Search term to filter comments \(e.g., "question", "feedback"\) | | `orderBy` | string | No | Order by field: date, id, parent | | `order` | string | No | Order direction: asc or desc | @@ -686,9 +686,9 @@ List categories from WordPress.com | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of categories per request \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | -| `search` | string | No | Search term to filter categories | +| `perPage` | number | No | Number of categories per request \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `search` | string | No | Search term to filter categories \(e.g., "news", "technology"\) | | `order` | string | No | Order direction: asc or desc | #### Output @@ -742,9 +742,9 @@ List tags from WordPress.com | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of tags per request \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | -| `search` | string | No | Search term to filter tags | +| `perPage` | number | No | Number of tags per request \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `search` | string | No | Search term to filter tags \(e.g., "javascript", "tutorial"\) | | `order` | string | No | Order direction: asc or desc | #### Output @@ -799,10 +799,10 @@ List users from WordPress.com (requires admin privileges) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `siteId` | string | Yes | WordPress.com site ID or domain \(e.g., 12345678 or mysite.wordpress.com\) | -| `perPage` | number | No | Number of users per request \(default: 10, max: 100\) | -| `page` | number | No | Page number for pagination | -| `search` | string | No | Search term to filter users | -| `roles` | string | No | Comma-separated role names to filter by | +| `perPage` | number | No | Number of users per request \(e.g., 10, 25, 50\). Default: 10, max: 100 | +| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | +| `search` | string | No | Search term to filter users \(e.g., "john", "admin"\) | +| `roles` | string | No | Comma-separated role names to filter by \(e.g., "administrator,editor"\) | | `order` | string | No | Order direction: asc or desc | #### Output diff --git a/apps/docs/content/docs/en/tools/x.mdx b/apps/docs/content/docs/en/tools/x.mdx index 0255c5755..234dc3649 100644 --- a/apps/docs/content/docs/en/tools/x.mdx +++ b/apps/docs/content/docs/en/tools/x.mdx @@ -43,8 +43,8 @@ Post new tweets, reply to tweets, or create polls on X (Twitter) | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `text` | string | Yes | The text content of your tweet | -| `replyTo` | string | No | ID of the tweet to reply to | +| `text` | string | Yes | The text content of your tweet \(max 280 characters\) | +| `replyTo` | string | No | ID of the tweet to reply to \(e.g., 1234567890123456789\) | | `mediaIds` | array | No | Array of media IDs to attach to the tweet | | `poll` | object | No | Poll configuration for the tweet | @@ -70,7 +70,7 @@ Read tweet details, including replies and conversation context | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `tweetId` | string | Yes | ID of the tweet to read | +| `tweetId` | string | Yes | ID of the tweet to read \(e.g., 1234567890123456789\) | | `includeReplies` | boolean | No | Whether to include replies to the tweet | #### Output @@ -92,8 +92,8 @@ Search for tweets using keywords, hashtags, or advanced queries | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `query` | string | Yes | Search query \(supports X search operators\) | -| `maxResults` | number | No | Maximum number of results to return \(default: 10, max: 100\) | +| `query` | string | Yes | Search query \(e.g., "AI news", "#technology", "from:username"\). Supports X search operators | +| `maxResults` | number | No | Maximum number of results to return \(e.g., 10, 25, 50\). Default: 10, max: 100 | | `startTime` | string | No | Start time for search \(ISO 8601 format\) | | `endTime` | string | No | End time for search \(ISO 8601 format\) | | `sortOrder` | string | No | Sort order for results \(recency or relevancy\) | @@ -121,7 +121,7 @@ Get user profile information | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `username` | string | Yes | Username to look up \(without @ symbol\) | +| `username` | string | Yes | Username to look up without @ symbol \(e.g., elonmusk, openai\) | #### Output diff --git a/apps/docs/content/docs/en/tools/youtube.mdx b/apps/docs/content/docs/en/tools/youtube.mdx index f79057034..dd89c95bb 100644 --- a/apps/docs/content/docs/en/tools/youtube.mdx +++ b/apps/docs/content/docs/en/tools/youtube.mdx @@ -40,7 +40,7 @@ Get detailed information about a YouTube channel including statistics, branding, | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `channelId` | string | No | YouTube channel ID \(use either channelId or username\) | +| `channelId` | string | No | YouTube channel ID starting with "UC" \(24-character string, use either channelId or username\) | | `username` | string | No | YouTube channel username \(use either channelId or username\) | | `apiKey` | string | Yes | YouTube API Key | @@ -70,9 +70,9 @@ Get all public playlists from a specific YouTube channel. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `channelId` | string | Yes | YouTube channel ID to get playlists from | +| `channelId` | string | Yes | YouTube channel ID starting with "UC" \(24-character string\) to get playlists from | | `maxResults` | number | No | Maximum number of playlists to return \(1-50\) | -| `pageToken` | string | No | Page token for pagination | +| `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -98,10 +98,10 @@ Search for videos from a specific YouTube channel with sorting options. For comp | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `channelId` | string | Yes | YouTube channel ID to get videos from | +| `channelId` | string | Yes | YouTube channel ID starting with "UC" \(24-character string\) to get videos from | | `maxResults` | number | No | Maximum number of videos to return \(1-50\) | | `order` | string | No | Sort order: "date" \(newest first, default\), "rating", "relevance", "title", "viewCount" | -| `pageToken` | string | No | Page token for pagination | +| `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -126,10 +126,10 @@ Get top-level comments from a YouTube video with author details and engagement. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `videoId` | string | Yes | YouTube video ID | +| `videoId` | string | Yes | YouTube video ID \(11-character string, e.g., "dQw4w9WgXcQ"\) | | `maxResults` | number | No | Maximum number of comments to return \(1-100\) | | `order` | string | No | Order of comments: "time" \(newest first\) or "relevance" \(most relevant first\) | -| `pageToken` | string | No | Page token for pagination | +| `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -158,9 +158,9 @@ Get videos from a YouTube playlist. Can be used with a channel uploads playlist | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `playlistId` | string | Yes | YouTube playlist ID. Use uploadsPlaylistId from channel_info to get all channel videos. | +| `playlistId` | string | Yes | YouTube playlist ID starting with "PL" or "UU" \(34-character string\). Use uploadsPlaylistId from channel_info to get all channel videos. | | `maxResults` | number | No | Maximum number of videos to return \(1-50\) | -| `pageToken` | string | No | Page token for pagination | +| `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -190,9 +190,9 @@ Search for videos on YouTube using the YouTube Data API. Supports advanced filte | --------- | ---- | -------- | ----------- | | `query` | string | Yes | Search query for YouTube videos | | `maxResults` | number | No | Maximum number of videos to return \(1-50\) | -| `pageToken` | string | No | Page token for pagination \(use nextPageToken from previous response\) | +| `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | | `apiKey` | string | Yes | YouTube API Key | -| `channelId` | string | No | Filter results to a specific YouTube channel ID | +| `channelId` | string | No | Filter results to a specific YouTube channel ID starting with "UC" \(24-character string\) | | `publishedAfter` | string | No | Only return videos published after this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) | | `publishedBefore` | string | No | Only return videos published before this date \(RFC 3339 format: "2024-01-01T00:00:00Z"\) | | `videoDuration` | string | No | Filter by video length: "short" \(<4 min\), "medium" \(4-20 min\), "long" \(>20 min\), "any" | @@ -217,7 +217,7 @@ Search for videos on YouTube using the YouTube Data API. Supports advanced filte | ↳ `channelId` | string | Channel ID that uploaded the video | | ↳ `channelTitle` | string | Channel name | | ↳ `publishedAt` | string | Video publish date | -| ↳ `liveBroadcastContent` | string | Live broadcast status: | +| ↳ `liveBroadcastContent` | string | Live broadcast status: "none", "live", or "upcoming" | | `totalResults` | number | Total number of search results available | | `nextPageToken` | string | Token for accessing the next page of results | @@ -232,7 +232,7 @@ Get the most popular/trending videos on YouTube. Can filter by region and video | `regionCode` | string | No | ISO 3166-1 alpha-2 country code to get trending videos for \(e.g., "US", "GB", "JP"\). Defaults to US. | | `videoCategoryId` | string | No | Filter by video category ID \(e.g., "10" for Music, "20" for Gaming, "17" for Sports\) | | `maxResults` | number | No | Maximum number of trending videos to return \(1-50\) | -| `pageToken` | string | No | Page token for pagination | +| `pageToken` | string | No | Page token for pagination \(from previous response nextPageToken\) | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -263,7 +263,7 @@ Get a list of video categories available on YouTube. Use this to discover valid | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `regionCode` | string | No | ISO 3166-1 alpha-2 country code to get categories for \(e.g., "US", "GB", "JP"\). Defaults to US. | -| `hl` | string | No | Language for category titles \(e.g., "en", "es", "fr"\). Defaults to English. | +| `hl` | string | No | Language for category titles \(ISO 639-1 code, e.g., "en", "es", "fr"\). Defaults to English. | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -271,7 +271,7 @@ Get a list of video categories available on YouTube. Use this to discover valid | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of video categories available in the specified region | -| ↳ `categoryId` | string | Category ID to use in search/trending filters \(e.g., | +| ↳ `categoryId` | string | Category ID to use in search/trending filters \(e.g., "10" for Music\) | | ↳ `title` | string | Human-readable category name | | ↳ `assignable` | boolean | Whether videos can be tagged with this category | | `totalResults` | number | Total number of categories available | @@ -284,7 +284,7 @@ Get detailed information about a specific YouTube video including statistics, co | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `videoId` | string | Yes | YouTube video ID | +| `videoId` | string | Yes | YouTube video ID \(11-character string, e.g., "dQw4w9WgXcQ"\) | | `apiKey` | string | Yes | YouTube API Key | #### Output @@ -297,7 +297,7 @@ Get detailed information about a specific YouTube video including statistics, co | `channelId` | string | Channel ID | | `channelTitle` | string | Channel name | | `publishedAt` | string | Published date and time | -| `duration` | string | Video duration in ISO 8601 format \(e.g., | +| `duration` | string | Video duration in ISO 8601 format \(e.g., "PT4M13S" for 4 min 13 sec\) | | `viewCount` | number | Number of views | | `likeCount` | number | Number of likes | | `commentCount` | number | Number of comments | @@ -305,11 +305,11 @@ Get detailed information about a specific YouTube video including statistics, co | `thumbnail` | string | Video thumbnail URL | | `tags` | array | Video tags | | `categoryId` | string | YouTube video category ID | -| `definition` | string | Video definition: | -| `caption` | string | Whether captions are available: | +| `definition` | string | Video definition: "hd" or "sd" | +| `caption` | string | Whether captions are available: "true" or "false" | | `licensedContent` | boolean | Whether the video is licensed content | -| `privacyStatus` | string | Video privacy status: | -| `liveBroadcastContent` | string | Live broadcast status: | +| `privacyStatus` | string | Video privacy status: "public", "private", or "unlisted" | +| `liveBroadcastContent` | string | Live broadcast status: "live", "upcoming", or "none" | | `defaultLanguage` | string | Default language of the video metadata | | `defaultAudioLanguage` | string | Default audio language of the video | | `isLiveContent` | boolean | Whether this video is or was a live stream | diff --git a/apps/docs/content/docs/en/tools/zendesk.mdx b/apps/docs/content/docs/en/tools/zendesk.mdx index c7eeb65d3..d01a0660a 100644 --- a/apps/docs/content/docs/en/tools/zendesk.mdx +++ b/apps/docs/content/docs/en/tools/zendesk.mdx @@ -62,15 +62,15 @@ Retrieve a list of tickets from Zendesk with optional filtering | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain \(e.g., "mycompany" for mycompany.zendesk.com\) | -| `status` | string | No | Filter by status \(new, open, pending, hold, solved, closed\) | -| `priority` | string | No | Filter by priority \(low, normal, high, urgent\) | -| `type` | string | No | Filter by type \(problem, incident, question, task\) | -| `assigneeId` | string | No | Filter by assignee user ID | -| `organizationId` | string | No | Filter by organization ID | -| `sortBy` | string | No | Sort field \(created_at, updated_at, priority, status\) | -| `sortOrder` | string | No | Sort order \(asc or desc\) | -| `perPage` | string | No | Results per page \(default: 100, max: 100\) | -| `page` | string | No | Page number | +| `status` | string | No | Filter by status: "new", "open", "pending", "hold", "solved", or "closed" | +| `priority` | string | No | Filter by priority: "low", "normal", "high", or "urgent" | +| `type` | string | No | Filter by type: "problem", "incident", "question", or "task" | +| `assigneeId` | string | No | Filter by assignee user ID as a numeric string \(e.g., "12345"\) | +| `organizationId` | string | No | Filter by organization ID as a numeric string \(e.g., "67890"\) | +| `sortBy` | string | No | Sort field: "created_at", "updated_at", "priority", or "status" | +| `sortOrder` | string | No | Sort order: "asc" or "desc" | +| `perPage` | string | No | Results per page as a number string \(default: "100", max: "100"\) | +| `page` | string | No | Page number as a string \(e.g., "1", "2"\) | #### Output @@ -148,7 +148,7 @@ Get a single ticket by ID from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `ticketId` | string | Yes | Ticket ID to retrieve | +| `ticketId` | string | Yes | Ticket ID to retrieve as a numeric string \(e.g., "12345"\) | #### Output @@ -221,14 +221,14 @@ Create a new ticket in Zendesk with support for custom fields | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | | `subject` | string | No | Ticket subject \(optional - will be auto-generated if not provided\) | -| `description` | string | Yes | Ticket description \(first comment\) | -| `priority` | string | No | Priority \(low, normal, high, urgent\) | -| `status` | string | No | Status \(new, open, pending, hold, solved, closed\) | -| `type` | string | No | Type \(problem, incident, question, task\) | -| `tags` | string | No | Comma-separated tags | -| `assigneeId` | string | No | Assignee user ID | -| `groupId` | string | No | Group ID | -| `requesterId` | string | No | Requester user ID | +| `description` | string | Yes | Ticket description text \(first comment\) | +| `priority` | string | No | Priority: "low", "normal", "high", or "urgent" | +| `status` | string | No | Status: "new", "open", "pending", "hold", "solved", or "closed" | +| `type` | string | No | Type: "problem", "incident", "question", or "task" | +| `tags` | string | No | Comma-separated tags \(e.g., "billing, urgent"\) | +| `assigneeId` | string | No | Assignee user ID as a numeric string \(e.g., "12345"\) | +| `groupId` | string | No | Group ID as a numeric string \(e.g., "67890"\) | +| `requesterId` | string | No | Requester user ID as a numeric string \(e.g., "11111"\) | | `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) | #### Output @@ -301,7 +301,7 @@ Create multiple tickets in Zendesk at once (max 100) | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `tickets` | string | Yes | JSON array of ticket objects to create \(max 100\). Each ticket should have subject and comment properties. | +| `tickets` | string | Yes | JSON array of ticket objects to create \(max 100\). Each ticket should have subject and comment properties \(e.g., \[\{"subject": "Issue 1", "comment": \{"body": "Description"\}\}\]\) | #### Output @@ -335,16 +335,16 @@ Update an existing ticket in Zendesk with support for custom fields | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `ticketId` | string | Yes | Ticket ID to update | -| `subject` | string | No | New ticket subject | -| `comment` | string | No | Add a comment to the ticket | -| `priority` | string | No | Priority \(low, normal, high, urgent\) | -| `status` | string | No | Status \(new, open, pending, hold, solved, closed\) | -| `type` | string | No | Type \(problem, incident, question, task\) | -| `tags` | string | No | Comma-separated tags | -| `assigneeId` | string | No | Assignee user ID | -| `groupId` | string | No | Group ID | -| `customFields` | string | No | Custom fields as JSON object | +| `ticketId` | string | Yes | Ticket ID to update as a numeric string \(e.g., "12345"\) | +| `subject` | string | No | New ticket subject text | +| `comment` | string | No | Comment text to add to the ticket | +| `priority` | string | No | Priority: "low", "normal", "high", or "urgent" | +| `status` | string | No | Status: "new", "open", "pending", "hold", "solved", or "closed" | +| `type` | string | No | Type: "problem", "incident", "question", or "task" | +| `tags` | string | No | Comma-separated tags \(e.g., "billing, urgent"\) | +| `assigneeId` | string | No | Assignee user ID as a numeric string \(e.g., "12345"\) | +| `groupId` | string | No | Group ID as a numeric string \(e.g., "67890"\) | +| `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) | #### Output @@ -416,12 +416,12 @@ Update multiple tickets in Zendesk at once (max 100) | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `ticketIds` | string | Yes | Comma-separated ticket IDs to update \(max 100\) | -| `status` | string | No | New status for all tickets | -| `priority` | string | No | New priority for all tickets | -| `assigneeId` | string | No | New assignee ID for all tickets | -| `groupId` | string | No | New group ID for all tickets | -| `tags` | string | No | Comma-separated tags to add to all tickets | +| `ticketIds` | string | Yes | Comma-separated ticket IDs to update \(max 100, e.g., "111, 222, 333"\) | +| `status` | string | No | New status for all tickets: "new", "open", "pending", "hold", "solved", or "closed" | +| `priority` | string | No | New priority for all tickets: "low", "normal", "high", or "urgent" | +| `assigneeId` | string | No | New assignee ID for all tickets as a numeric string \(e.g., "12345"\) | +| `groupId` | string | No | New group ID for all tickets as a numeric string \(e.g., "67890"\) | +| `tags` | string | No | Comma-separated tags to add to all tickets \(e.g., "bulk-update, processed"\) | #### Output @@ -455,7 +455,7 @@ Delete a ticket from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `ticketId` | string | Yes | Ticket ID to delete | +| `ticketId` | string | Yes | Ticket ID to delete as a numeric string \(e.g., "12345"\) | #### Output @@ -475,9 +475,9 @@ Merge multiple tickets into a target ticket | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `targetTicketId` | string | Yes | Target ticket ID \(tickets will be merged into this one\) | -| `sourceTicketIds` | string | Yes | Comma-separated source ticket IDs to merge | -| `targetComment` | string | No | Comment to add to target ticket after merge | +| `targetTicketId` | string | Yes | Target ticket ID as a numeric string \(tickets will be merged into this one, e.g., "12345"\) | +| `sourceTicketIds` | string | Yes | Comma-separated source ticket IDs to merge \(e.g., "111, 222, 333"\) | +| `targetComment` | string | No | Comment text to add to target ticket after merge | #### Output @@ -512,10 +512,10 @@ Retrieve a list of users from Zendesk with optional filtering | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain \(e.g., "mycompany" for mycompany.zendesk.com\) | -| `role` | string | No | Filter by role \(end-user, agent, admin\) | -| `permissionSet` | string | No | Filter by permission set ID | -| `perPage` | string | No | Results per page \(default: 100, max: 100\) | -| `page` | string | No | Page number | +| `role` | string | No | Filter by role: "end-user", "agent", or "admin" | +| `permissionSet` | string | No | Filter by permission set ID as a numeric string \(e.g., "12345"\) | +| `perPage` | string | No | Results per page as a number string \(default: "100", max: "100"\) | +| `page` | string | No | Page number as a string \(e.g., "1", "2"\) | #### Output @@ -582,7 +582,7 @@ Get a single user by ID from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `userId` | string | Yes | User ID to retrieve | +| `userId` | string | Yes | User ID to retrieve as a numeric string \(e.g., "12345"\) | #### Output @@ -703,10 +703,10 @@ Search for users in Zendesk using a query string | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `query` | string | No | Search query string | -| `externalId` | string | No | External ID to search by | -| `perPage` | string | No | Results per page \(default: 100, max: 100\) | -| `page` | string | No | Page number | +| `query` | string | No | Search query string \(e.g., user name or email\) | +| `externalId` | string | No | External ID to search by \(your system identifier\) | +| `perPage` | string | No | Results per page as a number string \(default: "100", max: "100"\) | +| `page` | string | No | Page number as a string \(e.g., "1", "2"\) | #### Output @@ -773,13 +773,13 @@ Create a new user in Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `name` | string | Yes | User name | -| `userEmail` | string | No | User email | -| `role` | string | No | User role \(end-user, agent, admin\) | -| `phone` | string | No | User phone number | -| `organizationId` | string | No | Organization ID | -| `verified` | string | No | Set to "true" to skip email verification | -| `tags` | string | No | Comma-separated tags | +| `name` | string | Yes | User full name \(e.g., "John Smith"\) | +| `userEmail` | string | No | User email address \(e.g., "john@example.com"\) | +| `role` | string | No | User role: "end-user", "agent", or "admin" | +| `phone` | string | No | User phone number \(e.g., "+1-555-123-4567"\) | +| `organizationId` | string | No | Organization ID as a numeric string \(e.g., "12345"\) | +| `verified` | string | No | Set to "true" to skip email verification, or "false" otherwise | +| `tags` | string | No | Comma-separated tags \(e.g., "vip, enterprise"\) | | `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) | #### Output @@ -841,7 +841,7 @@ Create multiple users in Zendesk using bulk import | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `users` | string | Yes | JSON array of user objects to create | +| `users` | string | Yes | JSON array of user objects to create \(e.g., \[\{"name": "User1", "email": "user1@example.com"\}\]\) | #### Output @@ -875,15 +875,15 @@ Update an existing user in Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `userId` | string | Yes | User ID to update | -| `name` | string | No | New user name | -| `userEmail` | string | No | New user email | -| `role` | string | No | User role \(end-user, agent, admin\) | -| `phone` | string | No | User phone number | -| `organizationId` | string | No | Organization ID | -| `verified` | string | No | Set to "true" to mark user as verified | -| `tags` | string | No | Comma-separated tags | -| `customFields` | string | No | Custom fields as JSON object | +| `userId` | string | Yes | User ID to update as a numeric string \(e.g., "12345"\) | +| `name` | string | No | New user full name \(e.g., "John Smith"\) | +| `userEmail` | string | No | New user email address \(e.g., "john@example.com"\) | +| `role` | string | No | User role: "end-user", "agent", or "admin" | +| `phone` | string | No | User phone number \(e.g., "+1-555-123-4567"\) | +| `organizationId` | string | No | Organization ID as a numeric string \(e.g., "67890"\) | +| `verified` | string | No | Set to "true" to mark user as verified, or "false" otherwise | +| `tags` | string | No | Comma-separated tags \(e.g., "vip, enterprise"\) | +| `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) | #### Output @@ -944,7 +944,7 @@ Update multiple users in Zendesk using bulk update | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `users` | string | Yes | JSON array of user objects to update \(must include id field\) | +| `users` | string | Yes | JSON array of user objects to update, each must include id field \(e.g., \[\{"id": "123", "name": "New Name"\}\]\) | #### Output @@ -978,7 +978,7 @@ Delete a user from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `userId` | string | Yes | User ID to delete | +| `userId` | string | Yes | User ID to delete as a numeric string \(e.g., "12345"\) | #### Output @@ -998,8 +998,8 @@ Retrieve a list of organizations from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain \(e.g., "mycompany" for mycompany.zendesk.com\) | -| `perPage` | string | No | Results per page \(default: 100, max: 100\) | -| `page` | string | No | Page number | +| `perPage` | string | No | Results per page as a number string \(default: "100", max: "100"\) | +| `page` | string | No | Page number as a string \(e.g., "1", "2"\) | #### Output @@ -1039,7 +1039,7 @@ Get a single organization by ID from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `organizationId` | string | Yes | Organization ID to retrieve | +| `organizationId` | string | Yes | Organization ID to retrieve as a numeric string \(e.g., "12345"\) | #### Output @@ -1073,9 +1073,9 @@ Autocomplete organizations in Zendesk by name prefix (for name matching/autocomp | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `name` | string | Yes | Organization name to search for | -| `perPage` | string | No | Results per page \(default: 100, max: 100\) | -| `page` | string | No | Page number | +| `name` | string | Yes | Organization name prefix to search for \(e.g., "Acme"\) | +| `perPage` | string | No | Results per page as a number string \(default: "100", max: "100"\) | +| `page` | string | No | Page number as a string \(e.g., "1", "2"\) | #### Output @@ -1115,11 +1115,11 @@ Create a new organization in Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `name` | string | Yes | Organization name | -| `domainNames` | string | No | Comma-separated domain names | -| `details` | string | No | Organization details | -| `notes` | string | No | Organization notes | -| `tags` | string | No | Comma-separated tags | +| `name` | string | Yes | Organization name \(e.g., "Acme Corporation"\) | +| `domainNames` | string | No | Comma-separated domain names \(e.g., "acme.com, acme.org"\) | +| `details` | string | No | Organization details text | +| `notes` | string | No | Organization notes text | +| `tags` | string | No | Comma-separated tags \(e.g., "enterprise, priority"\) | | `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) | #### Output @@ -1154,7 +1154,7 @@ Create multiple organizations in Zendesk using bulk import | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `organizations` | string | Yes | JSON array of organization objects to create | +| `organizations` | string | Yes | JSON array of organization objects to create \(e.g., \[\{"name": "Org1"\}, \{"name": "Org2"\}\]\) | #### Output @@ -1188,13 +1188,13 @@ Update an existing organization in Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `organizationId` | string | Yes | Organization ID to update | -| `name` | string | No | New organization name | -| `domainNames` | string | No | Comma-separated domain names | -| `details` | string | No | Organization details | -| `notes` | string | No | Organization notes | -| `tags` | string | No | Comma-separated tags | -| `customFields` | string | No | Custom fields as JSON object | +| `organizationId` | string | Yes | Organization ID to update as a numeric string \(e.g., "12345"\) | +| `name` | string | No | New organization name \(e.g., "Acme Corporation"\) | +| `domainNames` | string | No | Comma-separated domain names \(e.g., "acme.com, acme.org"\) | +| `details` | string | No | Organization details text | +| `notes` | string | No | Organization notes text | +| `tags` | string | No | Comma-separated tags \(e.g., "enterprise, priority"\) | +| `customFields` | string | No | Custom fields as JSON object \(e.g., \{"field_id": "value"\}\) | #### Output @@ -1228,7 +1228,7 @@ Delete an organization from Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `organizationId` | string | Yes | Organization ID to delete | +| `organizationId` | string | Yes | Organization ID to delete as a numeric string \(e.g., "12345"\) | #### Output @@ -1248,11 +1248,11 @@ Unified search across tickets, users, and organizations in Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `query` | string | Yes | Search query string | -| `sortBy` | string | No | Sort field \(relevance, created_at, updated_at, priority, status, ticket_type\) | -| `sortOrder` | string | No | Sort order \(asc or desc\) | -| `perPage` | string | No | Results per page \(default: 100, max: 100\) | -| `page` | string | No | Page number | +| `query` | string | Yes | Search query string using Zendesk search syntax \(e.g., "type:ticket status:open"\) | +| `sortBy` | string | No | Sort field: "relevance", "created_at", "updated_at", "priority", "status", or "ticket_type" | +| `sortOrder` | string | No | Sort order: "asc" or "desc" | +| `perPage` | string | No | Results per page as a number string \(default: "100", max: "100"\) | +| `page` | string | No | Page number as a string \(e.g., "1", "2"\) | #### Output @@ -1278,7 +1278,7 @@ Count the number of search results matching a query in Zendesk | `email` | string | Yes | Your Zendesk email address | | `apiToken` | string | Yes | Zendesk API token | | `subdomain` | string | Yes | Your Zendesk subdomain | -| `query` | string | Yes | Search query string | +| `query` | string | Yes | Search query string using Zendesk search syntax \(e.g., "type:ticket status:open"\) | #### Output diff --git a/apps/docs/content/docs/en/tools/zep.mdx b/apps/docs/content/docs/en/tools/zep.mdx index 88226cf45..27c29b886 100644 --- a/apps/docs/content/docs/en/tools/zep.mdx +++ b/apps/docs/content/docs/en/tools/zep.mdx @@ -44,8 +44,8 @@ Start a new conversation thread in Zep | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `threadId` | string | Yes | Unique identifier for the thread | -| `userId` | string | Yes | User ID associated with the thread | +| `threadId` | string | Yes | Unique identifier for the thread \(e.g., "thread_abc123"\) | +| `userId` | string | Yes | User ID associated with the thread \(e.g., "user_123"\) | | `apiKey` | string | Yes | Your Zep API key | #### Output @@ -66,8 +66,8 @@ List all conversation threads | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `pageSize` | number | No | Number of threads to retrieve per page | -| `pageNumber` | number | No | Page number for pagination | +| `pageSize` | number | No | Number of threads to retrieve per page \(e.g., 10, 25, 50\) | +| `pageNumber` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `orderBy` | string | No | Field to order results by \(created_at, updated_at, user_id, thread_id\) | | `asc` | boolean | No | Order direction: true for ascending, false for descending | | `apiKey` | string | Yes | Your Zep API key | @@ -95,7 +95,7 @@ Delete a conversation thread from Zep | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `threadId` | string | Yes | Thread ID to delete | +| `threadId` | string | Yes | Thread ID to delete \(e.g., "thread_abc123"\) | | `apiKey` | string | Yes | Your Zep API key | #### Output @@ -112,7 +112,7 @@ Retrieve user context from a thread with summary or basic mode | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `threadId` | string | Yes | Thread ID to get context from | +| `threadId` | string | Yes | Thread ID to get context from \(e.g., "thread_abc123"\) | | `mode` | string | No | Context mode: "summary" \(natural language\) or "basic" \(raw facts\) | | `minRating` | number | No | Minimum rating by which to filter relevant facts | | `apiKey` | string | Yes | Your Zep API key | @@ -131,8 +131,8 @@ Retrieve messages from a thread | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `threadId` | string | Yes | Thread ID to get messages from | -| `limit` | number | No | Maximum number of messages to return | +| `threadId` | string | Yes | Thread ID to get messages from \(e.g., "thread_abc123"\) | +| `limit` | number | No | Maximum number of messages to return \(e.g., 10, 50, 100\) | | `cursor` | string | No | Cursor for pagination | | `lastn` | number | No | Number of most recent messages to return \(overrides limit and cursor\) | | `apiKey` | string | Yes | Your Zep API key | @@ -161,8 +161,8 @@ Add messages to an existing thread | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `threadId` | string | Yes | Thread ID to add messages to | -| `messages` | json | Yes | Array of message objects with role and content | +| `threadId` | string | Yes | Thread ID to add messages to \(e.g., "thread_abc123"\) | +| `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) | | `apiKey` | string | Yes | Your Zep API key | #### Output @@ -181,11 +181,11 @@ Create a new user in Zep | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | Unique identifier for the user | +| `userId` | string | Yes | Unique identifier for the user \(e.g., "user_123"\) | | `email` | string | No | User email address | | `firstName` | string | No | User first name | | `lastName` | string | No | User last name | -| `metadata` | json | No | Additional metadata as JSON object | +| `metadata` | json | No | Additional metadata as JSON object \(e.g., \{"key": "value"\}\) | | `apiKey` | string | Yes | Your Zep API key | #### Output @@ -208,7 +208,7 @@ Retrieve user information from Zep | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | User ID to retrieve | +| `userId` | string | Yes | User ID to retrieve \(e.g., "user_123"\) | | `apiKey` | string | Yes | Your Zep API key | #### Output @@ -232,8 +232,8 @@ List all conversation threads for a specific user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | User ID to get threads for | -| `limit` | number | No | Maximum number of threads to return | +| `userId` | string | Yes | User ID to get threads for \(e.g., "user_123"\) | +| `limit` | number | No | Maximum number of threads to return \(e.g., 10, 25, 50\) | | `apiKey` | string | Yes | Your Zep API key | #### Output diff --git a/apps/docs/content/docs/en/tools/zoom.mdx b/apps/docs/content/docs/en/tools/zoom.mdx index c019a30e4..8e5a4c238 100644 --- a/apps/docs/content/docs/en/tools/zoom.mdx +++ b/apps/docs/content/docs/en/tools/zoom.mdx @@ -49,14 +49,14 @@ Create a new Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | The user ID or email address. Use "me" for the authenticated user. | -| `topic` | string | Yes | Meeting topic | +| `userId` | string | Yes | The user ID or email address \(e.g., "me", "user@example.com", or "AbcDefGHi"\). Use "me" for the authenticated user. | +| `topic` | string | Yes | Meeting topic \(e.g., "Weekly Team Standup" or "Project Review"\) | | `type` | number | No | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time | | `startTime` | string | No | Meeting start time in ISO 8601 format \(e.g., 2025-06-03T10:00:00Z\) | -| `duration` | number | No | Meeting duration in minutes | +| `duration` | number | No | Meeting duration in minutes \(e.g., 30, 60, 90\) | | `timezone` | string | No | Timezone for the meeting \(e.g., America/Los_Angeles\) | | `password` | string | No | Meeting password | -| `agenda` | string | No | Meeting agenda | +| `agenda` | string | No | Meeting agenda or description text | | `hostVideo` | boolean | No | Start with host video on | | `participantVideo` | boolean | No | Start with participant video on | | `joinBeforeHost` | boolean | No | Allow participants to join before host | @@ -121,9 +121,9 @@ List all meetings for a Zoom user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | The user ID or email address. Use "me" for the authenticated user. | +| `userId` | string | Yes | The user ID or email address \(e.g., "me", "user@example.com", or "AbcDefGHi"\). Use "me" for the authenticated user. | | `type` | string | No | Meeting type filter: scheduled, live, upcoming, upcoming_meetings, or previous_meetings | -| `pageSize` | number | No | Number of records per page \(max 300\) | +| `pageSize` | number | No | Number of records per page, 1-300 \(e.g., 30, 50, 100\) | | `nextPageToken` | string | No | Token for pagination to get next page of results | #### Output @@ -157,7 +157,7 @@ Get details of a specific Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The meeting ID | +| `meetingId` | string | Yes | The meeting ID \(e.g., "1234567890" or "85746065432"\) | | `occurrenceId` | string | No | Occurrence ID for recurring meetings | | `showPreviousOccurrences` | boolean | No | Show previous occurrences for recurring meetings | @@ -218,14 +218,14 @@ Update an existing Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The meeting ID to update | -| `topic` | string | No | Meeting topic | +| `meetingId` | string | Yes | The meeting ID to update \(e.g., "1234567890" or "85746065432"\) | +| `topic` | string | No | Meeting topic \(e.g., "Weekly Team Standup" or "Project Review"\) | | `type` | number | No | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time | | `startTime` | string | No | Meeting start time in ISO 8601 format \(e.g., 2025-06-03T10:00:00Z\) | -| `duration` | number | No | Meeting duration in minutes | +| `duration` | number | No | Meeting duration in minutes \(e.g., 30, 60, 90\) | | `timezone` | string | No | Timezone for the meeting \(e.g., America/Los_Angeles\) | | `password` | string | No | Meeting password | -| `agenda` | string | No | Meeting agenda | +| `agenda` | string | No | Meeting agenda or description text | | `hostVideo` | boolean | No | Start with host video on | | `participantVideo` | boolean | No | Start with participant video on | | `joinBeforeHost` | boolean | No | Allow participants to join before host | @@ -247,7 +247,7 @@ Delete or cancel a Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The meeting ID to delete | +| `meetingId` | string | Yes | The meeting ID to delete \(e.g., "1234567890" or "85746065432"\) | | `occurrenceId` | string | No | Occurrence ID for deleting a specific occurrence of a recurring meeting | | `scheduleForReminder` | boolean | No | Send cancellation reminder email to registrants | | `cancelMeetingReminder` | boolean | No | Send cancellation email to registrants and alternative hosts | @@ -266,7 +266,7 @@ Get the meeting invitation text for a Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The meeting ID | +| `meetingId` | string | Yes | The meeting ID \(e.g., "1234567890" or "85746065432"\) | #### Output @@ -282,10 +282,10 @@ List all cloud recordings for a Zoom user | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `userId` | string | Yes | The user ID or email address. Use "me" for the authenticated user. | +| `userId` | string | Yes | The user ID or email address \(e.g., "me", "user@example.com", or "AbcDefGHi"\). Use "me" for the authenticated user. | | `from` | string | No | Start date in yyyy-mm-dd format \(within last 6 months\) | | `to` | string | No | End date in yyyy-mm-dd format | -| `pageSize` | number | No | Number of records per page \(max 300\) | +| `pageSize` | number | No | Number of records per page, 1-300 \(e.g., 30, 50, 100\) | | `nextPageToken` | string | No | Token for pagination to get next page of results | | `trash` | boolean | No | Set to true to list recordings from trash | @@ -332,7 +332,7 @@ Get all recordings for a specific Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The meeting ID or meeting UUID | +| `meetingId` | string | Yes | The meeting ID or meeting UUID \(e.g., "1234567890" or "4444AAABBBccccc12345=="\) | | `includeFolderItems` | boolean | No | Include items within a folder | | `ttl` | number | No | Time to live for download URLs in seconds \(max 604800\) | @@ -373,7 +373,7 @@ Delete cloud recordings for a Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The meeting ID or meeting UUID | +| `meetingId` | string | Yes | The meeting ID or meeting UUID \(e.g., "1234567890" or "4444AAABBBccccc12345=="\) | | `recordingId` | string | No | Specific recording file ID to delete. If not provided, deletes all recordings. | | `action` | string | No | Delete action: "trash" \(move to trash\) or "delete" \(permanently delete\) | @@ -391,8 +391,8 @@ List participants from a past Zoom meeting | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `meetingId` | string | Yes | The past meeting ID or UUID | -| `pageSize` | number | No | Number of records per page \(max 300\) | +| `meetingId` | string | Yes | The past meeting ID or UUID \(e.g., "1234567890" or "4444AAABBBccccc12345=="\) | +| `pageSize` | number | No | Number of records per page, 1-300 \(e.g., 30, 50, 100\) | | `nextPageToken` | string | No | Token for pagination to get next page of results | #### Output