Compare commits

..

6 Commits

Author SHA1 Message Date
waleed
276ce665e4 ack comments 2026-01-27 14:50:57 -08:00
waleed
08bad4da9f ack comments 2026-01-27 14:38:38 -08:00
waleed
37dbfe393a fix(workflow): preserve parent and position when duplicating/pasting nested blocks
Three related fixes for blocks inside containers (loop/parallel):

1. regenerateBlockIds now preserves parentId when the parent exists in
   the current workflow, not just when it's in the copy set. This keeps
   duplicated blocks inside their container.

2. calculatePasteOffset now uses simple offset for nested blocks instead
   of viewport-center calculation. Since nested blocks use relative
   positioning, the viewport-center offset would place them incorrectly.

3. Use CONTAINER_DIMENSIONS constants instead of hardcoded magic numbers
   in orphan cleanup position calculation.
2026-01-27 14:17:16 -08:00
waleed
503f676910 fix(store): clear extent property when orphaning blocks
When a block's parent is removed, properly clear both parentId and extent
properties from block.data, matching the pattern used in batchUpdateBlocksWithParent.
2026-01-27 14:10:55 -08:00
waleed
f2ca90ae6f refactor(store): remove unused workflow store functions
Remove redundant functions superseded by collaborative workflow patterns:
- duplicateBlock (superseded by collaborative paste flow)
- toggleBlockAdvancedMode (superseded by setBlockAdvancedMode)
- updateLoopCollection (redundant wrapper)
- setBlockTriggerMode (unused)
- generateLoopBlocks/generateParallelBlocks methods (called directly as utils)

Also removes ~160 lines of related tests and cleans up unused imports.
2026-01-27 14:10:55 -08:00
waleed
fe4fd47b9d improvement(workflow): remove useEffect anti-patterns 2026-01-27 14:10:55 -08:00
1495 changed files with 20421 additions and 79528 deletions

View File

@@ -55,21 +55,21 @@ export const {serviceName}{Action}Tool: ToolConfig<
}, },
params: { params: {
// Hidden params (system-injected, only use hidden for oauth accessToken) // Hidden params (system-injected)
accessToken: { accessToken: {
type: 'string', type: 'string',
required: true, required: true,
visibility: 'hidden', visibility: 'hidden',
description: 'OAuth access token', description: 'OAuth access token',
}, },
// User-only params (credentials, api key, IDs user must provide) // User-only params (credentials, IDs user must provide)
someId: { someId: {
type: 'string', type: 'string',
required: true, required: true,
visibility: 'user-only', visibility: 'user-only',
description: 'The ID of the resource', description: 'The ID of the resource',
}, },
// User-or-LLM params (everything else, can be provided by user OR computed by LLM) // User-or-LLM params (can be provided by user OR computed by LLM)
query: { query: {
type: 'string', type: 'string',
required: false, // Use false for optional required: false, // Use false for optional
@@ -114,8 +114,8 @@ export const {serviceName}{Action}Tool: ToolConfig<
### Visibility Options ### Visibility Options
- `'hidden'` - System-injected (OAuth tokens, internal params). User never sees. - `'hidden'` - System-injected (OAuth tokens, internal params). User never sees.
- `'user-only'` - User must provide (credentials, api keys, account-specific IDs) - `'user-only'` - User must provide (credentials, account-specific IDs)
- `'user-or-llm'` - User provides OR LLM can compute (search queries, content, filters, most fall into this category) - `'user-or-llm'` - User provides OR LLM can compute (search queries, content, filters)
### Parameter Types ### Parameter Types
- `'string'` - Text values - `'string'` - Text values

View File

@@ -1,7 +0,0 @@
Based on the given area of interest, please:
1. Dig around the codebase in terms of that given area of interest, gather general information such as keywords and architecture overview.
2. Spawn off n=10 (unless specified otherwise) task agents to dig deeper into the codebase in terms of that given area of interest, some of them should be out of the box for variance.
3. Once the task agents are done, use the information to do what the user wants.
If user is in plan mode, use the information to create the plan.

View File

@@ -172,6 +172,31 @@ Key environment variables for self-hosted deployments. See [`.env.example`](apps
| `API_ENCRYPTION_KEY` | Yes | Encrypts API keys (`openssl rand -hex 32`) | | `API_ENCRYPTION_KEY` | Yes | Encrypts API keys (`openssl rand -hex 32`) |
| `COPILOT_API_KEY` | No | API key from sim.ai for Copilot features | | `COPILOT_API_KEY` | No | API key from sim.ai for Copilot features |
## Troubleshooting
### Ollama models not showing in dropdown (Docker)
If you're running Ollama on your host machine and Sim in Docker, change `OLLAMA_URL` from `localhost` to `host.docker.internal`:
```bash
OLLAMA_URL=http://host.docker.internal:11434 docker compose -f docker-compose.prod.yml up -d
```
See [Using an External Ollama Instance](#using-an-external-ollama-instance) for details.
### Database connection issues
Ensure PostgreSQL has the pgvector extension installed. When using Docker, wait for the database to be healthy before running migrations.
### Port conflicts
If ports 3000, 3002, or 5432 are in use, configure alternatives:
```bash
# Custom ports
NEXT_PUBLIC_APP_URL=http://localhost:3100 POSTGRES_PORT=5433 docker compose up -d
```
## Tech Stack ## Tech Stack
- **Framework**: [Next.js](https://nextjs.org/) (App Router) - **Framework**: [Next.js](https://nextjs.org/) (App Router)

View File

@@ -1,6 +1,5 @@
import type React from 'react' import type React from 'react'
import { findNeighbour } from 'fumadocs-core/page-tree' import { findNeighbour } from 'fumadocs-core/page-tree'
import { Pre } from 'fumadocs-ui/components/codeblock'
import defaultMdxComponents from 'fumadocs-ui/mdx' import defaultMdxComponents from 'fumadocs-ui/mdx'
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page' import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page'
import { ChevronLeft, ChevronRight } from 'lucide-react' import { ChevronLeft, ChevronRight } from 'lucide-react'
@@ -22,7 +21,6 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
const data = page.data as PageData const data = page.data as PageData
const MDX = data.body const MDX = data.body
const baseUrl = 'https://docs.sim.ai' const baseUrl = 'https://docs.sim.ai'
const markdownContent = await data.getText('processed')
const pageTreeRecord = source.pageTree as Record<string, any> const pageTreeRecord = source.pageTree as Record<string, any>
const pageTree = const pageTree =
@@ -202,7 +200,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
<div className='relative mt-6 sm:mt-0'> <div className='relative mt-6 sm:mt-0'>
<div className='absolute top-1 right-0 flex items-center gap-2'> <div className='absolute top-1 right-0 flex items-center gap-2'>
<div className='hidden sm:flex'> <div className='hidden sm:flex'>
<LLMCopyButton content={markdownContent} /> <LLMCopyButton markdownUrl={`${page.url}.mdx`} />
</div> </div>
<PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} /> <PageNavigationArrows previous={neighbours?.previous} next={neighbours?.next} />
</div> </div>
@@ -213,11 +211,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[]; l
<MDX <MDX
components={{ components={{
...defaultMdxComponents, ...defaultMdxComponents,
pre: (props: React.HTMLAttributes<HTMLPreElement>) => ( CodeBlock,
<CodeBlock {...props}>
<Pre>{props.children}</Pre>
</CodeBlock>
),
h1: (props: React.HTMLAttributes<HTMLHeadingElement>) => ( h1: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
<Heading as='h1' {...props} /> <Heading as='h1' {...props} />
), ),

View File

@@ -3,7 +3,6 @@ import { defineI18nUI } from 'fumadocs-ui/i18n'
import { DocsLayout } from 'fumadocs-ui/layouts/docs' import { DocsLayout } from 'fumadocs-ui/layouts/docs'
import { RootProvider } from 'fumadocs-ui/provider/next' import { RootProvider } from 'fumadocs-ui/provider/next'
import { Geist_Mono, Inter } from 'next/font/google' import { Geist_Mono, Inter } from 'next/font/google'
import Script from 'next/script'
import { import {
SidebarFolder, SidebarFolder,
SidebarItem, SidebarItem,
@@ -18,13 +17,11 @@ import '../global.css'
const inter = Inter({ const inter = Inter({
subsets: ['latin'], subsets: ['latin'],
variable: '--font-geist-sans', variable: '--font-geist-sans',
display: 'swap',
}) })
const geistMono = Geist_Mono({ const geistMono = Geist_Mono({
subsets: ['latin'], subsets: ['latin'],
variable: '--font-geist-mono', variable: '--font-geist-mono',
display: 'swap',
}) })
const { provider } = defineI18nUI(i18n, { const { provider } = defineI18nUI(i18n, {
@@ -96,9 +93,10 @@ export default async function Layout({ children, params }: LayoutProps) {
type='application/ld+json' type='application/ld+json'
dangerouslySetInnerHTML={{ __html: JSON.stringify(structuredData) }} dangerouslySetInnerHTML={{ __html: JSON.stringify(structuredData) }}
/> />
{/* OneDollarStats Analytics - CDN script handles everything automatically */}
<script defer src='https://assets.onedollarstats.com/stonks.js' />
</head> </head>
<body className='flex min-h-screen flex-col font-sans'> <body className='flex min-h-screen flex-col font-sans'>
<Script src='https://assets.onedollarstats.com/stonks.js' strategy='lazyOnload' />
<RootProvider i18n={provider(lang)}> <RootProvider i18n={provider(lang)}>
<Navbar /> <Navbar />
<DocsLayout <DocsLayout

View File

@@ -9,7 +9,7 @@ export default function NotFound() {
<DocsPage> <DocsPage>
<DocsBody> <DocsBody>
<div className='flex min-h-[60vh] flex-col items-center justify-center text-center'> <div className='flex min-h-[60vh] flex-col items-center justify-center text-center'>
<h1 className='mb-4 bg-gradient-to-b from-[#47d991] to-[#33c482] bg-clip-text font-bold text-8xl text-transparent'> <h1 className='mb-4 bg-gradient-to-b from-[#8357FF] to-[#6F3DFA] bg-clip-text font-bold text-8xl text-transparent'>
404 404
</h1> </h1>
<h2 className='mb-2 font-semibold text-2xl text-foreground'>Page Not Found</h2> <h2 className='mb-2 font-semibold text-2xl text-foreground'>Page Not Found</h2>

View File

@@ -1,5 +1,4 @@
import type { SVGProps } from 'react' import type { SVGProps } from 'react'
import { useId } from 'react'
export function SearchIcon(props: SVGProps<SVGSVGElement>) { export function SearchIcon(props: SVGProps<SVGSVGElement>) {
return ( return (
@@ -738,9 +737,6 @@ export function GmailIcon(props: SVGProps<SVGSVGElement>) {
} }
export function GrafanaIcon(props: SVGProps<SVGSVGElement>) { export function GrafanaIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradientId = `grafana_gradient_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -751,12 +747,12 @@ export function GrafanaIcon(props: SVGProps<SVGSVGElement>) {
fill='none' fill='none'
> >
<path <path
fill={`url(#${gradientId})`} fill='url(#grafana-color-16__paint0_linear_2372_364)'
d='M13.985 7.175a4.408 4.408 0 00-.138-.802 5.035 5.035 0 00-1.054-1.998 2.96 2.96 0 00-.366-.393c.198-.787-.245-1.468-.245-1.468-.764-.046-1.237.227-1.42.363-.031-.015-.062-.03-.092-.03-.122-.046-.26-.106-.397-.137-.138-.045-.275-.075-.413-.12-.137-.031-.29-.061-.443-.092-.03 0-.046 0-.076-.015C9.005 1.44 8.058 1 8.058 1 7.004 1.666 6.79 2.604 6.79 2.604s0 .015-.016.06l-.183.046c-.076.03-.168.06-.244.076-.077.03-.168.06-.245.09-.153.076-.32.152-.473.228-.153.09-.306.181-.443.272-.016-.015-.03-.015-.03-.015-1.467-.545-2.766.136-2.766.136-.122 1.544.58 2.528.733 2.71-.03.09-.06.196-.091.287a8.104 8.104 0 00-.245 1.09c0 .06-.015.106-.015.166C1.397 8.386 1 9.748 1 9.748c1.13 1.287 2.46 1.377 2.46 1.377.167.303.366.575.58.848.092.106.183.212.29.318a3.014 3.014 0 00.061 2.149c1.268.045 2.093-.545 2.261-.681.122.045.26.076.382.106.382.106.78.151 1.176.181h.49c.595.848 1.634.954 1.634.954.748-.772.779-1.544.779-1.71v-.015-.03-.03c.153-.107.305-.228.443-.35a5.37 5.37 0 00.779-.892c.015-.03.046-.06.061-.09.84.045 1.436-.515 1.436-.515-.138-.863-.642-1.287-.749-1.378l-.015-.015h-.015s-.015 0-.015-.015c0-.045.015-.106.015-.151 0-.091.015-.182.015-.288V9.4v-.166-.076-.152l-.015-.075c-.015-.091-.03-.197-.061-.288a3.506 3.506 0 00-.428-1.044 3.856 3.856 0 00-.718-.848 3.784 3.784 0 00-.901-.575 3.347 3.347 0 00-.993-.272c-.168-.015-.336-.03-.504-.03H9.37 9.204c-.092.015-.169.015-.26.03-.336.06-.642.181-.932.348-.275.166-.52.363-.718.605a2.579 2.579 0 00-.459.757 2.63 2.63 0 00-.183.817v.393c.015.137.046.273.077.394.076.258.183.485.336.666.137.197.32.348.504.485.183.12.382.212.58.272.199.06.382.076.565.076h.244c.031 0 .047 0 .062-.015.015 0 .046-.015.061-.015.046-.016.076-.016.122-.03l.23-.092a.869.869 0 00.198-.12c.015-.016.03-.03.046-.03a.129.129 0 00.015-.198c-.046-.06-.122-.075-.183-.03-.015.015-.03.015-.046.03-.046.03-.107.046-.168.06l-.183.046c-.03 0-.061.015-.092.015H8.73a1.519 1.519 0 01-.825-.378 1.452 1.452 0 01-.306-.378 1.655 1.655 0 01-.168-.485c-.015-.09-.015-.166-.015-.257v-.106-.03c0-.046.015-.091.015-.136.061-.364.26-.727.55-1 .077-.075.153-.136.23-.181.076-.06.167-.106.259-.151.092-.046.183-.076.29-.106a.993.993 0 01.306-.046h.321c.107.015.229.03.336.046.214.045.427.12.626.242.397.212.733.56.947.969.107.211.183.423.214.65.015.06.015.121.015.167v.363c0 .06-.015.121-.015.182 0 .06-.015.12-.03.181l-.046.182c-.03.121-.077.242-.123.363a3.183 3.183 0 01-.366.666 3.002 3.002 0 01-1.91 1.18c-.122.016-.26.03-.382.046h-.198c-.061 0-.138 0-.199-.015a3.637 3.637 0 01-.81-.151 4.068 4.068 0 01-.748-.303 4.098 4.098 0 01-1.696-1.695 4.398 4.398 0 01-.29-.742c-.076-.257-.107-.514-.137-.772v-.302-.091c0-.136.015-.258.03-.394s.046-.272.061-.393c.03-.137.061-.258.092-.394a5.33 5.33 0 01.275-.741c.214-.47.504-.893.855-1.226.092-.091.184-.167.275-.243.092-.075.184-.136.29-.211a5.39 5.39 0 01.306-.182c.046-.03.107-.045.153-.076a.26.26 0 01.076-.03.26.26 0 01.077-.03c.107-.046.229-.091.336-.121.03-.015.06-.015.091-.03.03-.016.061-.016.092-.03.061-.016.122-.031.168-.046.03-.015.061-.015.092-.015.03 0 .06-.016.091-.016.03 0 .061-.015.092-.015l.046-.015h.046c.03 0 .06-.015.091-.015.03 0 .061-.015.107-.015.03 0 .077-.015.107-.015h.764c.23.015.443.03.657.075.428.076.84.212 1.207.394.366.182.702.393.977.636l.046.045.046.045c.03.03.061.061.107.091l.092.091.091.09c.123.122.23.258.336.394.199.258.367.515.49.772.014.015.014.03.03.046.015.015.015.03.015.045l.046.09.046.092.045.09c.046.122.092.228.123.333.06.167.107.318.137.455.015.045.061.09.122.075a.104.104 0 00.107-.106c.092-.227.092-.393.077-.575z' d='M13.985 7.175a4.408 4.408 0 00-.138-.802 5.035 5.035 0 00-1.054-1.998 2.96 2.96 0 00-.366-.393c.198-.787-.245-1.468-.245-1.468-.764-.046-1.237.227-1.42.363-.031-.015-.062-.03-.092-.03-.122-.046-.26-.106-.397-.137-.138-.045-.275-.075-.413-.12-.137-.031-.29-.061-.443-.092-.03 0-.046 0-.076-.015C9.005 1.44 8.058 1 8.058 1 7.004 1.666 6.79 2.604 6.79 2.604s0 .015-.016.06l-.183.046c-.076.03-.168.06-.244.076-.077.03-.168.06-.245.09-.153.076-.32.152-.473.228-.153.09-.306.181-.443.272-.016-.015-.03-.015-.03-.015-1.467-.545-2.766.136-2.766.136-.122 1.544.58 2.528.733 2.71-.03.09-.06.196-.091.287a8.104 8.104 0 00-.245 1.09c0 .06-.015.106-.015.166C1.397 8.386 1 9.748 1 9.748c1.13 1.287 2.46 1.377 2.46 1.377.167.303.366.575.58.848.092.106.183.212.29.318a3.014 3.014 0 00.061 2.149c1.268.045 2.093-.545 2.261-.681.122.045.26.076.382.106.382.106.78.151 1.176.181h.49c.595.848 1.634.954 1.634.954.748-.772.779-1.544.779-1.71v-.015-.03-.03c.153-.107.305-.228.443-.35a5.37 5.37 0 00.779-.892c.015-.03.046-.06.061-.09.84.045 1.436-.515 1.436-.515-.138-.863-.642-1.287-.749-1.378l-.015-.015h-.015s-.015 0-.015-.015c0-.045.015-.106.015-.151 0-.091.015-.182.015-.288V9.4v-.166-.076-.152l-.015-.075c-.015-.091-.03-.197-.061-.288a3.506 3.506 0 00-.428-1.044 3.856 3.856 0 00-.718-.848 3.784 3.784 0 00-.901-.575 3.347 3.347 0 00-.993-.272c-.168-.015-.336-.03-.504-.03H9.37 9.204c-.092.015-.169.015-.26.03-.336.06-.642.181-.932.348-.275.166-.52.363-.718.605a2.579 2.579 0 00-.459.757 2.63 2.63 0 00-.183.817v.393c.015.137.046.273.077.394.076.258.183.485.336.666.137.197.32.348.504.485.183.12.382.212.58.272.199.06.382.076.565.076h.244c.031 0 .047 0 .062-.015.015 0 .046-.015.061-.015.046-.016.076-.016.122-.03l.23-.092a.869.869 0 00.198-.12c.015-.016.03-.03.046-.03a.129.129 0 00.015-.198c-.046-.06-.122-.075-.183-.03-.015.015-.03.015-.046.03-.046.03-.107.046-.168.06l-.183.046c-.03 0-.061.015-.092.015H8.73a1.519 1.519 0 01-.825-.378 1.452 1.452 0 01-.306-.378 1.655 1.655 0 01-.168-.485c-.015-.09-.015-.166-.015-.257v-.106-.03c0-.046.015-.091.015-.136.061-.364.26-.727.55-1 .077-.075.153-.136.23-.181.076-.06.167-.106.259-.151.092-.046.183-.076.29-.106a.993.993 0 01.306-.046h.321c.107.015.229.03.336.046.214.045.427.12.626.242.397.212.733.56.947.969.107.211.183.423.214.65.015.06.015.121.015.167v.363c0 .06-.015.121-.015.182 0 .06-.015.12-.03.181l-.046.182c-.03.121-.077.242-.123.363a3.183 3.183 0 01-.366.666 3.002 3.002 0 01-1.91 1.18c-.122.016-.26.03-.382.046h-.198c-.061 0-.138 0-.199-.015a3.637 3.637 0 01-.81-.151 4.068 4.068 0 01-.748-.303 4.098 4.098 0 01-1.696-1.695 4.398 4.398 0 01-.29-.742c-.076-.257-.107-.514-.137-.772v-.302-.091c0-.136.015-.258.03-.394s.046-.272.061-.393c.03-.137.061-.258.092-.394a5.33 5.33 0 01.275-.741c.214-.47.504-.893.855-1.226.092-.091.184-.167.275-.243.092-.075.184-.136.29-.211a5.39 5.39 0 01.306-.182c.046-.03.107-.045.153-.076a.26.26 0 01.076-.03.26.26 0 01.077-.03c.107-.046.229-.091.336-.121.03-.015.06-.015.091-.03.03-.016.061-.016.092-.03.061-.016.122-.031.168-.046.03-.015.061-.015.092-.015.03 0 .06-.016.091-.016.03 0 .061-.015.092-.015l.046-.015h.046c.03 0 .06-.015.091-.015.03 0 .061-.015.107-.015.03 0 .077-.015.107-.015h.764c.23.015.443.03.657.075.428.076.84.212 1.207.394.366.182.702.393.977.636l.046.045.046.045c.03.03.061.061.107.091l.092.091.091.09c.123.122.23.258.336.394.199.258.367.515.49.772.014.015.014.03.03.046.015.015.015.03.015.045l.046.09.046.092.045.09c.046.122.092.228.123.333.06.167.107.318.137.455.015.045.061.09.122.075a.104.104 0 00.107-.106c.092-.227.092-.393.077-.575z'
/> />
<defs> <defs>
<linearGradient <linearGradient
id={gradientId} id='grafana-color-16__paint0_linear_2372_364'
x1='7.502' x1='7.502'
x2='7.502' x2='7.502'
y1='18.142' y1='18.142'
@@ -1240,10 +1236,6 @@ export function GoogleCalendarIcon(props: SVGProps<SVGSVGElement>) {
} }
export function SupabaseIcon(props: SVGProps<SVGSVGElement>) { export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradient0 = `supabase_paint0_${id}`
const gradient1 = `supabase_paint1_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -1255,11 +1247,11 @@ export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
> >
<path <path
d='M15.4057 26.2606C14.7241 27.1195 13.3394 26.649 13.3242 25.5519L13.083 9.50684H23.8724C25.8262 9.50684 26.9157 11.7636 25.7006 13.2933L15.4057 26.2606Z' d='M15.4057 26.2606C14.7241 27.1195 13.3394 26.649 13.3242 25.5519L13.083 9.50684H23.8724C25.8262 9.50684 26.9157 11.7636 25.7006 13.2933L15.4057 26.2606Z'
fill={`url(#${gradient0})`} fill='url(#supabase_paint0_linear)'
/> />
<path <path
d='M15.4057 26.2606C14.7241 27.1195 13.3394 26.649 13.3242 25.5519L13.083 9.50684H23.8724C25.8262 9.50684 26.9157 11.7636 25.7006 13.2933L15.4057 26.2606Z' d='M15.4057 26.2606C14.7241 27.1195 13.3394 26.649 13.3242 25.5519L13.083 9.50684H23.8724C25.8262 9.50684 26.9157 11.7636 25.7006 13.2933L15.4057 26.2606Z'
fill={`url(#${gradient1})`} fill='url(#supabase_paint1_linear)'
fillOpacity='0.2' fillOpacity='0.2'
/> />
<path <path
@@ -1268,7 +1260,7 @@ export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
/> />
<defs> <defs>
<linearGradient <linearGradient
id={gradient0} id='supabase_paint0_linear'
x1='13.084' x1='13.084'
y1='13.0655' y1='13.0655'
x2='22.6727' x2='22.6727'
@@ -1279,7 +1271,7 @@ export function SupabaseIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' stopColor='#3ECF8E' /> <stop offset='1' stopColor='#3ECF8E' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={gradient1} id='supabase_paint1_linear'
x1='8.83277' x1='8.83277'
y1='7.24485' y1='7.24485'
x2='13.2057' x2='13.2057'
@@ -1489,9 +1481,6 @@ export function DocumentIcon(props: SVGProps<SVGSVGElement>) {
} }
export function MistralIcon(props: SVGProps<SVGSVGElement>) { export function MistralIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const clipId = `mistral_clip_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -1502,7 +1491,7 @@ export function MistralIcon(props: SVGProps<SVGSVGElement>) {
xmlns='http://www.w3.org/2000/svg' xmlns='http://www.w3.org/2000/svg'
preserveAspectRatio='xMidYMid meet' preserveAspectRatio='xMidYMid meet'
> >
<g clipPath={`url(#${clipId})`}> <g clipPath='url(#clip0_1621_58)'>
<path d='M17.4541 0H21.8177V4.39481H17.4541V0Z' fill='black' /> <path d='M17.4541 0H21.8177V4.39481H17.4541V0Z' fill='black' />
<path d='M19.6367 0H24.0003V4.39481H19.6367V0Z' fill='#F7D046' /> <path d='M19.6367 0H24.0003V4.39481H19.6367V0Z' fill='#F7D046' />
<path <path
@@ -1539,7 +1528,7 @@ export function MistralIcon(props: SVGProps<SVGSVGElement>) {
/> />
</g> </g>
<defs> <defs>
<clipPath id={clipId}> <clipPath id='clip0_1621_58'>
<rect width='24' height='22' fill='white' /> <rect width='24' height='22' fill='white' />
</clipPath> </clipPath>
</defs> </defs>
@@ -2107,23 +2096,6 @@ export function ClayIcon(props: SVGProps<SVGSVGElement>) {
) )
} }
export function ClerkIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg {...props} viewBox='0 0 128 128' fill='none' xmlns='http://www.w3.org/2000/svg'>
<circle cx='64' cy='64' r='20' fill='white' />
<path
d='M99.5716 10.788C101.571 12.1272 101.742 14.9444 100.04 16.646L85.4244 31.2618C84.1035 32.5828 82.0542 32.7914 80.3915 31.9397C75.4752 29.421 69.9035 28 64 28C44.1177 28 28 44.1177 28 64C28 69.9035 29.421 75.4752 31.9397 80.3915C32.7914 82.0542 32.5828 84.1035 31.2618 85.4244L16.646 100.04C14.9444 101.742 12.1272 101.571 10.788 99.5716C3.97411 89.3989 0 77.1635 0 64C0 28.6538 28.6538 0 64 0C77.1635 0 89.3989 3.97411 99.5716 10.788Z'
fill='white'
fillOpacity='0.4'
/>
<path
d='M100.04 111.354C101.742 113.056 101.571 115.873 99.5717 117.212C89.3989 124.026 77.1636 128 64 128C50.8364 128 38.6011 124.026 28.4283 117.212C26.4289 115.873 26.2581 113.056 27.9597 111.354L42.5755 96.7382C43.8965 95.4172 45.9457 95.2085 47.6084 96.0603C52.5248 98.579 58.0964 100 64 100C69.9036 100 75.4753 98.579 80.3916 96.0603C82.0543 95.2085 84.1036 95.4172 85.4245 96.7382L100.04 111.354Z'
fill='white'
/>
</svg>
)
}
export function MicrosoftIcon(props: SVGProps<SVGSVGElement>) { export function MicrosoftIcon(props: SVGProps<SVGSVGElement>) {
return ( return (
<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 23 23' {...props}> <svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 23 23' {...props}>
@@ -2137,9 +2109,6 @@ export function MicrosoftIcon(props: SVGProps<SVGSVGElement>) {
} }
export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) { export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradientId = `msteams_gradient_${id}`
return ( return (
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='0 0 2228.833 2073.333'> <svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='0 0 2228.833 2073.333'>
<path <path
@@ -2185,7 +2154,7 @@ export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
d='M1140.333,561.355v103.148c-104.963-24.857-191.679-98.469-233.25-198.003 h138.395C1097.783,466.699,1140.134,509.051,1140.333,561.355z' d='M1140.333,561.355v103.148c-104.963-24.857-191.679-98.469-233.25-198.003 h138.395C1097.783,466.699,1140.134,509.051,1140.333,561.355z'
/> />
<linearGradient <linearGradient
id={gradientId} id='msteams_gradient_a'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='198.099' x1='198.099'
y1='1683.0726' y1='1683.0726'
@@ -2201,7 +2170,7 @@ export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' stopColor='#3940ab' /> <stop offset='1' stopColor='#3940ab' />
</linearGradient> </linearGradient>
<path <path
fill={`url(#${gradientId})`} fill='url(#msteams_gradient_a)'
d='M95.01,466.5h950.312c52.473,0,95.01,42.538,95.01,95.01v950.312c0,52.473-42.538,95.01-95.01,95.01 H95.01c-52.473,0-95.01-42.538-95.01-95.01V561.51C0,509.038,42.538,466.5,95.01,466.5z' d='M95.01,466.5h950.312c52.473,0,95.01,42.538,95.01,95.01v950.312c0,52.473-42.538,95.01-95.01,95.01 H95.01c-52.473,0-95.01-42.538-95.01-95.01V561.51C0,509.038,42.538,466.5,95.01,466.5z'
/> />
<path <path
@@ -2213,10 +2182,6 @@ export function MicrosoftTeamsIcon(props: SVGProps<SVGSVGElement>) {
} }
export function OutlookIcon(props: SVGProps<SVGSVGElement>) { export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradient1 = `outlook_gradient1_${id}`
const gradient2 = `outlook_gradient2_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -2246,7 +2211,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
<path fill='#14447D' d='M520.453,1025.151h416.38v346.969h-416.38V1025.151z' /> <path fill='#14447D' d='M520.453,1025.151h416.38v346.969h-416.38V1025.151z' />
<path fill='#0078D4' d='M1362.667,1022h383.25v383.25h-383.25V1022z' /> <path fill='#0078D4' d='M1362.667,1022h383.25v383.25h-383.25V1022z' />
<linearGradient <linearGradient
id={gradient1} id='SVGID_1_'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='1128.4584' x1='1128.4584'
y1='811.0833' y1='811.0833'
@@ -2258,7 +2223,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' style={{ stopColor: '#28A8EA' }} /> <stop offset='1' style={{ stopColor: '#28A8EA' }} />
</linearGradient> </linearGradient>
<path <path
fill={`url(#${gradient1})`} fill='url(#SVGID_1_)'
d='M1811.58,927.593l-0.809,0.426l-634.492,356.848c-2.768,1.703-5.578,3.321-8.517,4.769 c-10.777,5.132-22.481,8.029-34.407,8.517l-34.663-20.27c-2.929-1.47-5.773-3.105-8.517-4.897L447.167,906.003h-0.298 l-21.036-11.753v722.384c0.328,48.196,39.653,87.006,87.849,86.7h1230.914c0.724,0,1.363-0.341,2.129-0.341 c10.18-0.651,20.216-2.745,29.808-6.217c4.145-1.756,8.146-3.835,11.966-6.217c2.853-1.618,7.75-5.152,7.75-5.152 c21.814-16.142,34.726-41.635,34.833-68.772V894.25C1831.068,908.067,1823.616,920.807,1811.58,927.593z' d='M1811.58,927.593l-0.809,0.426l-634.492,356.848c-2.768,1.703-5.578,3.321-8.517,4.769 c-10.777,5.132-22.481,8.029-34.407,8.517l-34.663-20.27c-2.929-1.47-5.773-3.105-8.517-4.897L447.167,906.003h-0.298 l-21.036-11.753v722.384c0.328,48.196,39.653,87.006,87.849,86.7h1230.914c0.724,0,1.363-0.341,2.129-0.341 c10.18-0.651,20.216-2.745,29.808-6.217c4.145-1.756,8.146-3.835,11.966-6.217c2.853-1.618,7.75-5.152,7.75-5.152 c21.814-16.142,34.726-41.635,34.833-68.772V894.25C1831.068,908.067,1823.616,920.807,1811.58,927.593z'
/> />
<path <path
@@ -2306,7 +2271,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
d='M936.833,461.305v823.136c-0.046,43.067-34.861,78.015-77.927,78.225H425.833 V383.25h433.072c43.062,0.023,77.951,34.951,77.927,78.013C936.833,461.277,936.833,461.291,936.833,461.305z' d='M936.833,461.305v823.136c-0.046,43.067-34.861,78.015-77.927,78.225H425.833 V383.25h433.072c43.062,0.023,77.951,34.951,77.927,78.013C936.833,461.277,936.833,461.291,936.833,461.305z'
/> />
<linearGradient <linearGradient
id={gradient2} id='SVGID_2_'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='162.7469' x1='162.7469'
y1='1383.0741' y1='1383.0741'
@@ -2319,7 +2284,7 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' style={{ stopColor: '#0A63C9' }} /> <stop offset='1' style={{ stopColor: '#0A63C9' }} />
</linearGradient> </linearGradient>
<path <path
fill={`url(#${gradient2})`} fill='url(#SVGID_2_)'
d='M78.055,383.25h780.723c43.109,0,78.055,34.947,78.055,78.055v780.723 c0,43.109-34.946,78.055-78.055,78.055H78.055c-43.109,0-78.055-34.947-78.055-78.055V461.305 C0,418.197,34.947,383.25,78.055,383.25z' d='M78.055,383.25h780.723c43.109,0,78.055,34.947,78.055,78.055v780.723 c0,43.109-34.946,78.055-78.055,78.055H78.055c-43.109,0-78.055-34.947-78.055-78.055V461.305 C0,418.197,34.947,383.25,78.055,383.25z'
/> />
<path <path
@@ -2332,9 +2297,6 @@ export function OutlookIcon(props: SVGProps<SVGSVGElement>) {
} }
export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) { export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradientId = `excel_gradient_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -2376,7 +2338,7 @@ export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) {
d='M1073.893,479.25H532.5V1704h541.393c53.834-0.175,97.432-43.773,97.607-97.607 V576.857C1171.325,523.023,1127.727,479.425,1073.893,479.25z' d='M1073.893,479.25H532.5V1704h541.393c53.834-0.175,97.432-43.773,97.607-97.607 V576.857C1171.325,523.023,1127.727,479.425,1073.893,479.25z'
/> />
<linearGradient <linearGradient
id={gradientId} id='SVGID_1_'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='203.5132' x1='203.5132'
y1='1729.0183' y1='1729.0183'
@@ -2389,7 +2351,7 @@ export function MicrosoftExcelIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' style={{ stopColor: '#0B6631' }} /> <stop offset='1' style={{ stopColor: '#0B6631' }} />
</linearGradient> </linearGradient>
<path <path
fill={`url(#${gradientId})`} fill='url(#SVGID_1_)'
d='M97.607,479.25h976.285c53.907,0,97.607,43.7,97.607,97.607v976.285 c0,53.907-43.7,97.607-97.607,97.607H97.607C43.7,1650.75,0,1607.05,0,1553.143V576.857C0,522.95,43.7,479.25,97.607,479.25z' d='M97.607,479.25h976.285c53.907,0,97.607,43.7,97.607,97.607v976.285 c0,53.907-43.7,97.607-97.607,97.607H97.607C43.7,1650.75,0,1607.05,0,1553.143V576.857C0,522.95,43.7,479.25,97.607,479.25z'
/> />
<path <path
@@ -2503,13 +2465,7 @@ export const AnthropicIcon = (props: SVGProps<SVGSVGElement>) => (
</svg> </svg>
) )
export function AzureIcon(props: SVGProps<SVGSVGElement>) { export const AzureIcon = (props: SVGProps<SVGSVGElement>) => (
const id = useId()
const gradient0 = `azure_paint0_${id}`
const gradient1 = `azure_paint1_${id}`
const gradient2 = `azure_paint2_${id}`
return (
<svg <svg
{...props} {...props}
width='18' width='18'
@@ -2520,7 +2476,7 @@ export function AzureIcon(props: SVGProps<SVGSVGElement>) {
> >
<path <path
d='M5.33492 1.37491C5.44717 1.04229 5.75909 0.818359 6.11014 0.818359H11.25L5.91513 16.6255C5.80287 16.9581 5.49095 17.182 5.13991 17.182H1.13968C0.579936 17.182 0.185466 16.6325 0.364461 16.1022L5.33492 1.37491Z' d='M5.33492 1.37491C5.44717 1.04229 5.75909 0.818359 6.11014 0.818359H11.25L5.91513 16.6255C5.80287 16.9581 5.49095 17.182 5.13991 17.182H1.13968C0.579936 17.182 0.185466 16.6325 0.364461 16.1022L5.33492 1.37491Z'
fill={`url(#${gradient0})`} fill='url(#paint0_linear_6102_134469)'
/> />
<path <path
d='M13.5517 11.4546H5.45126C5.1109 11.4546 4.94657 11.8715 5.19539 12.1037L10.4005 16.9618C10.552 17.1032 10.7515 17.1819 10.9587 17.1819H15.5453L13.5517 11.4546Z' d='M13.5517 11.4546H5.45126C5.1109 11.4546 4.94657 11.8715 5.19539 12.1037L10.4005 16.9618C10.552 17.1032 10.7515 17.1819 10.9587 17.1819H15.5453L13.5517 11.4546Z'
@@ -2528,15 +2484,15 @@ export function AzureIcon(props: SVGProps<SVGSVGElement>) {
/> />
<path <path
d='M6.11014 0.818359C5.75909 0.818359 5.44717 1.04229 5.33492 1.37491L0.364461 16.1022C0.185466 16.6325 0.579936 17.182 1.13968 17.182H5.13991C5.49095 17.182 5.80287 16.9581 5.91513 16.6255L6.90327 13.6976L10.4005 16.9617C10.552 17.1032 10.7515 17.1818 10.9588 17.1818H15.5454L13.5517 11.4545H7.66032L11.25 0.818359H6.11014Z' d='M6.11014 0.818359C5.75909 0.818359 5.44717 1.04229 5.33492 1.37491L0.364461 16.1022C0.185466 16.6325 0.579936 17.182 1.13968 17.182H5.13991C5.49095 17.182 5.80287 16.9581 5.91513 16.6255L6.90327 13.6976L10.4005 16.9617C10.552 17.1032 10.7515 17.1818 10.9588 17.1818H15.5454L13.5517 11.4545H7.66032L11.25 0.818359H6.11014Z'
fill={`url(#${gradient1})`} fill='url(#paint1_linear_6102_134469)'
/> />
<path <path
d='M12.665 1.37478C12.5528 1.04217 12.2409 0.818237 11.8898 0.818237H6.13629H6.16254C6.51358 0.818237 6.82551 1.04217 6.93776 1.37478L11.9082 16.1021C12.0872 16.6324 11.6927 17.1819 11.133 17.1819H11.0454H16.8603C17.42 17.1819 17.8145 16.6324 17.6355 16.1021L12.665 1.37478Z' d='M12.665 1.37478C12.5528 1.04217 12.2409 0.818237 11.8898 0.818237H6.13629H6.16254C6.51358 0.818237 6.82551 1.04217 6.93776 1.37478L11.9082 16.1021C12.0872 16.6324 11.6927 17.1819 11.133 17.1819H11.0454H16.8603C17.42 17.1819 17.8145 16.6324 17.6355 16.1021L12.665 1.37478Z'
fill={`url(#${gradient2})`} fill='url(#paint2_linear_6102_134469)'
/> />
<defs> <defs>
<linearGradient <linearGradient
id={gradient0} id='paint0_linear_6102_134469'
x1='6.07512' x1='6.07512'
y1='1.38476' y1='1.38476'
x2='0.738178' x2='0.738178'
@@ -2547,7 +2503,7 @@ export function AzureIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' stopColor='#0669BC' /> <stop offset='1' stopColor='#0669BC' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={gradient1} id='paint1_linear_6102_134469'
x1='10.3402' x1='10.3402'
y1='11.4564' y1='11.4564'
x2='9.107' x2='9.107'
@@ -2561,7 +2517,7 @@ export function AzureIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='1' stopOpacity='0' /> <stop offset='1' stopOpacity='0' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={gradient2} id='paint2_linear_6102_134469'
x1='9.45858' x1='9.45858'
y1='1.38467' y1='1.38467'
x2='15.3168' x2='15.3168'
@@ -2574,7 +2530,6 @@ export function AzureIcon(props: SVGProps<SVGSVGElement>) {
</defs> </defs>
</svg> </svg>
) )
}
export const GroqIcon = (props: SVGProps<SVGSVGElement>) => ( export const GroqIcon = (props: SVGProps<SVGSVGElement>) => (
<svg <svg
@@ -2601,15 +2556,11 @@ export const DeepseekIcon = (props: SVGProps<SVGSVGElement>) => (
</svg> </svg>
) )
export function GeminiIcon(props: SVGProps<SVGSVGElement>) { export const GeminiIcon = (props: SVGProps<SVGSVGElement>) => (
const id = useId()
const gradientId = `gemini_gradient_${id}`
return (
<svg {...props} height='1em' viewBox='0 0 24 24' width='1em' xmlns='http://www.w3.org/2000/svg'> <svg {...props} height='1em' viewBox='0 0 24 24' width='1em' xmlns='http://www.w3.org/2000/svg'>
<title>Gemini</title> <title>Gemini</title>
<defs> <defs>
<linearGradient id={gradientId} x1='0%' x2='68.73%' y1='100%' y2='30.395%'> <linearGradient id='lobe-icons-gemini-fill' x1='0%' x2='68.73%' y1='100%' y2='30.395%'>
<stop offset='0%' stopColor='#1C7DFF' /> <stop offset='0%' stopColor='#1C7DFF' />
<stop offset='52.021%' stopColor='#1C69FF' /> <stop offset='52.021%' stopColor='#1C69FF' />
<stop offset='100%' stopColor='#F0DCD6' /> <stop offset='100%' stopColor='#F0DCD6' />
@@ -2617,12 +2568,11 @@ export function GeminiIcon(props: SVGProps<SVGSVGElement>) {
</defs> </defs>
<path <path
d='M12 24A14.304 14.304 0 000 12 14.304 14.304 0 0012 0a14.305 14.305 0 0012 12 14.305 14.305 0 00-12 12' d='M12 24A14.304 14.304 0 000 12 14.304 14.304 0 0012 0a14.305 14.305 0 0012 12 14.305 14.305 0 00-12 12'
fill={`url(#${gradientId})`} fill='url(#lobe-icons-gemini-fill)'
fillRule='nonzero' fillRule='nonzero'
/> />
</svg> </svg>
) )
}
export const VertexIcon = (props: SVGProps<SVGSVGElement>) => ( export const VertexIcon = (props: SVGProps<SVGSVGElement>) => (
<svg <svg
@@ -2785,13 +2735,9 @@ export function ScheduleIcon(props: SVGProps<SVGSVGElement>) {
} }
export function QdrantIcon(props: SVGProps<SVGSVGElement>) { export function QdrantIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradientId = `qdrant_gradient_${id}`
const clipPathId = `qdrant_clippath_${id}`
return ( return (
<svg {...props} fill='none' viewBox='0 0 49 56' xmlns='http://www.w3.org/2000/svg'> <svg {...props} fill='none' viewBox='0 0 49 56' xmlns='http://www.w3.org/2000/svg'>
<g clipPath={`url(#${clipPathId})`}> <g clipPath='url(#qdrant_clippath_b)'>
<path <path
d='m38.489 51.477-1.1167-30.787-2.0223-8.1167 13.498 1.429v37.242l-8.2456 4.7589-2.1138-4.5259z' d='m38.489 51.477-1.1167-30.787-2.0223-8.1167 13.498 1.429v37.242l-8.2456 4.7589-2.1138-4.5259z'
clipRule='evenodd' clipRule='evenodd'
@@ -2842,12 +2788,12 @@ export function QdrantIcon(props: SVGProps<SVGSVGElement>) {
/> />
<path <path
d='m24.603 46.483v-9.5222l-7.7166-4.4411v9.5064l7.7166 4.4569z' d='m24.603 46.483v-9.5222l-7.7166-4.4411v9.5064l7.7166 4.4569z'
fill={`url(#${gradientId})`} fill='url(#qdrant_gradient_a)'
/> />
</g> </g>
<defs> <defs>
<linearGradient <linearGradient
id={gradientId} id='qdrant_gradient_a'
x1='23.18' x1='23.18'
x2='15.491' x2='15.491'
y1='38.781' y1='38.781'
@@ -2857,7 +2803,7 @@ export function QdrantIcon(props: SVGProps<SVGSVGElement>) {
<stop stopColor='#FF3364' offset='0' /> <stop stopColor='#FF3364' offset='0' />
<stop stopColor='#C91540' stopOpacity='0' offset='1' /> <stop stopColor='#C91540' stopOpacity='0' offset='1' />
</linearGradient> </linearGradient>
<clipPath id={clipPathId}> <clipPath id='qdrant_clippath_b'>
<rect transform='translate(.34961)' width='48.3' height='56' fill='#fff' /> <rect transform='translate(.34961)' width='48.3' height='56' fill='#fff' />
</clipPath> </clipPath>
</defs> </defs>
@@ -3291,13 +3237,9 @@ export const SOC2BadgeIcon = (props: SVGProps<SVGSVGElement>) => (
</svg> </svg>
) )
export function HIPAABadgeIcon(props: SVGProps<SVGSVGElement>) { export const HIPAABadgeIcon = (props: SVGProps<SVGSVGElement>) => (
const id = useId()
const clipId = `hipaa_clip_${id}`
return (
<svg {...props} viewBox='0 0 46 40' fill='none' xmlns='http://www.w3.org/2000/svg'> <svg {...props} viewBox='0 0 46 40' fill='none' xmlns='http://www.w3.org/2000/svg'>
<g clipPath={`url(#${clipId})`}> <g clipPath='url(#clip0_122_4972)'>
<path <path
fillRule='evenodd' fillRule='evenodd'
clipRule='evenodd' clipRule='evenodd'
@@ -3311,13 +3253,12 @@ export function HIPAABadgeIcon(props: SVGProps<SVGSVGElement>) {
/> />
</g> </g>
<defs> <defs>
<clipPath id={clipId}> <clipPath id='clip0_122_4972'>
<rect width='45.8537' height='40' fill='white' /> <rect width='45.8537' height='40' fill='white' />
</clipPath> </clipPath>
</defs> </defs>
</svg> </svg>
) )
}
export function GoogleFormsIcon(props: SVGProps<SVGSVGElement>) { export function GoogleFormsIcon(props: SVGProps<SVGSVGElement>) {
return ( return (
@@ -3334,6 +3275,19 @@ export function GoogleFormsIcon(props: SVGProps<SVGSVGElement>) {
d='M19.229 50.292h16.271v-2.959H19.229v2.959Zm0-17.75v2.958h16.271v-2.958H19.229Zm-3.698 1.479c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm0 7.396c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm0 7.396c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm3.698-5.917h16.271v-2.959H19.229v2.959Z' d='M19.229 50.292h16.271v-2.959H19.229v2.959Zm0-17.75v2.958h16.271v-2.958H19.229Zm-3.698 1.479c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm0 7.396c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm0 7.396c0 1.224-0.995 2.219-2.219 2.219s-2.219-0.995-2.219-2.219c0-1.224 0.995-2.219 2.219-2.219s2.219 0.995 2.219 2.219Zm3.698-5.917h16.271v-2.959H19.229v2.959Z'
fill='#F1F1F1' fill='#F1F1F1'
/> />
<defs>
<linearGradient
id='gf-gradient'
x1='30.881'
y1='16.452'
x2='47.333'
y2='32.9'
gradientUnits='userSpaceOnUse'
>
<stop stopColor='#9575CD' />
<stop offset='1' stopColor='#7E57C2' />
</linearGradient>
</defs>
</svg> </svg>
) )
} }
@@ -3782,9 +3736,6 @@ export function SentryIcon(props: SVGProps<SVGSVGElement>) {
} }
export function IncidentioIcon(props: SVGProps<SVGSVGElement>) { export function IncidentioIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const clipId = `incidentio_clip_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -3794,7 +3745,7 @@ export function IncidentioIcon(props: SVGProps<SVGSVGElement>) {
fill='none' fill='none'
xmlns='http://www.w3.org/2000/svg' xmlns='http://www.w3.org/2000/svg'
> >
<g clipPath={`url(#${clipId})`}> <g clipPath='url(#clip0_1361_12561)'>
<path <path
fillRule='evenodd' fillRule='evenodd'
clipRule='evenodd' clipRule='evenodd'
@@ -3803,7 +3754,7 @@ export function IncidentioIcon(props: SVGProps<SVGSVGElement>) {
/> />
</g> </g>
<defs> <defs>
<clipPath id={clipId}> <clipPath id='clip0_1361_12561'>
<rect width='128' height='163' fill='white' /> <rect width='128' height='163' fill='white' />
</clipPath> </clipPath>
</defs> </defs>
@@ -4027,9 +3978,6 @@ export function SftpIcon(props: SVGProps<SVGSVGElement>) {
} }
export function ApifyIcon(props: SVGProps<SVGSVGElement>) { export function ApifyIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const clipId = `apify_clip_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -4039,7 +3987,7 @@ export function ApifyIcon(props: SVGProps<SVGSVGElement>) {
fill='none' fill='none'
xmlns='http://www.w3.org/2000/svg' xmlns='http://www.w3.org/2000/svg'
> >
<g clipPath={`url(#${clipId})`}> <g clipPath='url(#clip0_267_4154)'>
<path <path
d='M114.695 0H196.97C198.643 0 200 1.35671 200 3.03031V128.766C200 131.778 196.083 132.945 194.434 130.425L112.159 4.68953C110.841 2.67412 112.287 0 114.695 0Z' d='M114.695 0H196.97C198.643 0 200 1.35671 200 3.03031V128.766C200 131.778 196.083 132.945 194.434 130.425L112.159 4.68953C110.841 2.67412 112.287 0 114.695 0Z'
fill='#246DFF' fill='#246DFF'
@@ -4054,7 +4002,7 @@ export function ApifyIcon(props: SVGProps<SVGSVGElement>) {
/> />
</g> </g>
<defs> <defs>
<clipPath id={clipId}> <clipPath id='clip0_267_4154'>
<rect width='200' height='200' fill='white' /> <rect width='200' height='200' fill='white' />
</clipPath> </clipPath>
</defs> </defs>
@@ -4163,9 +4111,6 @@ export function TextractIcon(props: SVGProps<SVGSVGElement>) {
} }
export function McpIcon(props: SVGProps<SVGSVGElement>) { export function McpIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const clipId = `mcp_clip_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -4175,7 +4120,7 @@ export function McpIcon(props: SVGProps<SVGSVGElement>) {
fill='none' fill='none'
xmlns='http://www.w3.org/2000/svg' xmlns='http://www.w3.org/2000/svg'
> >
<g clipPath={`url(#${clipId})`}> <g clipPath='url(#mcp-clip)'>
<path <path
fillRule='evenodd' fillRule='evenodd'
clipRule='evenodd' clipRule='evenodd'
@@ -4184,7 +4129,7 @@ export function McpIcon(props: SVGProps<SVGSVGElement>) {
/> />
</g> </g>
<defs> <defs>
<clipPath id={clipId}> <clipPath id='mcp-clip'>
<rect width='16' height='16' fill='white' /> <rect width='16' height='16' fill='white' />
</clipPath> </clipPath>
</defs> </defs>
@@ -4516,10 +4461,6 @@ export function GrainIcon(props: SVGProps<SVGSVGElement>) {
} }
export function CirclebackIcon(props: SVGProps<SVGSVGElement>) { export function CirclebackIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const patternId = `circleback_pattern_${id}`
const imageId = `circleback_image_${id}`
return ( return (
<svg <svg
{...props} {...props}
@@ -4530,13 +4471,13 @@ export function CirclebackIcon(props: SVGProps<SVGSVGElement>) {
xmlns='http://www.w3.org/2000/svg' xmlns='http://www.w3.org/2000/svg'
xmlnsXlink='http://www.w3.org/1999/xlink' xmlnsXlink='http://www.w3.org/1999/xlink'
> >
<rect width='280' height='280' fill={`url(#${patternId})`} /> <rect width='280' height='280' fill='url(#pattern0_5_2)' />
<defs> <defs>
<pattern id={patternId} patternContentUnits='objectBoundingBox' width='1' height='1'> <pattern id='pattern0_5_2' patternContentUnits='objectBoundingBox' width='1' height='1'>
<use xlinkHref={`#${imageId}`} transform='scale(0.00357143)' /> <use xlinkHref='#image0_5_2' transform='scale(0.00357143)' />
</pattern> </pattern>
<image <image
id={imageId} id='image0_5_2'
width='280' width='280'
height='280' height='280'
preserveAspectRatio='none' preserveAspectRatio='none'
@@ -4576,21 +4517,11 @@ export function JiraServiceManagementIcon(props: SVGProps<SVGSVGElement>) {
} }
export function FirefliesIcon(props: SVGProps<SVGSVGElement>) { export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const g1 = `fireflies_g1_${id}`
const g2 = `fireflies_g2_${id}`
const g3 = `fireflies_g3_${id}`
const g4 = `fireflies_g4_${id}`
const g5 = `fireflies_g5_${id}`
const g6 = `fireflies_g6_${id}`
const g7 = `fireflies_g7_${id}`
const g8 = `fireflies_g8_${id}`
return ( return (
<svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='-6 -6 68 68'> <svg {...props} xmlns='http://www.w3.org/2000/svg' viewBox='-6 -6 68 68'>
<defs> <defs>
<linearGradient <linearGradient
id={g1} id='fireflies_g1'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='144.6644' x1='144.6644'
y1='-133.7781' y1='-133.7781'
@@ -4606,7 +4537,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3B73FF' /> <stop offset='0.994' stopColor='#3B73FF' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g2} id='fireflies_g2'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='145.1664' x1='145.1664'
y1='-133.3084' y1='-133.3084'
@@ -4622,7 +4553,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3B73FF' /> <stop offset='0.994' stopColor='#3B73FF' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g3} id='fireflies_g3'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='144.7625' x1='144.7625'
y1='-123.2011' y1='-123.2011'
@@ -4638,7 +4569,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3B73FF' /> <stop offset='0.994' stopColor='#3B73FF' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g4} id='fireflies_g4'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='134.8237' x1='134.8237'
y1='-132.3271' y1='-132.3271'
@@ -4654,7 +4585,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3B73FF' /> <stop offset='0.994' stopColor='#3B73FF' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g5} id='fireflies_g5'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='82.2078' x1='82.2078'
y1='-52.7908' y1='-52.7908'
@@ -4670,7 +4601,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3D081E' /> <stop offset='0.994' stopColor='#3D081E' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g6} id='fireflies_g6'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='107.6542' x1='107.6542'
y1='-78.5296' y1='-78.5296'
@@ -4686,7 +4617,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3D081E' /> <stop offset='0.994' stopColor='#3D081E' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g7} id='fireflies_g7'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='70.8311' x1='70.8311'
y1='-99.3209' y1='-99.3209'
@@ -4702,7 +4633,7 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
<stop offset='0.994' stopColor='#3D081E' /> <stop offset='0.994' stopColor='#3D081E' />
</linearGradient> </linearGradient>
<linearGradient <linearGradient
id={g8} id='fireflies_g8'
gradientUnits='userSpaceOnUse' gradientUnits='userSpaceOnUse'
x1='297.6904' x1='297.6904'
y1='-1360.8851' y1='-1360.8851'
@@ -4719,25 +4650,25 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
</linearGradient> </linearGradient>
</defs> </defs>
<g> <g>
<path fill={`url(#${g1})`} d='M18.4,0H0v18.3h18.4V0z' /> <path fill='url(#fireflies_g1)' d='M18.4,0H0v18.3h18.4V0z' />
<path fill={`url(#${g2})`} d='M40.2,22.1H21.8v18.3h18.4V22.1z' /> <path fill='url(#fireflies_g2)' d='M40.2,22.1H21.8v18.3h18.4V22.1z' />
<path <path
fill={`url(#${g3})`} fill='url(#fireflies_g3)'
d='M40.2,0H21.8v18.3H56v-2.6c0-4.2-1.7-8.1-4.6-11.1C48.4,1.7,44.4,0,40.2,0L40.2,0z' d='M40.2,0H21.8v18.3H56v-2.6c0-4.2-1.7-8.1-4.6-11.1C48.4,1.7,44.4,0,40.2,0L40.2,0z'
/> />
<path <path
fill={`url(#${g4})`} fill='url(#fireflies_g4)'
d='M0,22.1v18.3c0,4.2,1.7,8.1,4.6,11.1c3,2.9,7,4.6,11.2,4.6h2.6V22.1H0z' d='M0,22.1v18.3c0,4.2,1.7,8.1,4.6,11.1c3,2.9,7,4.6,11.2,4.6h2.6V22.1H0z'
/> />
<path fill={`url(#${g5})`} opacity='0.18' d='M0,0l18.4,18.3H0V0z' /> <path fill='url(#fireflies_g5)' opacity='0.18' d='M0,0l18.4,18.3H0V0z' />
<path fill={`url(#${g6})`} opacity='0.18' d='M21.8,22.1l18.4,18.3H21.8V22.1z' /> <path fill='url(#fireflies_g6)' opacity='0.18' d='M21.8,22.1l18.4,18.3H21.8V22.1z' />
<path <path
fill={`url(#${g7})`} fill='url(#fireflies_g7)'
opacity='0.18' opacity='0.18'
d='M0,40.3c0,4.2,1.7,8.1,4.6,11.1c3,2.9,7,4.6,11.2,4.6h2.6V22.1L0,40.3z' d='M0,40.3c0,4.2,1.7,8.1,4.6,11.1c3,2.9,7,4.6,11.2,4.6h2.6V22.1L0,40.3z'
/> />
<path <path
fill={`url(#${g8})`} fill='url(#fireflies_g8)'
opacity='0.18' opacity='0.18'
d='M40.2,0c4.2,0,8.2,1.7,11.2,4.6c3,2.9,4.6,6.9,4.6,11.1v2.6H21.8L40.2,0z' d='M40.2,0c4.2,0,8.2,1.7,11.2,4.6c3,2.9,4.6,6.9,4.6,11.1v2.6H21.8L40.2,0z'
/> />
@@ -4747,13 +4678,10 @@ export function FirefliesIcon(props: SVGProps<SVGSVGElement>) {
} }
export function BedrockIcon(props: SVGProps<SVGSVGElement>) { export function BedrockIcon(props: SVGProps<SVGSVGElement>) {
const id = useId()
const gradientId = `bedrock_gradient_${id}`
return ( return (
<svg {...props} viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'> <svg {...props} viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'>
<defs> <defs>
<linearGradient id={gradientId} x1='80%' x2='20%' y1='20%' y2='80%'> <linearGradient id='bedrock_gradient' x1='80%' x2='20%' y1='20%' y2='80%'>
<stop offset='0%' stopColor='#6350FB' /> <stop offset='0%' stopColor='#6350FB' />
<stop offset='50%' stopColor='#3D8FFF' /> <stop offset='50%' stopColor='#3D8FFF' />
<stop offset='100%' stopColor='#9AD8F8' /> <stop offset='100%' stopColor='#9AD8F8' />
@@ -4761,7 +4689,7 @@ export function BedrockIcon(props: SVGProps<SVGSVGElement>) {
</defs> </defs>
<path <path
d='M13.05 15.513h3.08c.214 0 .389.177.389.394v1.82a1.704 1.704 0 011.296 1.661c0 .943-.755 1.708-1.685 1.708-.931 0-1.686-.765-1.686-1.708 0-.807.554-1.484 1.297-1.662v-1.425h-2.69v4.663a.395.395 0 01-.188.338l-2.69 1.641a.385.385 0 01-.405-.002l-4.926-3.086a.395.395 0 01-.185-.336V16.3L2.196 14.87A.395.395 0 012 14.555L2 14.528V9.406c0-.14.073-.27.192-.34l2.465-1.462V4.448c0-.129.062-.249.165-.322l.021-.014L9.77 1.058a.385.385 0 01.407 0l2.69 1.675a.395.395 0 01.185.336V7.6h3.856V5.683a1.704 1.704 0 01-1.296-1.662c0-.943.755-1.708 1.685-1.708.931 0 1.685.765 1.685 1.708 0 .807-.553 1.484-1.296 1.662v2.311a.391.391 0 01-.389.394h-4.245v1.806h6.624a1.69 1.69 0 011.64-1.313c.93 0 1.685.764 1.685 1.707 0 .943-.754 1.708-1.685 1.708a1.69 1.69 0 01-1.64-1.314H13.05v1.937h4.953l.915 1.18a1.66 1.66 0 01.84-.227c.931 0 1.685.764 1.685 1.707 0 .943-.754 1.708-1.685 1.708-.93 0-1.685-.765-1.685-1.708 0-.346.102-.668.276-.937l-.724-.935H13.05v1.806zM9.973 1.856L7.93 3.122V6.09h-.778V3.604L5.435 4.669v2.945l2.11 1.36L9.712 7.61V5.334h.778V7.83c0 .136-.07.263-.184.335L7.963 9.638v2.081l1.422 1.009-.446.646-1.406-.998-1.53 1.005-.423-.66 1.605-1.055v-1.99L5.038 8.29l-2.26 1.34v1.676l1.972-1.189.398.677-2.37 1.429V14.3l2.166 1.258 2.27-1.368.397.677-2.176 1.311V19.3l1.876 1.175 2.365-1.426.398.678-2.017 1.216 1.918 1.201 2.298-1.403v-5.78l-4.758 2.893-.4-.675 5.158-3.136V3.289L9.972 1.856zM16.13 18.47a.913.913 0 00-.908.92c0 .507.406.918.908.918a.913.913 0 00.907-.919.913.913 0 00-.907-.92zm3.63-3.81a.913.913 0 00-.908.92c0 .508.406.92.907.92a.913.913 0 00.908-.92.913.913 0 00-.908-.92zm1.555-4.99a.913.913 0 00-.908.92c0 .507.407.918.908.918a.913.913 0 00.907-.919.913.913 0 00-.907-.92zM17.296 3.1a.913.913 0 00-.907.92c0 .508.406.92.907.92a.913.913 0 00.908-.92.913.913 0 00-.908-.92z' d='M13.05 15.513h3.08c.214 0 .389.177.389.394v1.82a1.704 1.704 0 011.296 1.661c0 .943-.755 1.708-1.685 1.708-.931 0-1.686-.765-1.686-1.708 0-.807.554-1.484 1.297-1.662v-1.425h-2.69v4.663a.395.395 0 01-.188.338l-2.69 1.641a.385.385 0 01-.405-.002l-4.926-3.086a.395.395 0 01-.185-.336V16.3L2.196 14.87A.395.395 0 012 14.555L2 14.528V9.406c0-.14.073-.27.192-.34l2.465-1.462V4.448c0-.129.062-.249.165-.322l.021-.014L9.77 1.058a.385.385 0 01.407 0l2.69 1.675a.395.395 0 01.185.336V7.6h3.856V5.683a1.704 1.704 0 01-1.296-1.662c0-.943.755-1.708 1.685-1.708.931 0 1.685.765 1.685 1.708 0 .807-.553 1.484-1.296 1.662v2.311a.391.391 0 01-.389.394h-4.245v1.806h6.624a1.69 1.69 0 011.64-1.313c.93 0 1.685.764 1.685 1.707 0 .943-.754 1.708-1.685 1.708a1.69 1.69 0 01-1.64-1.314H13.05v1.937h4.953l.915 1.18a1.66 1.66 0 01.84-.227c.931 0 1.685.764 1.685 1.707 0 .943-.754 1.708-1.685 1.708-.93 0-1.685-.765-1.685-1.708 0-.346.102-.668.276-.937l-.724-.935H13.05v1.806zM9.973 1.856L7.93 3.122V6.09h-.778V3.604L5.435 4.669v2.945l2.11 1.36L9.712 7.61V5.334h.778V7.83c0 .136-.07.263-.184.335L7.963 9.638v2.081l1.422 1.009-.446.646-1.406-.998-1.53 1.005-.423-.66 1.605-1.055v-1.99L5.038 8.29l-2.26 1.34v1.676l1.972-1.189.398.677-2.37 1.429V14.3l2.166 1.258 2.27-1.368.397.677-2.176 1.311V19.3l1.876 1.175 2.365-1.426.398.678-2.017 1.216 1.918 1.201 2.298-1.403v-5.78l-4.758 2.893-.4-.675 5.158-3.136V3.289L9.972 1.856zM16.13 18.47a.913.913 0 00-.908.92c0 .507.406.918.908.918a.913.913 0 00.907-.919.913.913 0 00-.907-.92zm3.63-3.81a.913.913 0 00-.908.92c0 .508.406.92.907.92a.913.913 0 00.908-.92.913.913 0 00-.908-.92zm1.555-4.99a.913.913 0 00-.908.92c0 .507.407.918.908.918a.913.913 0 00.907-.919.913.913 0 00-.907-.92zM17.296 3.1a.913.913 0 00-.907.92c0 .508.406.92.907.92a.913.913 0 00.908-.92.913.913 0 00-.908-.92z'
fill={`url(#${gradientId})`} fill='url(#bedrock_gradient)'
fillRule='nonzero' fillRule='nonzero'
/> />
</svg> </svg>
@@ -5113,60 +5041,3 @@ export function PulseIcon(props: SVGProps<SVGSVGElement>) {
</svg> </svg>
) )
} }
export function SimilarwebIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg
{...props}
role='img'
viewBox='0 0 24 24'
xmlns='http://www.w3.org/2000/svg'
height='24'
width='24'
>
<path
d='M22.099 5.781c-1.283 -2 -3.14 -3.67 -5.27 -4.52l-0.63 -0.213a7.433 7.433 0 0 0 -2.15 -0.331c-2.307 0.01 -4.175 1.92 -4.175 4.275a4.3 4.3 0 0 0 0.867 2.602l-0.26 -0.342c0.124 0.186 0.26 0.37 0.417 0.556 0.663 0.802 1.604 1.635 2.822 2.58 2.999 2.32 4.943 4.378 5.104 6.93 0.038 0.344 0.062 0.696 0.062 1.051 0 1.297 -0.283 2.67 -0.764 3.635h0.005s-0.207 0.377 -0.077 0.487c0.066 0.057 0.21 0.1 0.46 -0.053a12.104 12.104 0 0 0 3.4 -3.33 12.111 12.111 0 0 0 2.088 -6.635 12.098 12.098 0 0 0 -1.9 -6.692zm-9.096 8.718 -1.878 -1.55c-3.934 -2.87 -5.98 -5.966 -4.859 -9.783a8.73 8.73 0 0 1 0.37 -1.016v-0.004s0.278 -0.583 -0.327 -0.295a12.067 12.067 0 0 0 -6.292 9.975 12.11 12.11 0 0 0 2.053 7.421 9.394 9.394 0 0 0 2.154 2.168H4.22c4.148 3.053 7.706 1.446 7.706 1.446h0.003a4.847 4.847 0 0 0 2.962 -4.492 4.855 4.855 0 0 0 -1.889 -3.87z'
fill='currentColor'
/>
</svg>
)
}
export function CalComIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg
{...props}
width='101'
height='22'
viewBox='0 0 101 22'
fill='currentColor'
xmlns='http://www.w3.org/2000/svg'
>
<path
d='M10.0582 20.817C4.32115 20.817 0 16.2763 0 10.6704C0 5.04589 4.1005 0.467773 10.0582 0.467773C13.2209 0.467773 15.409 1.43945 17.1191 3.66311L14.3609 5.96151C13.2025 4.72822 11.805 4.11158 10.0582 4.11158C6.17833 4.11158 4.04533 7.08268 4.04533 10.6704C4.04533 14.2582 6.38059 17.1732 10.0582 17.1732C11.7866 17.1732 13.2577 16.5566 14.4161 15.3233L17.1375 17.7151C15.501 19.8453 13.2577 20.817 10.0582 20.817Z'
fill='#292929'
/>
<path
d='M29.0161 5.88601H32.7304V20.4612H29.0161V18.331C28.2438 19.8446 26.9566 20.8536 24.4927 20.8536C20.5577 20.8536 17.4133 17.4341 17.4133 13.2297C17.4133 9.02528 20.5577 5.60571 24.4927 5.60571C26.9383 5.60571 28.2438 6.61477 29.0161 8.12835V5.88601ZM29.1264 13.2297C29.1264 10.95 27.5634 9.06266 25.0995 9.06266C22.7274 9.06266 21.1828 10.9686 21.1828 13.2297C21.1828 15.4346 22.7274 17.3967 25.0995 17.3967C27.5451 17.3967 29.1264 15.4907 29.1264 13.2297Z'
fill='#292929'
/>
<path d='M35.3599 0H39.0742V20.4427H35.3599V0Z' fill='#292929' />
<path
d='M40.7291 18.5182C40.7291 17.3223 41.6853 16.3132 42.9908 16.3132C44.2964 16.3132 45.2158 17.3223 45.2158 18.5182C45.2158 19.7515 44.278 20.7605 42.9908 20.7605C41.7037 20.7605 40.7291 19.7515 40.7291 18.5182Z'
fill='#292929'
/>
<path
d='M59.4296 18.1068C58.0505 19.7885 55.9543 20.8536 53.4719 20.8536C49.0404 20.8536 45.7858 17.4341 45.7858 13.2297C45.7858 9.02528 49.0404 5.60571 53.4719 5.60571C55.8623 5.60571 57.9402 6.61477 59.3193 8.20309L56.4508 10.6136C55.7336 9.71667 54.7958 9.04397 53.4719 9.04397C51.0999 9.04397 49.5553 10.95 49.5553 13.211C49.5553 15.472 51.0999 17.378 53.4719 17.378C54.9062 17.378 55.8991 16.6306 56.6346 15.6215L59.4296 18.1068Z'
fill='#292929'
/>
<path
d='M59.7422 13.2297C59.7422 9.02528 62.9968 5.60571 67.4283 5.60571C71.8598 5.60571 75.1144 9.02528 75.1144 13.2297C75.1144 17.4341 71.8598 20.8536 67.4283 20.8536C62.9968 20.8349 59.7422 17.4341 59.7422 13.2297ZM71.3449 13.2297C71.3449 10.95 69.8003 9.06266 67.4283 9.06266C65.0563 9.04397 63.5117 10.95 63.5117 13.2297C63.5117 15.4907 65.0563 17.3967 67.4283 17.3967C69.8003 17.3967 71.3449 15.4907 71.3449 13.2297Z'
fill='#292929'
/>
<path
d='M100.232 11.5482V20.4428H96.518V12.4638C96.518 9.94119 95.3412 8.85739 93.576 8.85739C91.921 8.85739 90.7442 9.67958 90.7442 12.4638V20.4428H87.0299V12.4638C87.0299 9.94119 85.8346 8.85739 84.0878 8.85739C82.4329 8.85739 80.9802 9.67958 80.9802 12.4638V20.4428H77.2659V5.8676H80.9802V7.88571C81.7525 6.31607 83.15 5.53125 85.3014 5.53125C87.3425 5.53125 89.0525 6.5403 89.9903 8.24074C90.9281 6.50293 92.3072 5.53125 94.8079 5.53125C97.8603 5.54994 100.232 7.86702 100.232 11.5482Z'
fill='#292929'
/>
</svg>
)
}

View File

@@ -8,7 +8,13 @@ import { ThemeToggle } from '@/components/ui/theme-toggle'
export function Navbar() { export function Navbar() {
return ( return (
<nav className='sticky top-0 z-50 border-border/50 border-b bg-background/80 backdrop-blur-md backdrop-saturate-150'> <nav
className='sticky top-0 z-50 border-border/50 border-b'
style={{
backdropFilter: 'blur(25px) saturate(180%)',
WebkitBackdropFilter: 'blur(25px) saturate(180%)',
}}
>
{/* Desktop: Single row layout */} {/* Desktop: Single row layout */}
<div className='hidden h-16 w-full items-center lg:flex'> <div className='hidden h-16 w-full items-center lg:flex'>
<div <div

View File

@@ -1,13 +1,45 @@
'use client' 'use client'
import { useState } from 'react'
import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button' import { useCopyButton } from 'fumadocs-ui/utils/use-copy-button'
import { Check, Copy } from 'lucide-react' import { Check, Copy } from 'lucide-react'
export function LLMCopyButton({ content }: { content: string }) { const cache = new Map<string, string>()
const [checked, onClick] = useCopyButton(() => navigator.clipboard.writeText(content))
export function LLMCopyButton({
markdownUrl,
}: {
/**
* A URL to fetch the raw Markdown/MDX content of page
*/
markdownUrl: string
}) {
const [isLoading, setLoading] = useState(false)
const [checked, onClick] = useCopyButton(async () => {
const cached = cache.get(markdownUrl)
if (cached) return navigator.clipboard.writeText(cached)
setLoading(true)
try {
await navigator.clipboard.write([
new ClipboardItem({
'text/plain': fetch(markdownUrl).then(async (res) => {
const content = await res.text()
cache.set(markdownUrl, content)
return content
}),
}),
])
} finally {
setLoading(false)
}
})
return ( return (
<button <button
disabled={isLoading}
onClick={onClick} onClick={onClick}
className='flex cursor-pointer items-center gap-1.5 rounded-lg border border-border/40 bg-background px-2.5 py-2 text-muted-foreground/60 text-sm leading-none transition-all hover:border-border hover:bg-accent/50 hover:text-muted-foreground' className='flex cursor-pointer items-center gap-1.5 rounded-lg border border-border/40 bg-background px-2.5 py-2 text-muted-foreground/60 text-sm leading-none transition-all hover:border-border hover:bg-accent/50 hover:text-muted-foreground'
aria-label={checked ? 'Copied to clipboard' : 'Copy page content'} aria-label={checked ? 'Copied to clipboard' : 'Copy page content'}

View File

@@ -17,16 +17,23 @@ export function CodeBlock(props: React.ComponentProps<typeof FumadocsCodeBlock>)
return ( return (
<FumadocsCodeBlock <FumadocsCodeBlock
{...props} {...props}
Actions={({ className }) => ( Actions={({ children, className }) => (
<div className={cn('empty:hidden', className)}> <div className={cn('empty:hidden', className)}>
{/* Custom copy button */}
<button <button
type='button' type='button'
aria-label={copied ? 'Copied Text' : 'Copy Text'} aria-label={copied ? 'Copied Text' : 'Copy Text'}
onClick={(e) => { onClick={(e) => {
const pre = (e.currentTarget as HTMLElement).closest('figure')?.querySelector('pre') const pre = (e.currentTarget as HTMLElement)
.closest('.nd-codeblock')
?.querySelector('pre')
if (pre) handleCopy(pre.textContent || '') if (pre) handleCopy(pre.textContent || '')
}} }}
className='cursor-pointer rounded-md p-2 text-muted-foreground transition-colors hover:text-foreground' className={cn(
'cursor-pointer rounded-md p-2 transition-all',
'border border-border bg-background/80 hover:bg-muted',
'backdrop-blur-sm'
)}
> >
<span className='flex items-center justify-center'> <span className='flex items-center justify-center'>
{copied ? ( {copied ? (

View File

@@ -13,11 +13,9 @@ import {
AsanaIcon, AsanaIcon,
BrainIcon, BrainIcon,
BrowserUseIcon, BrowserUseIcon,
CalComIcon,
CalendlyIcon, CalendlyIcon,
CirclebackIcon, CirclebackIcon,
ClayIcon, ClayIcon,
ClerkIcon,
ConfluenceIcon, ConfluenceIcon,
CursorIcon, CursorIcon,
DatadogIcon, DatadogIcon,
@@ -101,7 +99,6 @@ import {
ServiceNowIcon, ServiceNowIcon,
SftpIcon, SftpIcon,
ShopifyIcon, ShopifyIcon,
SimilarwebIcon,
SlackIcon, SlackIcon,
SmtpIcon, SmtpIcon,
SQSIcon, SQSIcon,
@@ -143,11 +140,9 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
arxiv: ArxivIcon, arxiv: ArxivIcon,
asana: AsanaIcon, asana: AsanaIcon,
browser_use: BrowserUseIcon, browser_use: BrowserUseIcon,
calcom: CalComIcon,
calendly: CalendlyIcon, calendly: CalendlyIcon,
circleback: CirclebackIcon, circleback: CirclebackIcon,
clay: ClayIcon, clay: ClayIcon,
clerk: ClerkIcon,
confluence_v2: ConfluenceIcon, confluence_v2: ConfluenceIcon,
cursor_v2: CursorIcon, cursor_v2: CursorIcon,
datadog: DatadogIcon, datadog: DatadogIcon,
@@ -231,7 +226,6 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
sftp: SftpIcon, sftp: SftpIcon,
sharepoint: MicrosoftSharepointIcon, sharepoint: MicrosoftSharepointIcon,
shopify: ShopifyIcon, shopify: ShopifyIcon,
similarweb: SimilarwebIcon,
slack: SlackIcon, slack: SlackIcon,
smtp: SmtpIcon, smtp: SmtpIcon,
sqs: SQSIcon, sqs: SQSIcon,

View File

@@ -58,7 +58,7 @@ Controls response randomness and creativity:
### Max Output Tokens ### Max Output Tokens
Controls the maximum length of the model's response. For Anthropic models, Sim uses reliable defaults: streaming executions use the model's full capacity (e.g. 64,000 tokens for Claude 4.5), while non-streaming executions default to 8,192 to avoid timeout issues. When using tools with Anthropic models, intermediate tool-calling requests use a capped limit of 8,192 tokens to avoid SDK timeout errors, regardless of your configured max tokens—the final streaming response uses your full configured limit. This only affects Anthropic's direct API; AWS Bedrock handles this automatically. For long-form content generation via API, explicitly set a higher value. Controls the maximum length of the model's response. For Anthropic models, Sim uses reliable defaults: streaming executions use the model's full capacity (e.g. 64,000 tokens for Claude 4.5), while non-streaming executions default to 8,192 to avoid timeout issues. For long-form content generation via API, explicitly set a higher value.
### API Key ### API Key

View File

@@ -280,24 +280,14 @@ A quick lookup for everyday actions in the Sim workflow editor. For keyboard sho
<td>Click clear button in Chat panel</td> <td>Click clear button in Chat panel</td>
<td><ActionImage src="/static/quick-reference/clear-chat.png" alt="Clear chat history" /></td> <td><ActionImage src="/static/quick-reference/clear-chat.png" alt="Clear chat history" /></td>
</tr> </tr>
<tr>
<td>Run from block</td>
<td>Hover block → Click play button, or right-click → **Run from block**</td>
<td><ActionImage src="/static/quick-reference/run-from-block.png" alt="Run from block" /></td>
</tr>
<tr>
<td>Run until block</td>
<td>Right-click block → **Run until block**</td>
<td><ActionImage src="/static/quick-reference/run-until-block.png" alt="Run until block" /></td>
</tr>
<tr> <tr>
<td>View execution logs</td> <td>View execution logs</td>
<td>Open terminal panel at bottom, or `Mod+L`</td> <td>Open terminal panel at bottom, or `Mod+L`</td>
<td><ActionImage src="/static/quick-reference/terminal.png" alt="Execution logs terminal" /></td> <td><ActionImage src="/static/quick-reference/terminal.png" alt="Execution logs terminal" /></td>
</tr> </tr>
<tr> <tr>
<td>Filter logs</td> <td>Filter logs by block or status</td>
<td>Click filter icon in terminal Filter by block or status</td> <td>Click block filter in terminal or right-click log entry → **Filter by Block** or **Filter by Status**</td>
<td><ActionImage src="/static/quick-reference/filter-block.png" alt="Filter logs by block" /></td> <td><ActionImage src="/static/quick-reference/filter-block.png" alt="Filter logs by block" /></td>
</tr> </tr>
<tr> <tr>
@@ -345,11 +335,6 @@ A quick lookup for everyday actions in the Sim workflow editor. For keyboard sho
<td>Access previous versions in Deploy tab → **Promote to live**</td> <td>Access previous versions in Deploy tab → **Promote to live**</td>
<td><ActionImage src="/static/quick-reference/promote-deployment.png" alt="Promote deployment to live" /></td> <td><ActionImage src="/static/quick-reference/promote-deployment.png" alt="Promote deployment to live" /></td>
</tr> </tr>
<tr>
<td>Add version description</td>
<td>Deploy tab → Click description icon → Add or generate description</td>
<td><ActionVideo src="quick-reference/deployment-description.mp4" alt="Add deployment version description" /></td>
</tr>
<tr> <tr>
<td>Copy API endpoint</td> <td>Copy API endpoint</td>
<td>Deploy tab → API → Copy API cURL</td> <td>Deploy tab → API → Copy API cURL</td>

View File

@@ -52,12 +52,12 @@ Send a message to an external A2A-compatible agent.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `content` | string | Text response content from the agent | | `content` | string | The text response from the agent |
| `taskId` | string | Unique task identifier | | `taskId` | string | Task ID for follow-up interactions |
| `contextId` | string | Groups related tasks/messages | | `contextId` | string | Context ID for conversation continuity |
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | | `state` | string | Task state |
| `artifacts` | array | Task output artifacts | | `artifacts` | array | Structured output artifacts |
| `history` | array | Conversation history \(Message array\) | | `history` | array | Full message history |
### `a2a_get_task` ### `a2a_get_task`
@@ -76,11 +76,11 @@ Query the status of an existing A2A task.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `taskId` | string | Unique task identifier | | `taskId` | string | Task ID |
| `contextId` | string | Groups related tasks/messages | | `contextId` | string | Context ID |
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | | `state` | string | Task state |
| `artifacts` | array | Task output artifacts | | `artifacts` | array | Output artifacts |
| `history` | array | Conversation history \(Message array\) | | `history` | array | Message history |
### `a2a_cancel_task` ### `a2a_cancel_task`
@@ -99,7 +99,7 @@ Cancel a running A2A task.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `cancelled` | boolean | Whether cancellation was successful | | `cancelled` | boolean | Whether cancellation was successful |
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | | `state` | string | Task state after cancellation |
### `a2a_get_agent_card` ### `a2a_get_agent_card`
@@ -116,15 +116,14 @@ Fetch the Agent Card (discovery document) for an A2A agent.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `name` | string | Agent display name | | `name` | string | Agent name |
| `description` | string | Agent purpose/capabilities | | `description` | string | Agent description |
| `url` | string | Service endpoint URL | | `url` | string | Agent endpoint URL |
| `provider` | object | Creator organization details | | `version` | string | Agent version |
| `capabilities` | object | Feature support matrix | | `capabilities` | object | Agent capabilities \(streaming, pushNotifications, etc.\) |
| `skills` | array | Available operations | | `skills` | array | Skills the agent can perform |
| `version` | string | A2A protocol version supported by the agent | | `defaultInputModes` | array | Default input modes \(text, file, data\) |
| `defaultInputModes` | array | Default input content types accepted by the agent | | `defaultOutputModes` | array | Default output modes \(text, file, data\) |
| `defaultOutputModes` | array | Default output content types produced by the agent |
### `a2a_resubscribe` ### `a2a_resubscribe`
@@ -142,12 +141,12 @@ Reconnect to an ongoing A2A task stream after connection interruption.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `taskId` | string | Unique task identifier | | `taskId` | string | Task ID |
| `contextId` | string | Groups related tasks/messages | | `contextId` | string | Context ID |
| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | | `state` | string | Current task state |
| `isRunning` | boolean | Whether the task is still running | | `isRunning` | boolean | Whether the task is still running |
| `artifacts` | array | Task output artifacts | | `artifacts` | array | Output artifacts |
| `history` | array | Conversation history \(Message array\) | | `history` | array | Message history |
### `a2a_set_push_notification` ### `a2a_set_push_notification`
@@ -167,9 +166,9 @@ Configure a webhook to receive task update notifications.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `url` | string | HTTPS webhook URL for notifications | | `url` | string | Configured webhook URL |
| `token` | string | Authentication token for webhook validation | | `token` | string | Token for webhook validation |
| `success` | boolean | Whether the operation was successful | | `success` | boolean | Whether configuration was successful |
### `a2a_get_push_notification` ### `a2a_get_push_notification`
@@ -187,8 +186,9 @@ Get the push notification webhook configuration for a task.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `token` | string | Authentication token for webhook validation | | `url` | string | Configured webhook URL |
| `exists` | boolean | Whether the resource exists | | `token` | string | Token for webhook validation |
| `exists` | boolean | Whether a push notification config exists |
### `a2a_delete_push_notification` ### `a2a_delete_push_notification`
@@ -207,6 +207,6 @@ Delete the push notification webhook configuration for a task.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Whether the operation was successful | | `success` | boolean | Whether deletion was successful |

View File

@@ -60,11 +60,11 @@ Get a list of backlinks pointing to a target domain or URL. Returns details abou
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `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\). Example: "domain" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | | `limit` | number | No | Maximum number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `offset` | number | No | Number of results to skip for pagination |
| `apiKey` | string | Yes | Ahrefs API Key | | `apiKey` | string | Yes | Ahrefs API Key |
#### Output #### Output
@@ -88,8 +88,8 @@ Get backlink statistics for a target domain or URL. Returns totals for different
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `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\). Example: "domain" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
| `apiKey` | string | Yes | Ahrefs API Key | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `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\). Example: "domain" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | | `limit` | number | No | Maximum number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `offset` | number | No | Number of results to skip for pagination |
| `apiKey` | string | Yes | Ahrefs API Key | | `apiKey` | string | Yes | Ahrefs API Key |
#### Output #### Output
@@ -140,12 +140,12 @@ Get organic keywords that a target domain or URL ranks for in Google search resu
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `target` | string | Yes | The target domain or URL to analyze |
| `country` | string | No | Country code for search results. Example: "us", "gb", "de" \(default: "us"\) | | `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\). Example: "domain" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | | `limit` | number | No | Maximum number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `offset` | number | No | Number of results to skip for pagination |
| `apiKey` | string | Yes | Ahrefs API Key | | `apiKey` | string | Yes | Ahrefs API Key |
#### Output #### Output
@@ -168,12 +168,12 @@ Get the top pages of a target domain sorted by organic traffic. Returns page URL
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `target` | string | Yes | The target domain to analyze. Example: "example.com" | | `target` | string | Yes | The target domain to analyze |
| `country` | string | No | Country code for traffic data. Example: "us", "gb", "de" \(default: "us"\) | | `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\). Example: "domain" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\) |
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | | `limit` | number | No | Maximum number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `offset` | number | No | Number of results to skip for pagination |
| `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 | | `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 | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyword` | string | Yes | The keyword to analyze | | `keyword` | string | Yes | The keyword to analyze |
| `country` | string | No | Country code for keyword data. Example: "us", "gb", "de" \(default: "us"\) | | `country` | string | No | Country code for keyword data \(e.g., us, gb, de\). Default: us |
| `apiKey` | string | Yes | Ahrefs API Key | | `apiKey` | string | Yes | Ahrefs API Key |
#### Output #### 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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `target` | string | Yes | The target domain or URL to analyze. Example: "example.com" or "https://example.com/page" | | `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\). Example: "domain" | | `mode` | string | No | Analysis mode: domain \(entire domain\), prefix \(URL prefix\), subdomains \(include all subdomains\), exact \(exact URL match\) |
| `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) | | `date` | string | No | Date for historical data in YYYY-MM-DD format \(defaults to today\) |
| `limit` | number | No | Maximum number of results to return. Example: 50 \(default: 100\) | | `limit` | number | No | Maximum number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination. Example: 100 | | `offset` | number | No | Number of results to skip for pagination |
| `apiKey` | string | Yes | Ahrefs API Key | | `apiKey` | string | Yes | Ahrefs API Key |
#### Output #### Output

View File

@@ -40,9 +40,9 @@ Read records from an Airtable table
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | | `baseId` | string | Yes | ID of the Airtable base |
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `tableId` | string | Yes | ID of the table |
| `maxRecords` | number | No | Maximum number of records to return \(default: all records\) | | `maxRecords` | number | No | Maximum number of records to return |
| `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) | | `filterFormula` | string | No | Formula to filter records \(e.g., "\(\{Field Name\} = \'Value\'\)"\) |
#### Output #### Output
@@ -60,9 +60,9 @@ Retrieve a single record from an Airtable table by its ID
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | | `baseId` | string | Yes | ID of the Airtable base |
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `tableId` | string | Yes | ID or name of the table |
| `recordId` | string | Yes | Record ID to retrieve \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) | | `recordId` | string | Yes | ID of the record to retrieve |
#### Output #### Output
@@ -79,8 +79,8 @@ Write new records to an Airtable table
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | | `baseId` | string | Yes | ID of the Airtable base |
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `tableId` | string | Yes | ID or name of the table |
| `records` | json | Yes | Array of records to create, each with a `fields` object | | `records` | json | Yes | Array of records to create, each with a `fields` object |
| `fields` | string | No | No description | | `fields` | string | No | No description |
@@ -99,9 +99,9 @@ Update an existing record in an Airtable table by ID
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | | `baseId` | string | Yes | ID of the Airtable base |
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `tableId` | string | Yes | ID or name of the table |
| `recordId` | string | Yes | Record ID to update \(starts with "rec", e.g., "recXXXXXXXXXXXXXX"\) | | `recordId` | string | Yes | ID of the record to update |
| `fields` | json | Yes | An object containing the field names and their new values | | `fields` | json | Yes | An object containing the field names and their new values |
#### Output #### Output
@@ -119,8 +119,8 @@ Update multiple existing records in an Airtable table
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `baseId` | string | Yes | Airtable base ID \(starts with "app", e.g., "appXXXXXXXXXXXXXX"\) | | `baseId` | string | Yes | ID of the Airtable base |
| `tableId` | string | Yes | Table ID \(starts with "tbl"\) or table name | | `tableId` | string | Yes | ID or name of the table |
| `records` | json | Yes | Array of records to update, each with an `id` and a `fields` object | | `records` | json | Yes | Array of records to update, each with an `id` and a `fields` object |
#### Output #### Output

View File

@@ -45,12 +45,10 @@ Run an APIFY actor synchronously and get results (max 5 minutes)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" | | `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. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} | | `input` | string | No | Actor input as JSON string. See actor documentation for required fields. |
| `Example` | string | No | No description | | `timeout` | number | No | Timeout in seconds \(default: actor default\) |
| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB | | `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
| `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 #### Output
@@ -70,14 +68,12 @@ Run an APIFY actor asynchronously with polling for long-running tasks
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations | | `apiKey` | string | Yes | APIFY API token from console.apify.com/account#/integrations |
| `actorId` | string | Yes | Actor ID or username/actor-name. Examples: "apify/web-scraper", "janedoe/my-actor", "moJRLRc85AitArpNN" | | `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. Example: \{"startUrls": \[\{"url": "https://example.com"\}\], "maxPages": 10\} | | `input` | string | No | Actor input as JSON string |
| `Example` | string | No | No description | | `waitForFinish` | number | No | Initial wait time in seconds \(0-60\) before polling starts |
| `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\) |
| `itemLimit` | number | No | Max dataset items to fetch \(1-250000\). Default: 100. Example: 500 | | `timeout` | number | No | Timeout in seconds \(default: actor default\) |
| `memory` | number | No | Memory in megabytes allocated for the actor run \(128-32768\). Example: 1024 for 1GB, 2048 for 2GB | | `build` | string | No | Actor build to run \(e.g., "latest", "beta", or build tag/number\) |
| `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 #### Output

View File

@@ -53,8 +53,8 @@ Search Apollo
| `person_seniorities` | array | No | Seniority levels \(e.g., \["senior", "executive", "manager"\]\) | | `person_seniorities` | array | No | Seniority levels \(e.g., \["senior", "executive", "manager"\]\) |
| `organization_names` | array | No | Company names to search within | | `organization_names` | array | No | Company names to search within |
| `q_keywords` | string | No | Keywords to search for | | `q_keywords` | string | No | Keywords to search for |
| `page` | number | No | Page number for pagination, default 1 \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination \(default: 1\) |
| `per_page` | number | No | Results per page, default 25, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(default: 25, max: 100\) |
#### Output #### Output
@@ -78,7 +78,7 @@ Enrich data for a single person using Apollo
| `last_name` | string | No | Last name of the person | | `last_name` | string | No | Last name of the person |
| `email` | string | No | Email address of the person | | `email` | string | No | Email address of the person |
| `organization_name` | string | No | Company name where the person works | | `organization_name` | string | No | Company name where the person works |
| `domain` | string | No | Company domain \(e.g., "apollo.io", "acme.com"\) | | `domain` | string | No | Company domain \(e.g., apollo.io\) |
| `linkedin_url` | string | No | LinkedIn profile URL | | `linkedin_url` | string | No | LinkedIn profile URL |
| `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) | | `reveal_personal_emails` | boolean | No | Reveal personal email addresses \(uses credits\) |
| `reveal_phone_number` | boolean | No | Reveal phone numbers \(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_locations` | array | No | Company locations to search |
| `organization_num_employees_ranges` | array | No | Employee count ranges \(e.g., \["1-10", "11-50"\]\) | | `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_keyword_tags` | array | No | Industry or keyword tags |
| `q_organization_name` | string | No | Organization name to search for \(e.g., "Acme", "TechCorp"\) | | `q_organization_name` | string | No | Organization name to search for |
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination |
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(max: 100\) |
#### Output #### Output
@@ -145,8 +145,8 @@ Enrich data for a single organization using Apollo
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `organization_name` | string | No | Name of the organization \(e.g., "Acme Corporation"\) - at least one of organization_name or domain is required | | `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", "acme.com"\) - at least one of domain or organization_name is required | | `domain` | string | No | Company domain \(e.g., apollo.io\) \(at least one of domain or organization_name is required\) |
#### Output #### Output
@@ -186,8 +186,8 @@ Create a new contact in your Apollo database
| `first_name` | string | Yes | First name of the contact | | `first_name` | string | Yes | First name of the contact |
| `last_name` | string | Yes | Last name of the contact | | `last_name` | string | Yes | Last name of the contact |
| `email` | string | No | Email address of the contact | | `email` | string | No | Email address of the contact |
| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) | | `title` | string | No | Job title |
| `account_id` | string | No | Apollo account ID to associate with \(e.g., "acc_abc123"\) | | `account_id` | string | No | Apollo account ID to associate with |
| `owner_id` | string | No | User ID of the contact owner | | `owner_id` | string | No | User ID of the contact owner |
#### Output #### Output
@@ -206,12 +206,12 @@ Update an existing contact in your Apollo database
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `contact_id` | string | Yes | ID of the contact to update \(e.g., "con_abc123"\) | | `contact_id` | string | Yes | ID of the contact to update |
| `first_name` | string | No | First name of the contact | | `first_name` | string | No | First name of the contact |
| `last_name` | string | No | Last name of the contact | | `last_name` | string | No | Last name of the contact |
| `email` | string | No | Email address | | `email` | string | No | Email address |
| `title` | string | No | Job title \(e.g., "VP of Sales", "Software Engineer"\) | | `title` | string | No | Job title |
| `account_id` | string | No | Apollo account ID \(e.g., "acc_abc123"\) | | `account_id` | string | No | Apollo account ID |
| `owner_id` | string | No | User ID of the contact owner | | `owner_id` | string | No | User ID of the contact owner |
#### Output #### Output
@@ -232,8 +232,8 @@ Search your team
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `q_keywords` | string | No | Keywords to search for | | `q_keywords` | string | No | Keywords to search for |
| `contact_stage_ids` | array | No | Filter by contact stage IDs | | `contact_stage_ids` | array | No | Filter by contact stage IDs |
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination |
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(max: 100\) |
#### Output #### Output
@@ -294,7 +294,7 @@ Create a new account (company) in your Apollo database
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `name` | string | Yes | Company name \(e.g., "Acme Corporation"\) | | `name` | string | Yes | Company name |
| `website_url` | string | No | Company website URL | | `website_url` | string | No | Company website URL |
| `phone` | string | No | Company phone number | | `phone` | string | No | Company phone number |
| `owner_id` | string | No | User ID of the account owner | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `account_id` | string | Yes | ID of the account to update \(e.g., "acc_abc123"\) | | `account_id` | string | Yes | ID of the account to update |
| `name` | string | No | Company name \(e.g., "Acme Corporation"\) | | `name` | string | No | Company name |
| `website_url` | string | No | Company website URL | | `website_url` | string | No | Company website URL |
| `phone` | string | No | Company phone number | | `phone` | string | No | Company phone number |
| `owner_id` | string | No | User ID of the account owner | | `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 | | `q_keywords` | string | No | Keywords to search for in account data |
| `owner_id` | string | No | Filter by account owner user ID | | `owner_id` | string | No | Filter by account owner user ID |
| `account_stage_ids` | array | No | Filter by account stage IDs | | `account_stage_ids` | array | No | Filter by account stage IDs |
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination |
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(max: 100\) |
#### Output #### Output
@@ -401,8 +401,8 @@ Create a new deal for an account in your Apollo database (master key required)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `apiKey` | string | Yes | Apollo API key \(master key required\) |
| `name` | string | Yes | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) | | `name` | string | Yes | Name of the opportunity/deal |
| `account_id` | string | Yes | ID of the account this opportunity belongs to \(e.g., "acc_abc123"\) | | `account_id` | string | Yes | ID of the account this opportunity belongs to |
| `amount` | number | No | Monetary value of the opportunity | | `amount` | number | No | Monetary value of the opportunity |
| `stage_id` | string | No | ID of the deal stage | | `stage_id` | string | No | ID of the deal stage |
| `owner_id` | string | No | User ID of the opportunity owner | | `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 | | `apiKey` | string | Yes | Apollo API key |
| `q_keywords` | string | No | Keywords to search for in opportunity names | | `q_keywords` | string | No | Keywords to search for in opportunity names |
| `account_ids` | array | No | Filter by specific account IDs \(e.g., \["acc_123", "acc_456"\]\) | | `account_ids` | array | No | Filter by specific account IDs |
| `stage_ids` | array | No | Filter by deal stage IDs | | `stage_ids` | array | No | Filter by deal stage IDs |
| `owner_ids` | array | No | Filter by opportunity owner IDs | | `owner_ids` | array | No | Filter by opportunity owner IDs |
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination |
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(max: 100\) |
#### Output #### Output
@@ -450,7 +450,7 @@ Retrieve complete details of a specific deal/opportunity by ID
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `opportunity_id` | string | Yes | ID of the opportunity to retrieve \(e.g., "opp_abc123"\) | | `opportunity_id` | string | Yes | ID of the opportunity to retrieve |
#### Output #### Output
@@ -468,8 +468,8 @@ Update an existing deal/opportunity in your Apollo database
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key | | `apiKey` | string | Yes | Apollo API key |
| `opportunity_id` | string | Yes | ID of the opportunity to update \(e.g., "opp_abc123"\) | | `opportunity_id` | string | Yes | ID of the opportunity to update |
| `name` | string | No | Name of the opportunity/deal \(e.g., "Enterprise License - Q1"\) | | `name` | string | No | Name of the opportunity/deal |
| `amount` | number | No | Monetary value of the opportunity | | `amount` | number | No | Monetary value of the opportunity |
| `stage_id` | string | No | ID of the deal stage | | `stage_id` | string | No | ID of the deal stage |
| `owner_id` | string | No | User ID of the opportunity owner | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `apiKey` | string | Yes | Apollo API key \(master key required\) |
| `q_name` | string | No | Search sequences by name \(e.g., "Outbound Q1", "Follow-up"\) | | `q_name` | string | No | Search sequences by name |
| `active` | boolean | No | Filter by active status \(true for active sequences, false for inactive\) | | `active` | boolean | No | Filter by active status \(true for active sequences, false for inactive\) |
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination |
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(max: 100\) |
#### Output #### Output
@@ -515,8 +515,8 @@ Add contacts to an Apollo sequence
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `apiKey` | string | Yes | Apollo API key \(master key required\) |
| `sequence_id` | string | Yes | ID of the sequence to add contacts to \(e.g., "seq_abc123"\) | | `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 \(e.g., \["con_abc123", "con_def456"\]\) | | `contact_ids` | array | Yes | Array of contact IDs to add to the sequence |
| `emailer_campaign_id` | string | No | Optional emailer campaign ID | | `emailer_campaign_id` | string | No | Optional emailer campaign ID |
| `send_email_from_user_id` | string | No | User ID to send emails from | | `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\) | | `apiKey` | string | Yes | Apollo API key \(master key required\) |
| `note` | string | Yes | Task note/description | | `note` | string | Yes | Task note/description |
| `contact_id` | string | No | Contact ID to associate with \(e.g., "con_abc123"\) | | `contact_id` | string | No | Contact ID to associate with |
| `account_id` | string | No | Account ID to associate with \(e.g., "acc_abc123"\) | | `account_id` | string | No | Account ID to associate with |
| `due_at` | string | No | Due date in ISO format | | `due_at` | string | No | Due date in ISO format |
| `priority` | string | No | Task priority | | `priority` | string | No | Task priority |
| `type` | string | No | Task type | | `type` | string | No | Task type |
@@ -560,11 +560,11 @@ Search for tasks in Apollo
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Apollo API key \(master key required\) | | `apiKey` | string | Yes | Apollo API key \(master key required\) |
| `contact_id` | string | No | Filter by contact ID \(e.g., "con_abc123"\) | | `contact_id` | string | No | Filter by contact ID |
| `account_id` | string | No | Filter by account ID \(e.g., "acc_abc123"\) | | `account_id` | string | No | Filter by account ID |
| `completed` | boolean | No | Filter by completion status | | `completed` | boolean | No | Filter by completion status |
| `page` | number | No | Page number for pagination \(e.g., 1, 2, 3\) | | `page` | number | No | Page number for pagination |
| `per_page` | number | No | Results per page, max 100 \(e.g., 25, 50, 100\) | | `per_page` | number | No | Results per page \(max: 100\) |
#### Output #### Output

View File

@@ -42,8 +42,8 @@ Retrieve a single task by GID or get multiple tasks with filters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskGid` | string | No | The globally unique identifier \(GID\) of the task. If not provided, will get multiple tasks. | | `taskGid` | string | No | The globally unique identifier \(GID\) of the task. If not provided, will get multiple tasks. |
| `workspace` | string | No | Asana workspace GID \(numeric string\) to filter tasks \(required when not using taskGid\) | | `workspace` | string | No | Workspace GID to filter tasks \(required when not using taskGid\) |
| `project` | string | No | Asana project GID \(numeric string\) to filter tasks | | `project` | string | No | Project GID to filter tasks |
| `limit` | number | No | Maximum number of tasks to return \(default: 50\) | | `limit` | number | No | Maximum number of tasks to return \(default: 50\) |
#### Output #### Output
@@ -80,7 +80,7 @@ Create a new task in Asana
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `workspace` | string | Yes | Asana workspace GID \(numeric string\) where the task will be created | | `workspace` | string | Yes | Workspace GID where the task will be created |
| `name` | string | Yes | Name of the task | | `name` | string | Yes | Name of the task |
| `notes` | string | No | Notes or description for the task | | `notes` | string | No | Notes or description for the task |
| `assignee` | string | No | User GID to assign the task to | | `assignee` | string | No | User GID to assign the task to |
@@ -107,7 +107,7 @@ Update an existing task in Asana
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskGid` | string | Yes | Asana task GID \(numeric string\) of the task to update | | `taskGid` | string | Yes | The globally unique identifier \(GID\) of the task to update |
| `name` | string | No | Updated name for the task | | `name` | string | No | Updated name for the task |
| `notes` | string | No | Updated notes or description for the task | | `notes` | string | No | Updated notes or description for the task |
| `assignee` | string | No | Updated assignee user GID | | `assignee` | string | No | Updated assignee user GID |
@@ -134,7 +134,7 @@ Retrieve all projects from an Asana workspace
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `workspace` | string | Yes | Asana workspace GID \(numeric string\) to retrieve projects from | | `workspace` | string | Yes | Workspace GID to retrieve projects from |
#### Output #### Output
@@ -155,10 +155,10 @@ Search for tasks in an Asana workspace
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `workspace` | string | Yes | Asana workspace GID \(numeric string\) to search tasks in | | `workspace` | string | Yes | Workspace GID to search tasks in |
| `text` | string | No | Text to search for in task names | | `text` | string | No | Text to search for in task names |
| `assignee` | string | No | Filter tasks by assignee user GID | | `assignee` | string | No | Filter tasks by assignee user GID |
| `projects` | array | No | Array of Asana project GIDs \(numeric strings\) to filter tasks by | | `projects` | array | No | Array of project GIDs to filter tasks by |
| `completed` | boolean | No | Filter by completion status | | `completed` | boolean | No | Filter by completion status |
#### Output #### Output
@@ -168,10 +168,10 @@ Search for tasks in an Asana workspace
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `ts` | string | Timestamp of the response | | `ts` | string | Timestamp of the response |
| `tasks` | array | Array of matching tasks | | `tasks` | array | Array of matching tasks |
| ↳ `gid` | string | Task GID | | ↳ `gid` | string | Assignee GID |
| ↳ `resource_type` | string | Resource type | | ↳ `resource_type` | string | Resource type |
| ↳ `resource_subtype` | string | Resource subtype | | ↳ `resource_subtype` | string | Resource subtype |
| ↳ `name` | string | Task name | | ↳ `name` | string | Assignee name |
| ↳ `notes` | string | Task notes | | ↳ `notes` | string | Task notes |
| ↳ `completed` | boolean | Completion status | | ↳ `completed` | boolean | Completion status |
| ↳ `assignee` | object | Assignee details | | ↳ `assignee` | object | Assignee details |
@@ -193,7 +193,7 @@ Add a comment (story) to an Asana task
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskGid` | string | Yes | Asana task GID \(numeric string\) | | `taskGid` | string | Yes | The globally unique identifier \(GID\) of the task |
| `text` | string | Yes | The text content of the comment | | `text` | string | Yes | The text content of the comment |
#### Output #### Output

View File

@@ -1,789 +0,0 @@
---
title: CalCom
description: Manage Cal.com bookings, event types, schedules, and availability
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="calcom"
color="#FFFFFE"
/>
{/* MANUAL-CONTENT-START:intro */}
[Cal.com](https://cal.com/) is a flexible and open-source scheduling platform that makes it easy to manage appointments, bookings, event types, and team availabilities.
With Cal.com, you can:
- **Automate scheduling**: Allow users to view your available time slots and book meetings automatically, without back-and-forth emails.
- **Manage events**: Create and customize event types, durations, and rules for one-on-one or group meetings.
- **Integrate calendars**: Seamlessly connect with Google, Outlook, Apple, or other calendar providers to avoid double bookings.
- **Handle attendees and guests**: Collect attendee information, manage guests, and send invitations or reminders.
- **Control availability**: Define custom working hours, buffer times, and cancellation/rebooking rules.
- **Power workflows**: Trigger custom actions via webhooks when a booking is created, cancelled, or rescheduled.
In Sim, the Cal.com integration enables your agents to book meetings, check availabilities, manage event types, and automate scheduling tasks programmatically. This helps agents coordinate meetings, send bookings on behalf of users, check schedules, or respond to booking events—all without manual intervention. By connecting Sim with Cal.com, you unlock highly automated and intelligent scheduling workflows that can integrate seamlessly with your broader automation needs.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Integrate Cal.com into your workflow. Create and manage bookings, event types, schedules, and check availability slots. Supports creating, listing, rescheduling, and canceling bookings, as well as managing event types and schedules. Can also trigger workflows based on Cal.com webhook events (booking created, cancelled, rescheduled). Connect your Cal.com account via OAuth.
## Tools
### `calcom_create_booking`
Create a new booking on Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | The ID of the event type to book |
| `start` | string | Yes | Start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) |
| `attendee` | object | Yes | Attendee information object with name, email, timeZone, and optional phoneNumber \(constructed from individual attendee fields\) |
| `guests` | array | No | Array of guest email addresses |
| `items` | string | No | Guest email address |
| `lengthInMinutes` | number | No | Duration of the booking in minutes \(overrides event type default\) |
| `metadata` | object | No | Custom metadata to attach to the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Created booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `absentHost` | boolean | Whether the host was absent |
| ↳ `guests` | array | Guest email addresses |
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `createdAt` | string | When the booking was created |
### `calcom_get_booking`
Get details of a specific booking by its UID
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `description` | string | Description of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `absentHost` | boolean | Whether the host was absent |
| ↳ `guests` | array | Guest email addresses |
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `rating` | number | Booking rating |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
| ↳ `rescheduledToUid` | string | New booking UID after reschedule |
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `updatedAt` | string | When the booking was last updated |
### `calcom_list_bookings`
List all bookings with optional status filter
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `status` | string | No | Filter bookings by status: upcoming, recurring, past, cancelled, or unconfirmed |
| `take` | number | No | Number of bookings to return \(pagination limit\) |
| `skip` | number | No | Number of bookings to skip \(pagination offset\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | array | Array of bookings |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `description` | string | Description of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `absentHost` | boolean | Whether the host was absent |
| ↳ `guests` | array | Guest email addresses |
| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `rating` | number | Booking rating |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
| ↳ `rescheduledToUid` | string | New booking UID after reschedule |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `updatedAt` | string | When the booking was last updated |
| `pagination` | object | Pagination metadata |
| ↳ `totalItems` | number | Total number of items |
| ↳ `remainingItems` | number | Remaining items after current page |
| ↳ `returnedItems` | number | Number of items returned in this response |
| ↳ `itemsPerPage` | number | Items per page |
| ↳ `currentPage` | number | Current page number |
| ↳ `totalPages` | number | Total number of pages |
| ↳ `hasNextPage` | boolean | Whether there is a next page |
| ↳ `hasPreviousPage` | boolean | Whether there is a previous page |
### `calcom_cancel_booking`
Cancel an existing booking
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to cancel |
| `cancellationReason` | string | No | Reason for cancelling the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Cancelled booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `location` | string | Location of the booking |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `status` | string | Booking status \(should be cancelled\) |
### `calcom_reschedule_booking`
Reschedule an existing booking to a new time
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to reschedule |
| `start` | string | Yes | New start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) |
| `reschedulingReason` | string | No | Reason for rescheduling the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Rescheduled booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `title` | string | Title of the booking |
| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) |
| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled |
| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled |
| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `guests` | array | Guest email addresses |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `uid` | string | Unique identifier for the new booking |
| ↳ `start` | string | New start time in ISO 8601 format |
| ↳ `end` | string | New end time in ISO 8601 format |
### `calcom_confirm_booking`
Confirm a pending booking that requires confirmation
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to confirm |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Confirmed booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `meetingUrl` | string | URL to join the meeting |
| ↳ `location` | string | Location of the booking |
| ↳ `guests` | array | Guest email addresses |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `icsUid` | string | ICS calendar UID |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `status` | string | Booking status \(should be accepted/confirmed\) |
### `calcom_decline_booking`
Decline a pending booking request
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to decline |
| `reason` | string | No | Reason for declining the booking |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Declined booking details |
| ↳ `eventType` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `slug` | string | Event type slug |
| ↳ `attendees` | array | List of attendees |
| ↳ `name` | string | Attendee name |
| ↳ `email` | string | Attendee actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `timeZone` | string | Attendee timezone \(IANA format\) |
| ↳ `phoneNumber` | string | Attendee phone number |
| ↳ `language` | string | Attendee language preference \(ISO code\) |
| ↳ `absent` | boolean | Whether attendee was absent |
| ↳ `hosts` | array | List of hosts |
| ↳ `id` | number | Host user ID |
| ↳ `name` | string | Host display name |
| ↳ `email` | string | Host actual email address |
| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) |
| ↳ `username` | string | Host Cal.com username |
| ↳ `timeZone` | string | Host timezone \(IANA format\) |
| ↳ `id` | number | Numeric booking ID |
| ↳ `uid` | string | Unique identifier for the booking |
| ↳ `title` | string | Title of the booking |
| ↳ `cancellationReason` | string | Reason for cancellation if cancelled |
| ↳ `start` | string | Start time in ISO 8601 format |
| ↳ `end` | string | End time in ISO 8601 format |
| ↳ `duration` | number | Duration in minutes |
| ↳ `eventTypeId` | number | Event type ID |
| ↳ `location` | string | Location of the booking |
| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) |
| ↳ `createdAt` | string | When the booking was created |
| ↳ `status` | string | Booking status \(should be cancelled/rejected\) |
### `calcom_create_event_type`
Create a new event type in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `title` | string | Yes | Title of the event type |
| `slug` | string | Yes | Unique slug for the event type URL |
| `lengthInMinutes` | number | Yes | Duration of the event in minutes |
| `description` | string | No | Description of the event type |
| `slotInterval` | number | No | Interval between available booking slots in minutes |
| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes |
| `beforeEventBuffer` | number | No | Buffer time before the event in minutes |
| `afterEventBuffer` | number | No | Buffer time after the event in minutes |
| `scheduleId` | number | No | ID of the schedule to use for availability |
| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Created event type details |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_get_event_type`
Get detailed information about a specific event type
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | Event type ID to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Event type details |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_list_event_types`
Retrieve a list of all event types
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `sortCreatedAt` | string | No | Sort by creation date: "asc" or "desc" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | array | Array of event types |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_update_event_type`
Update an existing event type in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `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 |
| `description` | string | No | Description of the event type |
| `slotInterval` | number | No | Interval between available booking slots in minutes |
| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes |
| `beforeEventBuffer` | number | No | Buffer time before the event in minutes |
| `afterEventBuffer` | number | No | Buffer time after the event in minutes |
| `scheduleId` | number | No | ID of the schedule to use for availability |
| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Updated event type details |
| ↳ `id` | number | Event type ID |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
| ↳ `description` | string | Event type description |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `slotInterval` | number | Slot interval in minutes |
| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes |
| ↳ `beforeEventBuffer` | number | Buffer before event in minutes |
| ↳ `afterEventBuffer` | number | Buffer after event in minutes |
| ↳ `scheduleId` | number | Schedule ID |
| ↳ `disableGuests` | boolean | Whether guests are disabled |
| ↳ `createdAt` | string | ISO timestamp of creation |
| ↳ `updatedAt` | string | ISO timestamp of last update |
### `calcom_delete_event_type`
Delete an event type from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `eventTypeId` | number | Yes | Event type ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Deleted event type details |
| ↳ `id` | number | Event type ID |
| ↳ `lengthInMinutes` | number | Duration in minutes |
| ↳ `title` | string | Event type title |
| ↳ `slug` | string | Event type slug |
### `calcom_create_schedule`
Create a new availability schedule in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `name` | string | Yes | Name of the schedule |
| `timeZone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) |
| `isDefault` | boolean | Yes | Whether this schedule should be the default |
| `availability` | array | No | Availability intervals for the schedule |
| `items` | object | No | Availability interval |
| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `startTime` | string | No | Start time in HH:MM format |
| `endTime` | string | No | End time in HH:MM format |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Created schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_get_schedule`
Get a specific schedule by ID from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `scheduleId` | string | Yes | ID of the schedule to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_list_schedules`
List all availability schedules from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | array | Array of schedule objects |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_update_schedule`
Update an existing schedule in Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `scheduleId` | string | Yes | ID of the schedule to update |
| `name` | string | No | New name for the schedule |
| `timeZone` | string | No | New timezone for the schedule \(e.g., America/New_York\) |
| `isDefault` | boolean | No | Whether this schedule should be the default |
| `availability` | array | No | New availability intervals for the schedule |
| `items` | object | No | Availability interval |
| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) |
| `startTime` | string | No | Start time in HH:MM format |
| `endTime` | string | No | End time in HH:MM format |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Updated schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_delete_schedule`
Delete a schedule from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `scheduleId` | string | Yes | ID of the schedule to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status \(success or error\) |
### `calcom_get_default_schedule`
Get the default availability schedule from Cal.com
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | object | Default schedule data |
| ↳ `id` | number | Schedule ID |
| ↳ `ownerId` | number | Owner user ID |
| ↳ `name` | string | Schedule name |
| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) |
| ↳ `isDefault` | boolean | Whether this is the default schedule |
| ↳ `availability` | array | Availability windows |
| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
| ↳ `overrides` | array | Date-specific availability overrides |
| ↳ `date` | string | Date in YYYY-MM-DD format |
| ↳ `startTime` | string | Start time in HH:MM format |
| ↳ `endTime` | string | End time in HH:MM format |
### `calcom_get_slots`
Get available booking slots for a Cal.com event type within a time range
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `start` | string | Yes | Start of time range in UTC ISO 8601 format \(e.g., 2024-01-15T00:00:00Z\) |
| `end` | string | Yes | End of time range in UTC ISO 8601 format \(e.g., 2024-01-22T00:00:00Z\) |
| `eventTypeId` | number | No | Event type ID for direct lookup |
| `eventTypeSlug` | string | No | Event type slug \(requires username to be set\) |
| `username` | string | No | Username for personal event types \(required when using eventTypeSlug\) |
| `timeZone` | string | No | Timezone for returned slots \(defaults to UTC\) |
| `duration` | number | No | Slot length in minutes |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Response status |
| `data` | json | Available time slots grouped by date \(YYYY-MM-DD keys\). Each date maps to an array of slot objects with start time, optional end time, and seated event info. |

View File

@@ -51,7 +51,7 @@ Get information about the currently authenticated Calendly user
| ↳ `name` | string | User full name | | ↳ `name` | string | User full name |
| ↳ `slug` | string | Unique identifier for the user in URLs | | ↳ `slug` | string | Unique identifier for the user in URLs |
| ↳ `email` | string | User email address | | ↳ `email` | string | User email address |
| ↳ `scheduling_url` | string | URL to the user's scheduling page | | ↳ `scheduling_url` | string | URL to the user |
| ↳ `timezone` | string | User timezone | | ↳ `timezone` | string | User timezone |
| ↳ `avatar_url` | string | URL to user avatar image | | ↳ `avatar_url` | string | URL to user avatar image |
| ↳ `created_at` | string | ISO timestamp when user was created | | ↳ `created_at` | string | ISO timestamp when user was created |
@@ -67,11 +67,11 @@ Retrieve a list of all event types for a user or organization
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Calendly Personal Access Token | | `apiKey` | string | Yes | Calendly Personal Access Token |
| `user` | string | No | Return only event types that belong to this user. Format: URI \(e.g., "https://api.calendly.com/users/abc123-def456"\) | | `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. Format: URI \(e.g., "https://api.calendly.com/organizations/abc123-def456"\) | | `organization` | string | No | Return only event types that belong to this organization \(URI format\) |
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) | | `count` | number | No | Number of results per page \(default: 20, max: 100\) |
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token | | `pageToken` | string | No | Page token for pagination |
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "name:asc", "name:desc"\) | | `sort` | string | No | Sort order for results \(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\). | | `active` | boolean | No | When true, show only active event types. When false or unchecked, show all event types \(both active and inactive\). |
#### Output #### Output
@@ -82,7 +82,7 @@ Retrieve a list of all event types for a user or organization
| ↳ `uri` | string | Canonical reference to the event type | | ↳ `uri` | string | Canonical reference to the event type |
| ↳ `name` | string | Event type name | | ↳ `name` | string | Event type name |
| ↳ `active` | boolean | Whether the event type is active | | ↳ `active` | boolean | Whether the event type is active |
| ↳ `booking_method` | string | Booking method \(e.g., "round_robin_or_collect", "collective"\) | | ↳ `booking_method` | string | Booking method \(e.g., |
| ↳ `color` | string | Hex color code | | ↳ `color` | string | Hex color code |
| ↳ `created_at` | string | ISO timestamp of creation | | ↳ `created_at` | string | ISO timestamp of creation |
| ↳ `description_html` | string | HTML formatted description | | ↳ `description_html` | string | HTML formatted description |
@@ -108,7 +108,7 @@ Get detailed information about a specific event type
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Calendly Personal Access Token | | `apiKey` | string | Yes | Calendly Personal Access Token |
| `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"\) | | `eventTypeUuid` | string | Yes | Event type UUID \(can be full URI or just the UUID\) |
#### Output #### Output
@@ -116,7 +116,7 @@ Get detailed information about a specific event type
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `resource` | object | Event type details | | `resource` | object | Event type details |
| ↳ `uri` | string | Canonical reference to the event type | | ↳ `uri` | string | Canonical reference to the event type |
| ↳ `name` | string | Event type name | | ↳ `name` | string | Question text |
| ↳ `active` | boolean | Whether the event type is active | | ↳ `active` | boolean | Whether the event type is active |
| ↳ `booking_method` | string | Booking method | | ↳ `booking_method` | string | Booking method |
| ↳ `color` | string | Hex color code | | ↳ `color` | string | Hex color code |
@@ -128,12 +128,16 @@ Get detailed information about a specific event type
| ↳ `enabled` | boolean | Whether question is enabled | | ↳ `enabled` | boolean | Whether question is enabled |
| ↳ `required` | boolean | Whether question is required | | ↳ `required` | boolean | Whether question is required |
| ↳ `answer_choices` | array | Available answer choices | | ↳ `answer_choices` | array | Available answer choices |
| ↳ `type` | string | Event type classification |
| ↳ `position` | number | Question order |
| ↳ `enabled` | boolean | Whether question is enabled |
| ↳ `required` | boolean | Whether question is required |
| ↳ `answer_choices` | array | Available answer choices |
| ↳ `description_html` | string | HTML formatted description | | ↳ `description_html` | string | HTML formatted description |
| ↳ `description_plain` | string | Plain text description | | ↳ `description_plain` | string | Plain text description |
| ↳ `duration` | number | Duration in minutes | | ↳ `duration` | number | Duration in minutes |
| ↳ `scheduling_url` | string | URL to scheduling page | | ↳ `scheduling_url` | string | URL to scheduling page |
| ↳ `slug` | string | Unique identifier for URLs | | ↳ `slug` | string | Unique identifier for URLs |
| ↳ `type` | string | Event type classification |
| ↳ `updated_at` | string | ISO timestamp of last update | | ↳ `updated_at` | string | ISO timestamp of last update |
### `calendly_list_scheduled_events` ### `calendly_list_scheduled_events`
@@ -145,15 +149,15 @@ Retrieve a list of scheduled events for a user or organization
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Calendly Personal Access Token | | `apiKey` | string | Yes | Calendly Personal Access Token |
| `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"\) | | `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. Either "user" or "organization" must be provided. Format: URI \(e.g., "https://api.calendly.com/organizations/abc123-def456"\) | | `organization` | string | No | Return events that belong to this organization \(URI format\). Either "user" or "organization" must be provided. |
| `invitee_email` | string | No | Return events where invitee has this email | | `invitee_email` | string | No | Return events where invitee has this email |
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) | | `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. Format: ISO 8601 \(e.g., "2024-01-15T09:00:00Z"\) | | `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. Format: ISO 8601 \(e.g., "2024-01-01T00:00:00Z"\) | | `min_start_time` | string | No | Return events with start time after this time \(ISO 8601 format\) |
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token | | `pageToken` | string | No | Page token for pagination |
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "start_time:asc", "start_time:desc"\) | | `sort` | string | No | Sort order for results \(e.g., "start_time:asc", "start_time:desc"\) |
| `status` | string | No | Filter by status. Format: "active" or "canceled" | | `status` | string | No | Filter by status \("active" or "canceled"\) |
#### Output #### Output
@@ -166,14 +170,16 @@ Retrieve a list of scheduled events for a user or organization
| ↳ `start_time` | string | ISO timestamp of event start | | ↳ `start_time` | string | ISO timestamp of event start |
| ↳ `end_time` | string | ISO timestamp of event end | | ↳ `end_time` | string | ISO timestamp of event end |
| ↳ `event_type` | string | URI of the event type | | ↳ `event_type` | string | URI of the event type |
| ↳ `location` | object | Event location details |
| ↳ `type` | string | Location type \(e.g., "zoom", "google_meet", "physical"\) |
| ↳ `location` | string | Location description | | ↳ `location` | string | Location description |
| ↳ `type` | string | Location type \(e.g., |
| ↳ `join_url` | string | URL to join online meeting \(if applicable\) | | ↳ `join_url` | string | URL to join online meeting \(if applicable\) |
| ↳ `invitees_counter` | object | Invitee count information | | ↳ `invitees_counter` | object | Invitee count information |
| ↳ `total` | number | Total number of invitees | | ↳ `total` | number | Total number of invitees |
| ↳ `active` | number | Number of active invitees | | ↳ `active` | number | Number of active invitees |
| ↳ `limit` | number | Maximum number of invitees | | ↳ `limit` | number | Maximum number of invitees |
| ↳ `total` | number | Total number of invitees |
| ↳ `active` | number | Number of active invitees |
| ↳ `limit` | number | Maximum number of invitees |
| ↳ `created_at` | string | ISO timestamp of event creation | | ↳ `created_at` | string | ISO timestamp of event creation |
| ↳ `updated_at` | string | ISO timestamp of last update | | ↳ `updated_at` | string | ISO timestamp of last update |
| `pagination` | object | Pagination information | | `pagination` | object | Pagination information |
@@ -192,7 +198,7 @@ Get detailed information about a specific scheduled event
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Calendly Personal Access Token | | `apiKey` | string | Yes | Calendly Personal Access Token |
| `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"\) | | `eventUuid` | string | Yes | Scheduled event UUID \(can be full URI or just the UUID\) |
#### Output #### Output
@@ -205,22 +211,28 @@ Get detailed information about a specific scheduled event
| ↳ `start_time` | string | ISO timestamp of event start | | ↳ `start_time` | string | ISO timestamp of event start |
| ↳ `end_time` | string | ISO timestamp of event end | | ↳ `end_time` | string | ISO timestamp of event end |
| ↳ `event_type` | string | URI of the event type | | ↳ `event_type` | string | URI of the event type |
| ↳ `location` | object | Event location details |
| ↳ `type` | string | Location type |
| ↳ `location` | string | Location description | | ↳ `location` | string | Location description |
| ↳ `type` | string | Location type |
| ↳ `join_url` | string | URL to join online meeting | | ↳ `join_url` | string | URL to join online meeting |
| ↳ `invitees_counter` | object | Invitee count information | | ↳ `invitees_counter` | object | Invitee count information |
| ↳ `total` | number | Total number of invitees | | ↳ `total` | number | Total number of invitees |
| ↳ `active` | number | Number of active invitees | | ↳ `active` | number | Number of active invitees |
| ↳ `limit` | number | Maximum number of invitees | | ↳ `limit` | number | Maximum number of invitees |
| ↳ `total` | number | Total number of invitees |
| ↳ `active` | number | Number of active invitees |
| ↳ `limit` | number | Maximum number of invitees |
| ↳ `event_memberships` | array | Event hosts/members | | ↳ `event_memberships` | array | Event hosts/members |
| ↳ `user` | string | User URI | | ↳ `user` | string | User URI |
| ↳ `user_email` | string | User email | | ↳ `user_email` | string | User email |
| ↳ `user_name` | string | User name | | ↳ `user_name` | string | User name |
| ↳ `user` | string | User URI |
| ↳ `user_email` | string | User email |
| ↳ `user_name` | string | User name |
| ↳ `event_guests` | array | Additional guests | | ↳ `event_guests` | array | Additional guests |
| ↳ `email` | string | Guest email | | ↳ `email` | string | Guest email |
| ↳ `created_at` | string | When guest was added | | ↳ `created_at` | string | When guest was added |
| ↳ `updated_at` | string | When guest info was updated | | ↳ `updated_at` | string | When guest info was updated |
| ↳ `email` | string | Guest email |
| ↳ `created_at` | string | ISO timestamp of event creation | | ↳ `created_at` | string | ISO timestamp of event creation |
| ↳ `updated_at` | string | ISO timestamp of last update | | ↳ `updated_at` | string | ISO timestamp of last update |
@@ -233,12 +245,12 @@ Retrieve a list of invitees for a scheduled event
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Calendly Personal Access Token | | `apiKey` | string | Yes | Calendly Personal Access Token |
| `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"\) | | `eventUuid` | string | Yes | Scheduled event UUID \(can be full URI or just the UUID\) |
| `count` | number | No | Number of results per page. Format: integer \(default: 20, max: 100\) | | `count` | number | No | Number of results per page \(default: 20, max: 100\) |
| `email` | string | No | Filter invitees by email address | | `email` | string | No | Filter invitees by email address |
| `pageToken` | string | No | Page token for pagination. Format: opaque string from previous response next_page_token | | `pageToken` | string | No | Page token for pagination |
| `sort` | string | No | Sort order for results. Format: "field:direction" \(e.g., "created_at:asc", "created_at:desc"\) | | `sort` | string | No | Sort order for results \(e.g., "created_at:asc", "created_at:desc"\) |
| `status` | string | No | Filter by status. Format: "active" or "canceled" | | `status` | string | No | Filter by status \("active" or "canceled"\) |
#### Output #### Output
@@ -255,6 +267,9 @@ Retrieve a list of invitees for a scheduled event
| ↳ `question` | string | Question text | | ↳ `question` | string | Question text |
| ↳ `answer` | string | Invitee answer | | ↳ `answer` | string | Invitee answer |
| ↳ `position` | number | Question order | | ↳ `position` | number | Question order |
| ↳ `question` | string | Question text |
| ↳ `answer` | string | Invitee answer |
| ↳ `position` | number | Question order |
| ↳ `timezone` | string | Invitee timezone | | ↳ `timezone` | string | Invitee timezone |
| ↳ `event` | string | URI of the scheduled event | | ↳ `event` | string | URI of the scheduled event |
| ↳ `created_at` | string | ISO timestamp when invitee was created | | ↳ `created_at` | string | ISO timestamp when invitee was created |
@@ -278,7 +293,7 @@ Cancel a scheduled event
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Calendly Personal Access Token | | `apiKey` | string | Yes | Calendly Personal Access Token |
| `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"\) | | `eventUuid` | string | Yes | Scheduled event UUID to cancel \(can be full URI or just the UUID\) |
| `reason` | string | No | Reason for cancellation \(will be sent to invitees\) | | `reason` | string | No | Reason for cancellation \(will be sent to invitees\) |
#### Output #### Output

View File

@@ -1,442 +0,0 @@
---
title: Clerk
description: Manage users, organizations, and sessions in Clerk
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="clerk"
color="#131316"
/>
{/* MANUAL-CONTENT-START:intro */}
[Clerk](https://clerk.com/) is a comprehensive identity infrastructure platform that helps you manage users, authentication, and sessions for your applications.
In Sim, the Clerk integration lets your agents automate user and session management through easy-to-use API-based tools. Agents can securely list users, update user profiles, manage organizations, monitor sessions, and revoke access directly in your workflow.
With Clerk, you can:
- **Authenticate users and manage sessions**: Seamlessly control sign-in, sign-up, and session lifecycle for your users.
- **List and update users**: Automatically pull user lists, update user attributes, or view profile details as part of your agent tasks.
- **Manage organizations and memberships**: Add or update organizations and administer user memberships with clarity.
- **Monitor and revoke sessions**: See active or past user sessions, and revoke access immediately if needed for security.
The integration enables real-time, auditable management of your user base—all from within Sim. Connected agents can automate onboarding, enforce policies, keep directories up to date, and react to authentication events or organizational changes, helping you run secure and flexible processes using Clerk as your identity engine.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Integrate Clerk authentication and user management into your workflow. Create, update, delete, and list users. Manage organizations and their memberships. Monitor and control user sessions.
## Tools
### `clerk_list_users`
List all users in your Clerk application with optional filtering and pagination
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `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 \(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 \(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
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `users` | array | Array of Clerk user objects |
| ↳ `id` | string | User ID |
| ↳ `username` | string | Username |
| ↳ `firstName` | string | First name |
| ↳ `lastName` | string | Last name |
| ↳ `imageUrl` | string | Profile image URL |
| ↳ `hasImage` | boolean | Whether user has a profile image |
| ↳ `primaryEmailAddressId` | string | Primary email address ID |
| ↳ `primaryPhoneNumberId` | string | Primary phone number ID |
| ↳ `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `externalId` | string | External system ID |
| ↳ `passwordEnabled` | boolean | Whether password is enabled |
| ↳ `twoFactorEnabled` | boolean | Whether 2FA is enabled |
| ↳ `banned` | boolean | Whether user is banned |
| ↳ `locked` | boolean | Whether user is locked |
| ↳ `lastSignInAt` | number | Last sign-in timestamp |
| ↳ `lastActiveAt` | number | Last activity timestamp |
| ↳ `createdAt` | number | Creation timestamp |
| ↳ `updatedAt` | number | Last update timestamp |
| ↳ `publicMetadata` | json | Public metadata |
| `totalCount` | number | Total number of users matching the query |
| `success` | boolean | Operation success status |
### `clerk_get_user`
Retrieve a single user by their ID from Clerk
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `userId` | string | Yes | The ID of the user to retrieve \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | User ID |
| `username` | string | Username |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `imageUrl` | string | Profile image URL |
| `hasImage` | boolean | Whether user has a profile image |
| `primaryEmailAddressId` | string | Primary email address ID |
| `primaryPhoneNumberId` | string | Primary phone number ID |
| `primaryWeb3WalletId` | string | Primary Web3 wallet ID |
| `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `verified` | boolean | Whether email is verified |
| `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `verified` | boolean | Whether phone is verified |
| `externalId` | string | External system ID |
| `passwordEnabled` | boolean | Whether password is enabled |
| `twoFactorEnabled` | boolean | Whether 2FA is enabled |
| `totpEnabled` | boolean | Whether TOTP is enabled |
| `backupCodeEnabled` | boolean | Whether backup codes are enabled |
| `banned` | boolean | Whether user is banned |
| `locked` | boolean | Whether user is locked |
| `deleteSelfEnabled` | boolean | Whether user can delete themselves |
| `createOrganizationEnabled` | boolean | Whether user can create organizations |
| `lastSignInAt` | number | Last sign-in timestamp |
| `lastActiveAt` | number | Last activity timestamp |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata \(readable from frontend\) |
| `privateMetadata` | json | Private metadata \(backend only\) |
| `unsafeMetadata` | json | Unsafe metadata \(modifiable from frontend\) |
| `success` | boolean | Operation success status |
### `clerk_create_user`
Create a new user in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `emailAddress` | string | No | Email addresses for the user \(comma-separated for multiple\) |
| `phoneNumber` | string | No | Phone numbers for the user \(comma-separated for multiple\) |
| `username` | string | No | Username for the user \(must be unique\) |
| `password` | string | No | Password for the user \(minimum 8 characters\) |
| `firstName` | string | No | First name of the user |
| `lastName` | string | No | Last name of the user |
| `externalId` | string | No | External system identifier \(must be unique\) |
| `publicMetadata` | json | No | Public metadata \(JSON object, readable from frontend\) |
| `privateMetadata` | json | No | Private metadata \(JSON object, backend only\) |
| `unsafeMetadata` | json | No | Unsafe metadata \(JSON object, modifiable from frontend\) |
| `skipPasswordChecks` | boolean | No | Skip password validation checks |
| `skipPasswordRequirement` | boolean | No | Make password optional |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Created user ID |
| `username` | string | Username |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `imageUrl` | string | Profile image URL |
| `primaryEmailAddressId` | string | Primary email address ID |
| `primaryPhoneNumberId` | string | Primary phone number ID |
| `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `verified` | boolean | Whether email is verified |
| `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `verified` | boolean | Whether phone is verified |
| `externalId` | string | External system ID |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_update_user`
Update an existing user in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `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\) |
| `password` | string | No | New password \(minimum 8 characters\) |
| `externalId` | string | No | External system identifier |
| `primaryEmailAddressId` | string | No | ID of verified email to set as primary |
| `primaryPhoneNumberId` | string | No | ID of verified phone to set as primary |
| `publicMetadata` | json | No | Public metadata \(JSON object\) |
| `privateMetadata` | json | No | Private metadata \(JSON object\) |
| `unsafeMetadata` | json | No | Unsafe metadata \(JSON object\) |
| `skipPasswordChecks` | boolean | No | Skip password validation checks |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Updated user ID |
| `username` | string | Username |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `imageUrl` | string | Profile image URL |
| `primaryEmailAddressId` | string | Primary email address ID |
| `primaryPhoneNumberId` | string | Primary phone number ID |
| `emailAddresses` | array | User email addresses |
| ↳ `id` | string | Email address ID |
| ↳ `emailAddress` | string | Email address |
| ↳ `verified` | boolean | Whether email is verified |
| `phoneNumbers` | array | User phone numbers |
| ↳ `id` | string | Phone number ID |
| ↳ `phoneNumber` | string | Phone number |
| ↳ `verified` | boolean | Whether phone is verified |
| `externalId` | string | External system ID |
| `banned` | boolean | Whether user is banned |
| `locked` | boolean | Whether user is locked |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_delete_user`
Delete a user from your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `userId` | string | Yes | The ID of the user to delete \(e.g., user_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Deleted user ID |
| `object` | string | Object type \(user\) |
| `deleted` | boolean | Whether the user was deleted |
| `success` | boolean | Operation success status |
### `clerk_list_organizations`
List all organizations in your Clerk application with optional filtering
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `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 \(e.g., Acme Corp or acme-corp\) |
| `orderBy` | string | No | Sort field \(name, created_at, members_count\) with +/- prefix |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `organizations` | array | Array of Clerk organization objects |
| ↳ `id` | string | Organization ID |
| ↳ `name` | string | Organization name |
| ↳ `slug` | string | Organization slug |
| ↳ `imageUrl` | string | Organization image URL |
| ↳ `hasImage` | boolean | Whether organization has an image |
| ↳ `membersCount` | number | Number of members |
| ↳ `pendingInvitationsCount` | number | Number of pending invitations |
| ↳ `maxAllowedMemberships` | number | Max allowed memberships |
| ↳ `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
| ↳ `createdBy` | string | Creator user ID |
| ↳ `createdAt` | number | Creation timestamp |
| ↳ `updatedAt` | number | Last update timestamp |
| ↳ `publicMetadata` | json | Public metadata |
| `totalCount` | number | Total number of organizations |
| `success` | boolean | Operation success status |
### `clerk_get_organization`
Retrieve a single organization by ID or slug from Clerk
#### Input
| 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 \(e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Organization ID |
| `name` | string | Organization name |
| `slug` | string | Organization slug |
| `imageUrl` | string | Organization image URL |
| `hasImage` | boolean | Whether organization has an image |
| `membersCount` | number | Number of members |
| `pendingInvitationsCount` | number | Number of pending invitations |
| `maxAllowedMemberships` | number | Max allowed memberships |
| `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
| `createdBy` | string | Creator user ID |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_create_organization`
Create a new organization in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `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 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\) |
| `privateMetadata` | json | No | Private metadata \(JSON object\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Created organization ID |
| `name` | string | Organization name |
| `slug` | string | Organization slug |
| `imageUrl` | string | Organization image URL |
| `hasImage` | boolean | Whether organization has an image |
| `membersCount` | number | Number of members |
| `pendingInvitationsCount` | number | Number of pending invitations |
| `maxAllowedMemberships` | number | Max allowed memberships |
| `adminDeleteEnabled` | boolean | Whether admin delete is enabled |
| `createdBy` | string | Creator user ID |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `publicMetadata` | json | Public metadata |
| `success` | boolean | Operation success status |
### `clerk_list_sessions`
List sessions for a user or client in your Clerk application
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `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 \(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
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `sessions` | array | Array of Clerk session objects |
| ↳ `id` | string | Session ID |
| ↳ `userId` | string | User ID |
| ↳ `clientId` | string | Client ID |
| ↳ `status` | string | Session status |
| ↳ `lastActiveAt` | number | Last activity timestamp |
| ↳ `lastActiveOrganizationId` | string | Last active organization ID |
| ↳ `expireAt` | number | Expiration timestamp |
| ↳ `abandonAt` | number | Abandon timestamp |
| ↳ `createdAt` | number | Creation timestamp |
| ↳ `updatedAt` | number | Last update timestamp |
| `totalCount` | number | Total number of sessions |
| `success` | boolean | Operation success status |
### `clerk_get_session`
Retrieve a single session by ID from Clerk
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `sessionId` | string | Yes | The ID of the session to retrieve \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Session ID |
| `userId` | string | User ID |
| `clientId` | string | Client ID |
| `status` | string | Session status |
| `lastActiveAt` | number | Last activity timestamp |
| `lastActiveOrganizationId` | string | Last active organization ID |
| `expireAt` | number | Expiration timestamp |
| `abandonAt` | number | Abandon timestamp |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `success` | boolean | Operation success status |
### `clerk_revoke_session`
Revoke a session to immediately invalidate it
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `secretKey` | string | Yes | The Clerk Secret Key for API authentication |
| `sessionId` | string | Yes | The ID of the session to revoke \(e.g., sess_2NNEqL2nrIRdJ194ndJqAHwEfxC\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `id` | string | Session ID |
| `userId` | string | User ID |
| `clientId` | string | Client ID |
| `status` | string | Session status \(should be revoked\) |
| `lastActiveAt` | number | Last activity timestamp |
| `lastActiveOrganizationId` | string | Last active organization ID |
| `expireAt` | number | Expiration timestamp |
| `abandonAt` | number | Abandon timestamp |
| `createdAt` | number | Creation timestamp |
| `updatedAt` | number | Last update timestamp |
| `success` | boolean | Operation success status |

View File

@@ -42,7 +42,7 @@ Retrieve content from Confluence pages using the Confluence API.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to retrieve \(numeric ID from page URL or API\) | | `pageId` | string | Yes | Confluence page ID to retrieve |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. | | `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output #### Output
@@ -63,7 +63,7 @@ Update a Confluence page using the Confluence API.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to update \(numeric ID from page URL or API\) | | `pageId` | string | Yes | Confluence page ID to update |
| `title` | string | No | New title for the page | | `title` | string | No | New title for the page |
| `content` | string | No | New content for the page in Confluence storage format | | `content` | string | No | New content for the page in Confluence storage format |
| `version` | number | No | Version number of the page \(required for preventing conflicts\) | | `version` | number | No | Version number of the page \(required for preventing conflicts\) |
@@ -140,20 +140,7 @@ Search for content across Confluence pages, blog posts, and other content.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `ts` | string | Timestamp of search | | `ts` | string | Timestamp of search |
| `results` | array | Array of search results | | `results` | array | Search results |
| ↳ `id` | string | Unique content identifier |
| ↳ `title` | string | Content title |
| ↳ `type` | string | Content type \(e.g., page, blogpost, attachment, comment\) |
| ↳ `status` | string | Content status \(e.g., current\) |
| ↳ `url` | string | URL to view the content in Confluence |
| ↳ `excerpt` | string | Text excerpt matching the search query |
| ↳ `spaceKey` | string | Key of the space containing the content |
| ↳ `space` | object | Space information for the content |
| ↳ `id` | string | Space identifier |
| ↳ `key` | string | Space key |
| ↳ `name` | string | Space name |
| ↳ `lastModified` | string | ISO 8601 timestamp of last modification |
| ↳ `entityType` | string | Entity type identifier \(e.g., content, space\) |
### `confluence_create_comment` ### `confluence_create_comment`
@@ -193,25 +180,8 @@ List all comments on a Confluence page.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `ts` | string | ISO 8601 timestamp of the operation | | `ts` | string | Timestamp of retrieval |
| `comments` | array | Array of Confluence comments | | `comments` | array | List of comments |
| ↳ `id` | string | Unique comment identifier |
| ↳ `status` | string | Comment status \(e.g., current\) |
| ↳ `title` | string | Comment title |
| ↳ `pageId` | string | ID of the page the comment belongs to |
| ↳ `blogPostId` | string | ID of the blog post the comment belongs to |
| ↳ `parentCommentId` | string | ID of the parent comment |
| ↳ `body` | object | Comment body content |
| ↳ `value` | string | Comment body content |
| ↳ `representation` | string | Content representation format \(e.g., storage, view\) |
| ↳ `createdAt` | string | ISO 8601 timestamp when the comment was created |
| ↳ `authorId` | string | Account ID of the comment author |
| ↳ `version` | object | Comment version information |
| ↳ `number` | number | Version number |
| ↳ `message` | string | Version message |
| ↳ `minorEdit` | boolean | Whether this is a minor edit |
| ↳ `authorId` | string | Account ID of the version author |
| ↳ `createdAt` | string | ISO 8601 timestamp of version creation |
### `confluence_update_comment` ### `confluence_update_comment`
@@ -298,24 +268,8 @@ List all attachments on a Confluence page.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `ts` | string | ISO 8601 timestamp of the operation | | `ts` | string | Timestamp of retrieval |
| `attachments` | array | Array of Confluence attachments | | `attachments` | array | List of attachments |
| ↳ `id` | string | Unique attachment identifier \(prefixed with "att"\) |
| ↳ `title` | string | Attachment file name |
| ↳ `status` | string | Attachment status \(e.g., current, archived, trashed\) |
| ↳ `mediaType` | string | MIME type of the attachment |
| ↳ `fileSize` | number | File size in bytes |
| ↳ `downloadUrl` | string | URL to download the attachment |
| ↳ `webuiUrl` | string | URL to view the attachment in Confluence UI |
| ↳ `pageId` | string | ID of the page the attachment belongs to |
| ↳ `blogPostId` | string | ID of the blog post the attachment belongs to |
| ↳ `comment` | string | Comment/description of the attachment |
| ↳ `version` | object | Attachment version information |
| ↳ `number` | number | Version number |
| ↳ `message` | string | Version message |
| ↳ `minorEdit` | boolean | Whether this is a minor edit |
| ↳ `authorId` | string | Account ID of the version author |
| ↳ `createdAt` | string | ISO 8601 timestamp of version creation |
### `confluence_delete_attachment` ### `confluence_delete_attachment`
@@ -354,10 +308,7 @@ List all labels on a Confluence page.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `ts` | string | Timestamp of retrieval | | `ts` | string | Timestamp of retrieval |
| `labels` | array | Array of labels on the page | | `labels` | array | List of labels |
| ↳ `id` | string | Unique label identifier |
| ↳ `name` | string | Label name |
| ↳ `prefix` | string | Label prefix/type \(e.g., global, my, team\) |
### `confluence_get_space` ### `confluence_get_space`
@@ -399,18 +350,7 @@ List all Confluence spaces accessible to the user.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `ts` | string | ISO 8601 timestamp of the operation | | `ts` | string | Timestamp of retrieval |
| `spaces` | array | Array of Confluence spaces | | `spaces` | array | List of spaces |
| ↳ `id` | string | Unique space identifier |
| ↳ `key` | string | Space key \(short identifier used in URLs\) |
| ↳ `name` | string | Space name |
| ↳ `type` | string | Space type \(e.g., global, personal\) |
| ↳ `status` | string | Space status \(e.g., current, archived\) |
| ↳ `authorId` | string | Account ID of the space creator |
| ↳ `createdAt` | string | ISO 8601 timestamp when the space was created |
| ↳ `homepageId` | string | ID of the space homepage |
| ↳ `description` | object | Space description |
| ↳ `value` | string | Description text content |
| ↳ `representation` | string | Content representation format \(e.g., plain, view, storage\) |

View File

@@ -60,9 +60,9 @@ Query metric timeseries data from Datadog. Use for analyzing trends, creating re
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}", "sum:nginx.requests\{env:prod\}.as_count\(\)"\) | | `query` | string | Yes | Datadog metrics query \(e.g., "avg:system.cpu.user\{*\}"\) |
| `from` | number | Yes | Start time as Unix timestamp in seconds \(e.g., 1705320000\) | | `from` | number | Yes | Start time as Unix timestamp in seconds |
| `to` | number | Yes | End time as Unix timestamp in seconds \(e.g., 1705323600\) | | `to` | number | Yes | End time as Unix timestamp in seconds |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application key | | `applicationKey` | string | Yes | Datadog Application key |
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) | | `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. | | `text` | string | Yes | Event body/description. Supports markdown. |
| `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot | | `alertType` | string | No | Alert type: error, warning, info, success, user_update, recommendation, or snapshot |
| `priority` | string | No | Event priority: normal or low | | `priority` | string | No | Event priority: normal or low |
| `host` | string | No | Host name to associate with this event \(e.g., "web-server-01", "prod-api-1"\) | | `host` | string | No | Host name to associate with this event |
| `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api", "team:backend,priority:high"\) | | `tags` | string | No | Comma-separated list of tags \(e.g., "env:production,service:api"\) |
| `aggregationKey` | string | No | Key to aggregate events together | | `aggregationKey` | string | No | Key to aggregate events together |
| `sourceTypeName` | string | No | Source type name for the event | | `sourceTypeName` | string | No | Source type name for the event |
| `dateHappened` | number | No | Unix timestamp in seconds when the event occurred \(e.g., 1705320000, defaults to now\) | | `dateHappened` | number | No | Unix timestamp when the event occurred \(defaults to now\) |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) | | `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 | | `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 | | `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\{*\} &lt; 20", "logs\(\"status:error\"\).index\(\"main\"\).rollup\(\"count\"\).last\(\"5m\"\) &gt; 100"\) | | `query` | string | Yes | Monitor query \(e.g., "avg\(last_5m\):avg:system.cpu.idle\{*\} &lt; 20"\) |
| `message` | string | No | Message to include with notifications. Can include @-mentions and markdown. | | `message` | string | No | Message to include with notifications. Can include @-mentions and markdown. |
| `tags` | string | No | Comma-separated list of tags | | `tags` | string | No | Comma-separated list of tags |
| `priority` | number | No | Monitor priority \(1-5, where 1 is highest\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `monitorId` | string | Yes | The ID of the monitor to retrieve \(e.g., "12345678"\) | | `monitorId` | string | Yes | The ID of the monitor to retrieve |
| `groupStates` | string | No | Comma-separated group states to include \(e.g., "alert,warn", "alert,warn,no data,ok"\) | | `groupStates` | string | No | Comma-separated group states to include: alert, warn, no data, ok |
| `withDowntimes` | boolean | No | Include downtime data with the monitor | | `withDowntimes` | boolean | No | Include downtime data with the monitor |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application 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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupStates` | string | No | Comma-separated group states to filter by \(e.g., "alert,warn", "alert,warn,no data,ok"\) | | `groupStates` | string | No | Comma-separated group states to filter by: alert, warn, no data, ok |
| `name` | string | No | Filter monitors by name with partial match \(e.g., "CPU", "Production"\) | | `name` | string | No | Filter monitors by name \(partial match\) |
| `tags` | string | No | Comma-separated list of tags to filter by \(e.g., "env:prod,team:backend"\) | | `tags` | string | No | Comma-separated list of tags to filter by |
| `monitorTags` | string | No | Comma-separated list of monitor tags to filter by \(e.g., "service:api,priority:high"\) | | `monitorTags` | string | No | Comma-separated list of monitor tags to filter by |
| `withDowntimes` | boolean | No | Include downtime data with monitors | | `withDowntimes` | boolean | No | Include downtime data with monitors |
| `page` | number | No | Page number for pagination \(0-indexed, e.g., 0, 1, 2\) | | `page` | number | No | Page number for pagination \(0-indexed\) |
| `pageSize` | number | No | Number of monitors per page \(e.g., 50, max: 1000\) | | `pageSize` | number | No | Number of monitors per page \(max 1000\) |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application key | | `applicationKey` | string | Yes | Datadog Application key |
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
@@ -214,9 +214,9 @@ Mute a monitor to temporarily suppress notifications.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `monitorId` | string | Yes | The ID of the monitor to mute \(e.g., "12345678"\) | | `monitorId` | string | Yes | The ID of the monitor to mute |
| `scope` | string | No | Scope to mute \(e.g., "host:myhost", "env:prod"\). If not specified, mutes all scopes. | | `scope` | string | No | Scope to mute \(e.g., "host:myhost"\). 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. | | `end` | number | No | Unix timestamp when the mute should end. If not specified, mutes indefinitely. |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application key | | `applicationKey` | string | Yes | Datadog Application key |
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Log search query using Datadog query syntax \(e.g., "service:web-app status:error", "host:prod-* @http.status_code:500"\) | | `query` | string | Yes | Log search query \(e.g., "service:web-app status:error"\) |
| `from` | string | Yes | Start time in ISO-8601 format or relative time \(e.g., "now-1h", "now-15m", "2024-01-15T10:00:00Z"\) | | `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 time \(e.g., "now", "now-5m", "2024-01-15T12:00:00Z"\) | | `to` | string | Yes | End time in ISO-8601 format or relative \(e.g., "now"\) |
| `limit` | number | No | Maximum number of logs to return \(e.g., 50, 100, max: 1000\) | | `limit` | number | No | Maximum number of logs to return \(default: 50, max: 1000\) |
| `sort` | string | No | Sort order: "timestamp" for oldest first, "-timestamp" for newest first | | `sort` | string | No | Sort order: timestamp \(oldest first\) or -timestamp \(newest first\) |
| `indexes` | string | No | Comma-separated list of log indexes to search | | `indexes` | string | No | Comma-separated list of log indexes to search |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application key | | `applicationKey` | string | Yes | Datadog Application key |
@@ -257,6 +257,11 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon
| ↳ `service` | string | Service name | | ↳ `service` | string | Service name |
| ↳ `message` | string | Log message | | ↳ `message` | string | Log message |
| ↳ `status` | string | Log status/level | | ↳ `status` | string | Log status/level |
| ↳ `timestamp` | string | Log timestamp |
| ↳ `host` | string | Host name |
| ↳ `service` | string | Service name |
| ↳ `message` | string | Log message |
| ↳ `status` | string | Log status/level |
| `nextLogId` | string | Cursor for pagination | | `nextLogId` | string | Cursor for pagination |
### `datadog_send_logs` ### `datadog_send_logs`
@@ -287,10 +292,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\) | | `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 | | `message` | string | No | Message to display during downtime |
| `start` | number | No | Unix timestamp for downtime start in seconds \(e.g., 1705320000, defaults to now\) | | `start` | number | No | Unix timestamp for downtime start \(defaults to now\) |
| `end` | number | No | Unix timestamp for downtime end in seconds \(e.g., 1705323600\) | | `end` | number | No | Unix timestamp for downtime end |
| `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York", "UTC", "Europe/London"\) | | `timezone` | string | No | Timezone for the downtime \(e.g., "America/New_York"\) |
| `monitorId` | string | No | Specific monitor ID to mute \(e.g., "12345678"\) | | `monitorId` | string | No | Specific monitor ID to mute |
| `monitorTags` | string | No | Comma-separated monitor tags to match \(e.g., "team:backend,priority:high"\) | | `monitorTags` | string | No | Comma-separated monitor tags to match \(e.g., "team:backend,priority:high"\) |
| `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification | | `muteFirstRecoveryNotification` | boolean | No | Mute the first recovery notification |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
@@ -318,7 +323,7 @@ List all scheduled downtimes in Datadog.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `currentOnly` | boolean | No | Only return currently active downtimes | | `currentOnly` | boolean | No | Only return currently active downtimes |
| `monitorId` | string | No | Filter by monitor ID \(e.g., "12345678"\) | | `monitorId` | string | No | Filter by monitor ID |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application key | | `applicationKey` | string | Yes | Datadog Application key |
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) |
@@ -343,7 +348,7 @@ Cancel a scheduled downtime.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `downtimeId` | string | Yes | The ID of the downtime to cancel \(e.g., "abc123def456"\) | | `downtimeId` | string | Yes | The ID of the downtime to cancel |
| `apiKey` | string | Yes | Datadog API key | | `apiKey` | string | Yes | Datadog API key |
| `applicationKey` | string | Yes | Datadog Application key | | `applicationKey` | string | Yes | Datadog Application key |
| `site` | string | No | Datadog site/region \(default: datadoghq.com\) | | `site` | string | No | Datadog site/region \(default: datadoghq.com\) |

View File

@@ -53,9 +53,9 @@ Send a message to a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to send the message to, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to send the message to |
| `content` | string | No | The text content of the message | | `content` | string | No | The text content of the message |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `files` | file[] | No | Files to attach to the message | | `files` | file[] | No | Files to attach to the message |
#### Output #### Output
@@ -64,7 +64,7 @@ Send a message to a Discord channel
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Discord message data | | `data` | object | Discord message data |
| ↳ `id` | string | Message ID | | ↳ `id` | string | Author user ID |
| ↳ `content` | string | Message content | | ↳ `content` | string | Message content |
| ↳ `channel_id` | string | Channel ID where message was sent | | ↳ `channel_id` | string | Channel ID where message was sent |
| ↳ `author` | object | Message author information | | ↳ `author` | object | Message author information |
@@ -72,6 +72,9 @@ Send a message to a Discord channel
| ↳ `username` | string | Author username | | ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash | | ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot | | ↳ `bot` | boolean | Whether author is a bot |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `timestamp` | string | Message timestamp | | ↳ `timestamp` | string | Message timestamp |
| ↳ `edited_timestamp` | string | Message edited timestamp | | ↳ `edited_timestamp` | string | Message edited timestamp |
| ↳ `embeds` | array | Message embeds | | ↳ `embeds` | array | Message embeds |
@@ -89,7 +92,7 @@ Retrieve messages from a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to retrieve messages from, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to retrieve messages from |
| `limit` | number | No | Maximum number of messages to retrieve \(default: 10, max: 100\) | | `limit` | number | No | Maximum number of messages to retrieve \(default: 10, max: 100\) |
#### Output #### Output
@@ -99,7 +102,7 @@ Retrieve messages from a Discord channel
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Container for messages data | | `data` | object | Container for messages data |
| ↳ `messages` | array | Array of Discord messages with full metadata | | ↳ `messages` | array | Array of Discord messages with full metadata |
| ↳ `id` | string | Message ID | | ↳ `id` | string | Author user ID |
| ↳ `content` | string | Message content | | ↳ `content` | string | Message content |
| ↳ `channel_id` | string | Channel ID | | ↳ `channel_id` | string | Channel ID |
| ↳ `author` | object | Message author information | | ↳ `author` | object | Message author information |
@@ -107,6 +110,9 @@ Retrieve messages from a Discord channel
| ↳ `username` | string | Author username | | ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash | | ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot | | ↳ `bot` | boolean | Whether author is a bot |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `timestamp` | string | Message timestamp | | ↳ `timestamp` | string | Message timestamp |
| ↳ `edited_timestamp` | string | Message edited timestamp | | ↳ `edited_timestamp` | string | Message edited timestamp |
| ↳ `embeds` | array | Message embeds | | ↳ `embeds` | array | Message embeds |
@@ -114,7 +120,24 @@ Retrieve messages from a Discord channel
| ↳ `mentions` | array | User mentions in message | | ↳ `mentions` | array | User mentions in message |
| ↳ `mention_roles` | array | Role mentions in message | | ↳ `mention_roles` | array | Role mentions in message |
| ↳ `mention_everyone` | boolean | Whether message mentions everyone | | ↳ `mention_everyone` | boolean | Whether message mentions everyone |
| ↳ `id` | string | Author user ID |
| ↳ `content` | string | Message content |
| ↳ `channel_id` | string | Channel ID | | ↳ `channel_id` | string | Channel ID |
| ↳ `author` | object | Message author information |
| ↳ `id` | string | Author user ID |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `username` | string | Author username |
| ↳ `avatar` | string | Author avatar hash |
| ↳ `bot` | boolean | Whether author is a bot |
| ↳ `timestamp` | string | Message timestamp |
| ↳ `edited_timestamp` | string | Message edited timestamp |
| ↳ `embeds` | array | Message embeds |
| ↳ `attachments` | array | Message attachments |
| ↳ `mentions` | array | User mentions in message |
| ↳ `mention_roles` | array | Role mentions in message |
| ↳ `mention_everyone` | boolean | Whether message mentions everyone |
### `discord_get_server` ### `discord_get_server`
@@ -125,7 +148,7 @@ Retrieve information about a Discord server (guild)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -151,7 +174,7 @@ Retrieve information about a Discord user
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | Discord bot token for authentication | | `botToken` | string | Yes | Discord bot token for authentication |
| `userId` | string | Yes | The Discord user ID, e.g., 123456789012345678 | | `userId` | string | Yes | The Discord user ID |
#### Output #### Output
@@ -177,10 +200,10 @@ Edit an existing message in a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to edit, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to edit |
| `content` | string | No | The new text content for the message | | `content` | string | No | The new text content for the message |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -202,9 +225,9 @@ Delete a message from a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to delete, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -221,10 +244,10 @@ Add a reaction emoji to a Discord message
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to react to, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to react to |
| `emoji` | string | Yes | The emoji to react with \(unicode emoji or custom emoji in name:id format\) | | `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\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -241,11 +264,11 @@ Remove a reaction from a Discord message
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message with the reaction, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message with the reaction |
| `emoji` | string | Yes | The emoji to remove \(unicode emoji or custom emoji in name:id format\) | | `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\), e.g., 123456789012345678 | | `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\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -262,9 +285,9 @@ Pin a message in a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to pin, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to pin |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -281,9 +304,9 @@ Unpin a message in a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to unpin, e.g., 123456789012345678 | | `messageId` | string | Yes | The ID of the message to unpin |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -300,11 +323,11 @@ Create a thread in a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to create the thread in, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to create the thread in |
| `name` | string | Yes | The name of the thread \(1-100 characters\) | | `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\), e.g., 123456789012345678 | | `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\) |
| `autoArchiveDuration` | number | No | Duration in minutes to auto-archive the thread \(60, 1440, 4320, 10080\) | | `autoArchiveDuration` | number | No | Duration in minutes to auto-archive the thread \(60, 1440, 4320, 10080\) |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -327,8 +350,8 @@ Join a thread in Discord
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `threadId` | string | Yes | The thread ID to join, e.g., 123456789012345678 | | `threadId` | string | Yes | The thread ID to join |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -345,8 +368,8 @@ Leave a thread in Discord
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `threadId` | string | Yes | The thread ID to leave, e.g., 123456789012345678 | | `threadId` | string | Yes | The thread ID to leave |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -363,9 +386,9 @@ Archive or unarchive a thread in Discord
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `threadId` | string | Yes | The thread ID to archive/unarchive, e.g., 123456789012345678 | | `threadId` | string | Yes | The thread ID to archive/unarchive |
| `archived` | boolean | Yes | Whether to archive \(true\) or unarchive \(false\) the thread | | `archived` | boolean | Yes | Whether to archive \(true\) or unarchive \(false\) the thread |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -385,11 +408,11 @@ Create a new channel in a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `name` | string | Yes | The name of the channel \(1-100 characters\) | | `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\) | | `type` | number | No | Channel type \(0=text, 2=voice, 4=category, 5=announcement, 13=stage\) |
| `topic` | string | No | Channel topic \(0-1024 characters\) | | `topic` | string | No | Channel topic \(0-1024 characters\) |
| `parentId` | string | No | Parent category ID for the channel, e.g., 123456789012345678 | | `parentId` | string | No | Parent category ID for the channel |
#### Output #### Output
@@ -411,10 +434,10 @@ Update a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to update, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to update |
| `name` | string | No | The new name for the channel | | `name` | string | No | The new name for the channel |
| `topic` | string | No | The new topic for the channel | | `topic` | string | No | The new topic for the channel |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -436,8 +459,8 @@ Delete a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to delete, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -454,8 +477,8 @@ Get information about a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to retrieve, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to retrieve |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -478,7 +501,7 @@ Create a new role in a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `name` | string | Yes | The name of the role | | `name` | string | Yes | The name of the role |
| `color` | number | No | RGB color value as integer \(e.g., 0xFF0000 for red\) | | `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 | | `hoist` | boolean | No | Whether to display role members separately from online members |
@@ -505,8 +528,8 @@ Update a role in a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `roleId` | string | Yes | The role ID to update, e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to update |
| `name` | string | No | The new name for the role | | `name` | string | No | The new name for the role |
| `color` | number | No | RGB color value as integer | | `color` | number | No | RGB color value as integer |
| `hoist` | boolean | No | Whether to display role members separately | | `hoist` | boolean | No | Whether to display role members separately |
@@ -531,8 +554,8 @@ Delete a role from a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `roleId` | string | Yes | The role ID to delete, e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to delete |
#### Output #### Output
@@ -549,9 +572,9 @@ Assign a role to a member in a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to assign the role to, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to assign the role to |
| `roleId` | string | Yes | The role ID to assign, e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to assign |
#### Output #### Output
@@ -568,9 +591,9 @@ Remove a role from a member in a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to remove the role from, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to remove the role from |
| `roleId` | string | Yes | The role ID to remove, e.g., 123456789012345678 | | `roleId` | string | Yes | The role ID to remove |
#### Output #### Output
@@ -587,8 +610,8 @@ Kick a member from a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to kick, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to kick |
| `reason` | string | No | Reason for kicking the member | | `reason` | string | No | Reason for kicking the member |
#### Output #### Output
@@ -606,8 +629,8 @@ Ban a member from a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to ban, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to ban |
| `reason` | string | No | Reason for banning the member | | `reason` | string | No | Reason for banning the member |
| `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) | | `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) |
@@ -626,8 +649,8 @@ Unban a member from a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to unban, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to unban |
| `reason` | string | No | Reason for unbanning the member | | `reason` | string | No | Reason for unbanning the member |
#### Output #### Output
@@ -645,8 +668,8 @@ Get information about a member in a Discord server
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to retrieve, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to retrieve |
#### Output #### Output
@@ -658,6 +681,9 @@ Get information about a member in a Discord server
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `username` | string | Username | | ↳ `username` | string | Username |
| ↳ `avatar` | string | Avatar hash | | ↳ `avatar` | string | Avatar hash |
| ↳ `id` | string | User ID |
| ↳ `username` | string | Username |
| ↳ `avatar` | string | Avatar hash |
| ↳ `nick` | string | Server nickname | | ↳ `nick` | string | Server nickname |
| ↳ `roles` | array | Array of role IDs | | ↳ `roles` | array | Array of role IDs |
| ↳ `joined_at` | string | When the member joined | | ↳ `joined_at` | string | When the member joined |
@@ -671,8 +697,8 @@ Update a member in a Discord server (e.g., change nickname)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to update, e.g., 123456789012345678 | | `userId` | string | Yes | The user ID to update |
| `nick` | string | No | New nickname for the member \(null to remove\) | | `nick` | string | No | New nickname for the member \(null to remove\) |
| `mute` | boolean | No | Whether to mute the member in voice channels | | `mute` | boolean | No | Whether to mute the member in voice channels |
| `deaf` | boolean | No | Whether to deafen the member in voice channels | | `deaf` | boolean | No | Whether to deafen the member in voice channels |
@@ -696,11 +722,11 @@ Create an invite link for a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to create an invite for, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to create an invite for |
| `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) | | `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) |
| `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) | | `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) |
| `temporary` | boolean | No | Whether invite grants temporary membership | | `temporary` | boolean | No | Whether invite grants temporary membership |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -724,7 +750,7 @@ Get information about a Discord invite
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `inviteCode` | string | Yes | The invite code to retrieve | | `inviteCode` | string | Yes | The invite code to retrieve |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -748,7 +774,7 @@ Delete a Discord invite
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `inviteCode` | string | Yes | The invite code to delete | | `inviteCode` | string | Yes | The invite code to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -765,9 +791,9 @@ Create a webhook in a Discord channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to create the webhook in, e.g., 123456789012345678 | | `channelId` | string | Yes | The Discord channel ID to create the webhook in |
| `name` | string | Yes | Name of the webhook \(1-80 characters\) | | `name` | string | Yes | Name of the webhook \(1-80 characters\) |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -789,11 +815,11 @@ Execute a Discord webhook to send a message
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `webhookId` | string | Yes | The webhook ID, e.g., 123456789012345678 | | `webhookId` | string | Yes | The webhook ID |
| `webhookToken` | string | Yes | The webhook token | | `webhookToken` | string | Yes | The webhook token |
| `content` | string | Yes | The message content to send | | `content` | string | Yes | The message content to send |
| `username` | string | No | Override the default username of the webhook | | `username` | string | No | Override the default username of the webhook |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -815,8 +841,8 @@ Get information about a Discord webhook
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `webhookId` | string | Yes | The webhook ID to retrieve, e.g., 123456789012345678 | | `webhookId` | string | Yes | The webhook ID to retrieve |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output
@@ -839,8 +865,8 @@ Delete a Discord webhook
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication | | `botToken` | string | Yes | The bot token for authentication |
| `webhookId` | string | Yes | The webhook ID to delete, e.g., 123456789012345678 | | `webhookId` | string | Yes | The webhook ID to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\), e.g., 123456789012345678 | | `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output #### Output

View File

@@ -256,7 +256,7 @@ Search for files and folders in Dropbox
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | The search query | | `query` | string | Yes | The search query |
| `path` | string | No | Dropbox folder path to limit search scope \(e.g., /folder/subfolder\) | | `path` | string | No | Limit search to a specific folder path |
| `fileExtensions` | string | No | Comma-separated list of file extensions to filter by \(e.g., pdf,xlsx\) | | `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\) | | `maxResults` | number | No | Maximum number of results to return \(default: 100\) |

View File

@@ -54,8 +54,8 @@ Get an item from a DynamoDB table by primary key
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `tableName` | string | Yes | DynamoDB table name |
| `key` | object | Yes | Primary key of the item to retrieve \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `key` | object | Yes | Primary key of the item to retrieve |
| `consistentRead` | boolean | No | Use strongly consistent read | | `consistentRead` | boolean | No | Use strongly consistent read |
#### Output #### Output
@@ -76,8 +76,8 @@ Put an item into a DynamoDB table
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `tableName` | string | Yes | DynamoDB table name |
| `item` | object | Yes | Item to put into the table \(e.g., \{"pk": "USER#123", "name": "John", "email": "john@example.com"\}\) | | `item` | object | Yes | Item to put into the table |
#### Output #### Output
@@ -97,13 +97,13 @@ Query items from a DynamoDB table using key conditions
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `tableName` | string | Yes | DynamoDB table name |
| `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk" or "pk = :pk AND sk BEGINS_WITH :prefix"\) | | `keyConditionExpression` | string | Yes | Key condition expression \(e.g., "pk = :pk"\) |
| `filterExpression` | string | No | Filter expression for results \(e.g., "age &gt; :minAge AND #status = :status"\) | | `filterExpression` | string | No | Filter expression for results |
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#status": "status"\}\) | | `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":pk": "USER#123", ":minAge": 18\}\) | | `expressionAttributeValues` | object | No | Expression attribute values |
| `indexName` | string | No | Secondary index name to query \(e.g., "GSI1", "email-index"\) | | `indexName` | string | No | Secondary index name to query |
| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Maximum number of items to return |
#### Output #### Output
@@ -124,12 +124,12 @@ Scan all items in a DynamoDB table
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `tableName` | string | Yes | DynamoDB table name |
| `filterExpression` | string | No | Filter expression for results \(e.g., "age &gt; :minAge AND #status = :status"\) | | `filterExpression` | string | No | Filter expression for results |
| `projectionExpression` | string | No | Attributes to retrieve \(e.g., "pk, sk, #name, email"\) | | `projectionExpression` | string | No | Attributes to retrieve |
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#status": "status"\}\) | | `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":minAge": 18, ":status": "active"\}\) | | `expressionAttributeValues` | object | No | Expression attribute values |
| `limit` | number | No | Maximum number of items to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Maximum number of items to return |
#### Output #### Output
@@ -150,12 +150,12 @@ Update an item in a DynamoDB table
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `tableName` | string | Yes | DynamoDB table name |
| `key` | object | Yes | Primary key of the item to update \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `key` | object | Yes | Primary key of the item to update |
| `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name, age = :age" or "SET #count = #count + :inc"\) | | `updateExpression` | string | Yes | Update expression \(e.g., "SET #name = :name"\) |
| `expressionAttributeNames` | object | No | Attribute name mappings for reserved words \(e.g., \{"#name": "name", "#count": "count"\}\) | | `expressionAttributeNames` | object | No | Attribute name mappings for reserved words |
| `expressionAttributeValues` | object | No | Expression attribute values \(e.g., \{":name": "John", ":age": 30, ":inc": 1\}\) | | `expressionAttributeValues` | object | No | Expression attribute values |
| `conditionExpression` | string | No | Condition that must be met for the update to succeed \(e.g., "attribute_exists\(pk\)" or "version = :expectedVersion"\) | | `conditionExpression` | string | No | Condition that must be met for the update to succeed |
#### Output #### Output
@@ -175,9 +175,9 @@ Delete an item from a DynamoDB table
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | Yes | DynamoDB table name \(e.g., "Users", "Orders"\) | | `tableName` | string | Yes | DynamoDB table name |
| `key` | object | Yes | Primary key of the item to delete \(e.g., \{"pk": "USER#123"\} or \{"pk": "ORDER#456", "sk": "ITEM#789"\}\) | | `key` | object | Yes | Primary key of the item to delete |
| `conditionExpression` | string | No | Condition that must be met for the delete to succeed \(e.g., "attribute_exists\(pk\)"\) | | `conditionExpression` | string | No | Condition that must be met for the delete to succeed |
#### Output #### 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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `tableName` | string | No | Optional table name to get detailed schema \(e.g., "Users", "Orders"\). If not provided, lists all tables. | | `tableName` | string | No | Optional table name to get detailed schema. If not provided, lists all tables. |
#### Output #### Output

View File

@@ -49,12 +49,11 @@ Search documents in Elasticsearch using Query DSL. Returns matching documents wi
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name to search \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name to search |
| `query` | string | No | Query DSL as JSON string. Example: \{"match":\{"title":"search term"\}\} or \{"bool":\{"must":\[...\]\}\} | | `query` | string | No | Query DSL as JSON string |
| `Example` | string | No | No description | | `from` | number | No | Starting offset for pagination \(default: 0\) |
| `from` | number | No | Starting offset for pagination \(e.g., 0, 10, 20\). Default: 0 | | `size` | number | No | Number of results to return \(default: 10\) |
| `size` | number | No | Number of results to return \(e.g., 10, 25, 100\). Default: 10 | | `sort` | string | No | Sort specification as JSON string |
| `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 | | `sourceIncludes` | string | No | Comma-separated list of fields to include in _source |
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source | | `sourceExcludes` | string | No | Comma-separated list of fields to exclude from _source |
| `trackTotalHits` | boolean | No | Track accurate total hit count \(default: true\) | | `trackTotalHits` | boolean | No | Track accurate total hit count \(default: true\) |
@@ -83,8 +82,8 @@ Index (create or update) a document in Elasticsearch.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Target index name \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Target index name |
| `documentId` | string | No | Document ID \(e.g., "abc123", "user_456"\). Auto-generated if not provided | | `documentId` | string | No | Document ID \(auto-generated if not provided\) |
| `document` | string | Yes | Document body as JSON string | | `document` | string | Yes | Document body as JSON string |
| `refresh` | string | No | Refresh policy: true, false, or wait_for | | `refresh` | string | No | Refresh policy: true, false, or wait_for |
@@ -112,8 +111,8 @@ Retrieve a document by ID from Elasticsearch.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name |
| `documentId` | string | Yes | Document ID to retrieve \(e.g., "abc123", "user_456"\) | | `documentId` | string | Yes | Document ID to retrieve |
| `sourceIncludes` | string | No | Comma-separated list of fields to include | | `sourceIncludes` | string | No | Comma-separated list of fields to include |
| `sourceExcludes` | string | No | Comma-separated list of fields to exclude | | `sourceExcludes` | string | No | Comma-separated list of fields to exclude |
@@ -142,8 +141,8 @@ Partially update a document in Elasticsearch using doc merge.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name |
| `documentId` | string | Yes | Document ID to update \(e.g., "abc123", "user_456"\) | | `documentId` | string | Yes | Document ID to update |
| `document` | string | Yes | Partial document to merge as JSON string | | `document` | string | Yes | Partial document to merge as JSON string |
| `retryOnConflict` | number | No | Number of retries on version conflict | | `retryOnConflict` | number | No | Number of retries on version conflict |
@@ -171,8 +170,8 @@ Delete a document from Elasticsearch by ID.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name |
| `documentId` | string | Yes | Document ID to delete \(e.g., "abc123", "user_456"\) | | `documentId` | string | Yes | Document ID to delete |
| `refresh` | string | No | Refresh policy: true, false, or wait_for | | `refresh` | string | No | Refresh policy: true, false, or wait_for |
#### Output #### Output
@@ -199,9 +198,8 @@ Perform multiple index, create, delete, or update operations in a single request
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | No | Default index for operations \(e.g., "products", "logs-2024"\) | | `index` | string | No | Default index for operations that do not specify one |
| `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 | | `operations` | string | Yes | Bulk operations as NDJSON string \(newline-delimited JSON\) |
| `Example` | string | No | No description |
| `refresh` | string | No | Refresh policy: true, false, or wait_for | | `refresh` | string | No | Refresh policy: true, false, or wait_for |
#### Output #### Output
@@ -227,9 +225,8 @@ Count documents matching a query in Elasticsearch.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name to count documents in \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name to count documents in |
| `query` | string | No | Query DSL to filter documents \(JSON string\). Example: \{"match":\{"status":"active"\}\} | | `query` | string | No | Optional query to filter documents \(JSON string\) |
| `Example` | string | No | No description |
#### Output #### Output
@@ -253,7 +250,7 @@ Create a new index with optional settings and mappings.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name to create \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name to create |
| `settings` | string | No | Index settings as JSON string | | `settings` | string | No | Index settings as JSON string |
| `mappings` | string | No | Index mappings as JSON string | | `mappings` | string | No | Index mappings as JSON string |
@@ -280,7 +277,7 @@ Delete an index and all its documents. This operation is irreversible.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name to delete \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name to delete |
#### Output #### Output
@@ -303,7 +300,7 @@ Retrieve index information including settings, mappings, and aliases.
| `apiKey` | string | No | Elasticsearch API key | | `apiKey` | string | No | Elasticsearch API key |
| `username` | string | No | Username for basic auth | | `username` | string | No | Username for basic auth |
| `password` | string | No | Password for basic auth | | `password` | string | No | Password for basic auth |
| `index` | string | Yes | Index name to retrieve info for \(e.g., "products", "logs-2024"\) | | `index` | string | Yes | Index name to retrieve info for |
#### Output #### Output

View File

@@ -41,11 +41,9 @@ Convert TTS using ElevenLabs voices
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `text` | string | Yes | The text to convert to speech \(e.g., "Hello, welcome to our service!"\) | | `text` | string | Yes | The text to convert to speech |
| `voiceId` | string | Yes | The ID of the voice to use \(e.g., "21m00Tcm4TlvDq8ikWAM" for Rachel\) | | `voiceId` | string | Yes | The ID of the voice to use |
| `modelId` | string | No | The ID of the model to use \(e.g., "eleven_multilingual_v2", "eleven_turbo_v2"\). Defaults to eleven_monolingual_v1 | | `modelId` | string | No | The ID of the model to use \(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 | | `apiKey` | string | Yes | Your ElevenLabs API key |
#### Output #### Output

View File

@@ -44,11 +44,11 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | The search query to execute | | `query` | string | Yes | The search query to execute |
| `numResults` | number | No | Number of results to return \(e.g., 5, 10, 25\). Default: 10, max: 25 | | `numResults` | number | No | Number of results to return \(default: 10, max: 25\) |
| `useAutoprompt` | boolean | No | Whether to use autoprompt to improve the query \(true or false\). Default: false | | `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" | | `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"\) | | `includeDomains` | string | No | Comma-separated list of domains to include in results |
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results \(e.g., "reddit.com, pinterest.com"\) | | `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
| `category` | string | No | Filter by category: company, research paper, news, pdf, github, tweet, personal site, linkedin profile, financial report | | `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\) | | `text` | boolean | No | Include full text content in results \(default: false\) |
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) | | `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
@@ -66,7 +66,7 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
| ↳ `publishedDate` | string | Date when the content was published | | ↳ `publishedDate` | string | Date when the content was published |
| ↳ `author` | string | The author of the content | | ↳ `author` | string | The author of the content |
| ↳ `summary` | string | A brief summary of the content | | ↳ `summary` | string | A brief summary of the content |
| ↳ `favicon` | string | URL of the site's favicon | | ↳ `favicon` | string | URL of the site |
| ↳ `image` | string | URL of a representative image from the page | | ↳ `image` | string | URL of a representative image from the page |
| ↳ `text` | string | Text snippet or full content from the page | | ↳ `text` | string | Text snippet or full content from the page |
| ↳ `score` | number | Relevance score for the search result | | ↳ `score` | number | Relevance score for the search result |
@@ -107,10 +107,10 @@ Find webpages similar to a given URL using Exa AI. Returns a list of similar lin
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The URL to find similar links for | | `url` | string | Yes | The URL to find similar links for |
| `numResults` | number | No | Number of similar links to return \(e.g., 5, 10, 25\). Default: 10, max: 25 | | `numResults` | number | No | Number of similar links to return \(default: 10, max: 25\) |
| `text` | boolean | No | Whether to include the full text of the similar pages | | `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 \(e.g., "github.com, stackoverflow.com"\) | | `includeDomains` | string | No | Comma-separated list of domains to include in results |
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results \(e.g., "reddit.com, pinterest.com"\) | | `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
| `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) | | `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) |
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) | | `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) | | `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |

View File

@@ -50,7 +50,7 @@ Extract structured content from web pages with comprehensive metadata support. C
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The URL to scrape content from \(e.g., "https://example.com/page"\) | | `url` | string | Yes | The URL to scrape content from |
| `scrapeOptions` | json | No | Options for content scraping | | `scrapeOptions` | json | No | Options for content scraping |
| `apiKey` | string | Yes | Firecrawl API key | | `apiKey` | string | Yes | Firecrawl API key |
@@ -61,20 +61,6 @@ Extract structured content from web pages with comprehensive metadata support. C
| `markdown` | string | Page content in markdown format | | `markdown` | string | Page content in markdown format |
| `html` | string | Raw HTML content of the page | | `html` | string | Raw HTML content of the page |
| `metadata` | object | Page metadata including SEO and Open Graph information | | `metadata` | object | Page metadata including SEO and Open Graph information |
| ↳ `title` | string | Page title |
| ↳ `description` | string | Page meta description |
| ↳ `language` | string | Page language code \(e.g., "en"\) |
| ↳ `sourceURL` | string | Original source URL that was scraped |
| ↳ `statusCode` | number | HTTP status code of the response |
| ↳ `keywords` | string | Page meta keywords |
| ↳ `robots` | string | Robots meta directive \(e.g., "follow, index"\) |
| ↳ `ogTitle` | string | Open Graph title |
| ↳ `ogDescription` | string | Open Graph description |
| ↳ `ogUrl` | string | Open Graph URL |
| ↳ `ogImage` | string | Open Graph image URL |
| ↳ `ogLocaleAlternate` | array | Alternate locale versions for Open Graph |
| ↳ `ogSiteName` | string | Open Graph site name |
| ↳ `error` | string | Error message if scrape failed |
### `firecrawl_search` ### `firecrawl_search`
@@ -91,21 +77,7 @@ Search for information on the web using Firecrawl
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `data` | array | Search results data with scraped content and metadata | | `data` | array | Search results data |
| ↳ `title` | string | Search result title from search engine |
| ↳ `description` | string | Search result description/snippet from search engine |
| ↳ `url` | string | URL of the search result |
| ↳ `markdown` | string | Page content in markdown \(when scrapeOptions.formats includes "markdown"\) |
| ↳ `html` | string | Processed HTML content \(when scrapeOptions.formats includes "html"\) |
| ↳ `rawHtml` | string | Unprocessed raw HTML \(when scrapeOptions.formats includes "rawHtml"\) |
| ↳ `links` | array | Links found on the page \(when scrapeOptions.formats includes "links"\) |
| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours, when scrapeOptions.formats includes "screenshot"\) |
| ↳ `metadata` | object | Metadata about the search result page |
| ↳ `title` | string | Page title |
| ↳ `description` | string | Page meta description |
| ↳ `sourceURL` | string | Original source URL |
| ↳ `statusCode` | number | HTTP status code |
| ↳ `error` | string | Error message if scrape failed |
### `firecrawl_crawl` ### `firecrawl_crawl`
@@ -115,12 +87,8 @@ Crawl entire websites and extract structured content from all accessible pages
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The website URL to crawl \(e.g., "https://example.com" or "https://docs.example.com/guide"\) | | `url` | string | Yes | The website URL to crawl |
| `limit` | number | No | Maximum number of pages to crawl \(e.g., 50, 100, 500\). Default: 100 | | `limit` | number | No | Maximum number of pages to crawl \(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 | | `onlyMainContent` | boolean | No | Extract only main content from pages |
| `apiKey` | string | Yes | Firecrawl API Key | | `apiKey` | string | Yes | Firecrawl API Key |
@@ -130,17 +98,18 @@ Crawl entire websites and extract structured content from all accessible pages
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pages` | array | Array of crawled pages with their content and metadata | | `pages` | array | Array of crawled pages with their content and metadata |
| ↳ `markdown` | string | Page content in markdown format | | ↳ `markdown` | string | Page content in markdown format |
| ↳ `html` | string | Processed HTML content of the page | | ↳ `html` | string | Page HTML content |
| ↳ `rawHtml` | string | Unprocessed raw HTML content | | ↳ `metadata` | object | Page metadata |
| ↳ `links` | array | Array of links found on the page |
| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours\) |
| ↳ `metadata` | object | Page metadata from crawl operation |
| ↳ `title` | string | Page title | | ↳ `title` | string | Page title |
| ↳ `description` | string | Page meta description | | ↳ `description` | string | Page description |
| ↳ `language` | string | Page language code | | ↳ `language` | string | Page language |
| ↳ `sourceURL` | string | Original source URL | | ↳ `sourceURL` | string | Source URL of the page |
| ↳ `statusCode` | number | HTTP status code |
| ↳ `title` | string | Page title |
| ↳ `description` | string | Page description |
| ↳ `language` | string | Page language |
| ↳ `sourceURL` | string | Source URL of the page |
| ↳ `statusCode` | number | HTTP status code | | ↳ `statusCode` | number | HTTP status code |
| ↳ `ogLocaleAlternate` | array | Alternate locale versions |
| `total` | number | Total number of pages found during crawl | | `total` | number | Total number of pages found during crawl |
| `creditsUsed` | number | Number of credits consumed by the crawl operation | | `creditsUsed` | number | Number of credits consumed by the crawl operation |
@@ -152,12 +121,12 @@ Get a complete list of URLs from any website quickly and reliably. Useful for di
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The base URL to map and discover links from \(e.g., "https://example.com"\) | | `url` | string | Yes | The base URL to map and discover links from |
| `search` | string | No | Filter results by relevance to a search term \(e.g., "blog"\) | | `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" | | `sitemap` | string | No | Controls sitemap usage: "skip", "include" \(default\), or "only" |
| `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) | | `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) |
| `ignoreQueryParameters` | boolean | No | Exclude URLs containing query strings \(default: true\) | | `ignoreQueryParameters` | boolean | No | Exclude URLs containing query strings \(default: true\) |
| `limit` | number | No | Maximum number of links to return \(e.g., 100, 1000, 5000\). Max: 100,000, default: 5,000 | | `limit` | number | No | Maximum number of links to return \(max: 100,000, default: 5,000\) |
| `timeout` | number | No | Request timeout in milliseconds | | `timeout` | number | No | Request timeout in milliseconds |
| `location` | json | No | Geographic context for proxying \(country, languages\) | | `location` | json | No | Geographic context for proxying \(country, languages\) |
| `apiKey` | string | Yes | Firecrawl API key | | `apiKey` | string | Yes | Firecrawl API key |
@@ -177,7 +146,7 @@ Extract structured data from entire webpages using natural language prompts and
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `urls` | json | Yes | Array of URLs to extract data from \(e.g., \["https://example.com/page1", "https://example.com/page2"\] or \["https://example.com/*"\]\) | | `urls` | json | Yes | Array of URLs to extract data from \(supports glob format\) |
| `prompt` | string | No | Natural language guidance for the extraction process | | `prompt` | string | No | Natural language guidance for the extraction process |
| `schema` | json | No | JSON Schema defining the structure of data to extract | | `schema` | json | No | JSON Schema defining the structure of data to extract |
| `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) | | `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) |
@@ -204,7 +173,7 @@ Autonomous web data extraction agent. Searches and gathers information based on
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `prompt` | string | Yes | Natural language description of the data to extract \(max 10,000 characters\) | | `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 \(e.g., \["https://example.com", "https://docs.example.com"\]\) | | `urls` | json | No | Optional array of URLs to focus the agent on |
| `schema` | json | No | JSON Schema defining the structure of data to extract | | `schema` | json | No | JSON Schema defining the structure of data to extract |
| `maxCredits` | number | No | Maximum credits to spend on this agent task | | `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 | | `strictConstrainToURLs` | boolean | No | If true, agent will only visit URLs provided in the urls array |

View File

@@ -44,13 +44,13 @@ List meeting transcripts from Fireflies.ai with optional filtering
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Fireflies API key | | `apiKey` | string | Yes | Fireflies API key |
| `keyword` | string | No | Search keyword in meeting title or transcript \(e.g., "quarterly review"\) | | `keyword` | string | No | Search keyword in meeting title or transcript |
| `fromDate` | string | No | Filter transcripts from this date \(ISO 8601 format\) | | `fromDate` | string | No | Filter transcripts from this date \(ISO 8601 format\) |
| `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) | | `toDate` | string | No | Filter transcripts until this date \(ISO 8601 format\) |
| `hostEmail` | string | No | Filter by meeting host email | | `hostEmail` | string | No | Filter by meeting host email |
| `participants` | string | No | Filter by participant emails \(comma-separated\) | | `participants` | string | No | Filter by participant emails \(comma-separated\) |
| `limit` | number | No | Maximum number of transcripts to return \(e.g., 10, max 50\) | | `limit` | number | No | Maximum number of transcripts to return \(max 50\) |
| `skip` | number | No | Number of transcripts to skip for pagination \(e.g., 0, 10, 20\) | | `skip` | number | No | Number of transcripts to skip for pagination |
#### Output #### Output
@@ -68,7 +68,7 @@ Get a single transcript with full details including summary, action items, and a
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Fireflies API key | | `apiKey` | string | Yes | Fireflies API key |
| `transcriptId` | string | Yes | The transcript ID to retrieve \(e.g., "abc123def456"\) | | `transcriptId` | string | Yes | The transcript ID to retrieve |
#### Output #### Output
@@ -97,7 +97,7 @@ Get user information from Fireflies.ai. Returns current user if no ID specified.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Fireflies API key | | `apiKey` | string | Yes | Fireflies API key |
| `userId` | string | No | User ID to retrieve \(e.g., "user_abc123", defaults to API key owner\) | | `userId` | string | No | User ID to retrieve \(optional, defaults to API key owner\) |
#### Output #### Output
@@ -164,7 +164,7 @@ Delete a transcript from Fireflies.ai
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Fireflies API key | | `apiKey` | string | Yes | Fireflies API key |
| `transcriptId` | string | Yes | The transcript ID to delete \(e.g., "abc123def456"\) | | `transcriptId` | string | Yes | The transcript ID to delete |
#### Output #### Output
@@ -202,7 +202,7 @@ Create a soundbite/highlight from a specific time range in a transcript
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Fireflies API key | | `apiKey` | string | Yes | Fireflies API key |
| `transcriptId` | string | Yes | ID of the transcript to create the bite from \(e.g., "abc123def456"\) | | `transcriptId` | string | Yes | ID of the transcript to create the bite from |
| `startTime` | number | Yes | Start time of the bite in seconds | | `startTime` | number | Yes | Start time of the bite in seconds |
| `endTime` | number | Yes | End 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\) | | `name` | string | No | Name for the bite \(max 256 characters\) |
@@ -227,10 +227,10 @@ List soundbites/highlights from Fireflies.ai
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Fireflies API key | | `apiKey` | string | Yes | Fireflies API key |
| `transcriptId` | string | No | Filter bites for a specific transcript \(e.g., "abc123def456"\) | | `transcriptId` | string | No | Filter bites for a specific transcript |
| `mine` | boolean | No | Only return bites owned by the API key owner \(default: true\) | | `mine` | boolean | No | Only return bites owned by the API key owner \(default: true\) |
| `limit` | number | No | Maximum number of bites to return \(e.g., 10, max 50\) | | `limit` | number | No | Maximum number of bites to return \(max 50\) |
| `skip` | number | No | Number of bites to skip for pagination \(e.g., 0, 10, 20\) | | `skip` | number | No | Number of bites to skip for pagination |
#### Output #### Output

File diff suppressed because it is too large Load Diff

View File

@@ -96,11 +96,11 @@ Read emails from Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `messageId` | string | No | Gmail message ID to read \(e.g., 18f1a2b3c4d5e6f7\) | | `messageId` | string | No | ID of the message to read |
| `folder` | string | No | Folder/label to read emails from \(e.g., INBOX, SENT, DRAFT, TRASH, SPAM, or custom label name\) | | `folder` | string | No | Folder/label to read emails from |
| `unreadOnly` | boolean | No | Set to true to only retrieve unread messages | | `unreadOnly` | boolean | No | Only retrieve unread messages |
| `maxResults` | number | No | Maximum number of messages to retrieve \(default: 1, max: 10\) | | `maxResults` | number | No | Maximum number of messages to retrieve \(default: 1, max: 10\) |
| `includeAttachments` | boolean | No | Set to true to download and include email attachments | | `includeAttachments` | boolean | No | Download and include email attachments |
#### Output #### Output
@@ -128,7 +128,7 @@ Search emails in Gmail. Returns API-aligned fields only.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query for emails | | `query` | string | Yes | Search query for emails |
| `maxResults` | number | No | Maximum number of results to return \(e.g., 10, 25, 50\) | | `maxResults` | number | No | Maximum number of results to return |
#### Output #### Output

View File

@@ -44,7 +44,7 @@ Create a new event in Google Calendar. Returns API-aligned fields only.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `summary` | string | Yes | Event title/summary | | `summary` | string | Yes | Event title/summary |
| `description` | string | No | Event description | | `description` | string | No | Event description |
| `location` | string | No | Event location | | `location` | string | No | Event location |
@@ -78,7 +78,7 @@ List events from Google Calendar. Returns API-aligned fields only.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `timeMin` | string | No | Lower bound for events \(RFC3339 timestamp, e.g., 2025-06-03T00:00:00Z\) | | `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\) | | `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\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `eventId` | string | Yes | Google Calendar event ID to retrieve | | `eventId` | string | Yes | Event ID to retrieve |
#### Output #### Output
@@ -127,8 +127,8 @@ Update an existing event in Google Calendar. Returns API-aligned fields only.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `eventId` | string | Yes | Google Calendar event ID to update | | `eventId` | string | Yes | Event ID to update |
| `summary` | string | No | New event title/summary | | `summary` | string | No | New event title/summary |
| `description` | string | No | New event description | | `description` | string | No | New event description |
| `location` | string | No | New event location | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `eventId` | string | Yes | Google Calendar event ID to delete | | `eventId` | string | Yes | Event ID to delete |
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | | `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
#### Output #### Output
@@ -181,9 +181,9 @@ Move an event to a different calendar. Returns API-aligned fields only.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Source Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Source calendar ID \(defaults to primary\) |
| `eventId` | string | Yes | Google Calendar event ID to move | | `eventId` | string | Yes | Event ID to move |
| `destinationCalendarId` | string | Yes | Destination Google Calendar ID | | `destinationCalendarId` | string | Yes | Destination calendar ID |
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | | `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none |
#### Output #### Output
@@ -210,7 +210,7 @@ Get instances of a recurring event from Google Calendar. Returns API-aligned fie
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `eventId` | string | Yes | Recurring event ID to get instances of | | `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\) | | `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\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `text` | string | Yes | Natural language text describing the event \(e.g., "Meeting with John tomorrow at 3pm"\) | | `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\) | | `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 | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `calendarId` | string | No | Google Calendar ID \(e.g., primary or calendar@group.calendar.google.com\) | | `calendarId` | string | No | Calendar ID \(defaults to primary\) |
| `eventId` | string | Yes | Google Calendar event ID to invite attendees to | | `eventId` | string | Yes | Event ID to invite attendees to |
| `attendees` | array | Yes | Array of attendee email addresses to invite | | `attendees` | array | Yes | Array of attendee email addresses to invite |
| `sendUpdates` | string | No | How to send updates to attendees: all, externalOnly, or none | | `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\) | | `replaceExisting` | boolean | No | Whether to replace existing attendees or add to them \(defaults to false\) |

View File

@@ -79,7 +79,7 @@ Read content from a Google Docs document
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `documentId` | string | Yes | Google Docs document ID | | `documentId` | string | Yes | The ID of the document to read |
#### Output #### Output
@@ -124,7 +124,7 @@ Create a new Google Docs document
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `title` | string | Yes | The title of the document to create | | `title` | string | Yes | The title of the document to create |
| `content` | string | No | The content of the document to create | | `content` | string | No | The content of the document to create |
| `folderSelector` | string | No | Google Drive folder ID to create the document in \(e.g., 1ABCxyz...\) | | `folderSelector` | string | No | Select the folder to create the document in |
| `folderId` | string | No | The ID of the folder to create the document in \(internal use\) | | `folderId` | string | No | The ID of the folder to create the document in \(internal use\) |
#### Output #### Output

View File

@@ -54,7 +54,7 @@ List files and folders in Google Drive with complete metadata
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `folderSelector` | string | No | Google Drive folder ID to list files from \(e.g., 1ABCxyz...\) | | `folderSelector` | string | No | Select the folder to list files from |
| `folderId` | string | No | The ID of the folder to list files from \(internal use\) | | `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. | | `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\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `fileName` | string | Yes | Name of the folder to create | | `fileName` | string | Yes | Name of the folder to create |
| `folderSelector` | string | No | Google Drive parent folder ID to create the folder in \(e.g., 1ABCxyz...\) | | `folderSelector` | string | No | Select the parent folder to create the folder in |
| `folderId` | string | No | ID of the parent folder \(internal use\) | | `folderId` | string | No | ID of the parent folder \(internal use\) |
#### Output #### Output
@@ -225,7 +225,7 @@ Upload a file to Google Drive with complete metadata returned
| `file` | file | No | Binary file to upload \(UserFile object\) | | `file` | file | No | Binary file to upload \(UserFile object\) |
| `content` | string | No | Text content to upload \(use this OR file, not both\) | | `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\) | | `mimeType` | string | No | The MIME type of the file to upload \(auto-detected from file if not provided\) |
| `folderSelector` | string | No | Google Drive folder ID to upload the file to \(e.g., 1ABCxyz...\) | | `folderSelector` | string | No | Select the folder to upload the file to |
| `folderId` | string | No | The ID of the folder to upload the file to \(internal use\) | | `folderId` | string | No | The ID of the folder to upload the file to \(internal use\) |
#### Output #### Output

View File

@@ -43,8 +43,8 @@ Retrieve a single response or list responses from a Google Form
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID | | `formId` | string | Yes | The ID of the Google Form |
| `responseId` | string | No | Response ID - if provided, returns this specific response | | `responseId` | string | No | If provided, returns this specific response |
| `pageSize` | number | No | Maximum number of responses to return \(service may return fewer\). Defaults to 5000. | | `pageSize` | number | No | Maximum number of responses to return \(service may return fewer\). Defaults to 5000. |
#### Output #### Output
@@ -71,7 +71,7 @@ Retrieve a form structure including its items, settings, and metadata
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID to retrieve | | `formId` | string | Yes | The ID of the Google Form to retrieve |
#### Output #### Output
@@ -121,7 +121,7 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID | | `formId` | string | Yes | The ID of the Google Form to update |
| `requests` | json | Yes | Array of update requests \(updateFormInfo, updateSettings, createItem, updateItem, moveItem, deleteItem\) | | `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 | | `includeFormInResponse` | boolean | No | Whether to return the updated form in the response |
@@ -139,10 +139,25 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
| ↳ `title` | string | The form title visible to responders | | ↳ `title` | string | The form title visible to responders |
| ↳ `description` | string | The form description | | ↳ `description` | string | The form description |
| ↳ `documentTitle` | string | The document title visible in Drive | | ↳ `documentTitle` | string | The document title visible in Drive |
| ↳ `title` | string | Item title |
| ↳ `description` | string | Item description |
| ↳ `documentTitle` | string | The document title visible in Drive |
| ↳ `settings` | object | Form settings | | ↳ `settings` | object | Form settings |
| ↳ `quizSettings` | object | Quiz settings | | ↳ `quizSettings` | object | Quiz settings |
| ↳ `isQuiz` | boolean | Whether the form is a quiz | | ↳ `isQuiz` | boolean | Whether the form is a quiz |
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
| ↳ `emailCollectionType` | string | Email collection type | | ↳ `emailCollectionType` | string | Email collection type |
| ↳ `quizSettings` | object | Quiz settings |
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
| ↳ `isQuiz` | boolean | Whether the form is a quiz |
| ↳ `emailCollectionType` | string | Email collection type |
| ↳ `itemId` | string | Item ID |
| ↳ `questionItem` | json | Question item configuration |
| ↳ `questionGroupItem` | json | Question group configuration |
| ↳ `pageBreakItem` | json | Page break configuration |
| ↳ `textItem` | json | Text item configuration |
| ↳ `imageItem` | json | Image item configuration |
| ↳ `videoItem` | json | Video item configuration |
| ↳ `revisionId` | string | The revision ID of the form | | ↳ `revisionId` | string | The revision ID of the form |
| ↳ `responderUri` | string | The URI to share with responders | | ↳ `responderUri` | string | The URI to share with responders |
| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet | | ↳ `linkedSheetId` | string | The ID of the linked Google Sheet |
@@ -150,6 +165,13 @@ Apply multiple updates to a form (add items, update info, change settings, etc.)
| ↳ `publishState` | object | Current publish state | | ↳ `publishState` | object | Current publish state |
| ↳ `isPublished` | boolean | Whether the form is published | | ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses | | ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `publishState` | object | Current publish state |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses |
### `google_forms_set_publish_settings` ### `google_forms_set_publish_settings`
@@ -159,7 +181,7 @@ Update the publish settings of a form (publish/unpublish, accept responses)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID | | `formId` | string | Yes | The ID of the Google Form |
| `isPublished` | boolean | Yes | Whether the form is published and visible to others | | `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\) | | `isAcceptingResponses` | boolean | No | Whether the form accepts responses \(forced to false if isPublished is false\) |
@@ -172,6 +194,8 @@ Update the publish settings of a form (publish/unpublish, accept responses)
| ↳ `publishState` | object | The publish state | | ↳ `publishState` | object | The publish state |
| ↳ `isPublished` | boolean | Whether the form is published | | ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses | | ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
| ↳ `isPublished` | boolean | Whether the form is published |
| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses |
### `google_forms_create_watch` ### `google_forms_create_watch`
@@ -181,7 +205,7 @@ Create a notification watch for form changes (schema changes or new responses)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID to watch | | `formId` | string | Yes | The ID of the Google Form to watch |
| `eventType` | string | Yes | Event type to watch: SCHEMA \(form changes\) or RESPONSES \(new submissions\) | | `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\}\) | | `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\) | | `watchId` | string | No | Custom watch ID \(4-63 chars, lowercase letters, numbers, hyphens\) |
@@ -205,7 +229,7 @@ List all notification watches for a form
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID | | `formId` | string | Yes | The ID of the Google Form |
#### Output #### Output
@@ -226,8 +250,8 @@ Delete a notification watch from a form
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID | | `formId` | string | Yes | The ID of the Google Form |
| `watchId` | string | Yes | Watch ID to delete | | `watchId` | string | Yes | The ID of the watch to delete |
#### Output #### Output
@@ -243,8 +267,8 @@ Renew a notification watch for another 7 days
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `formId` | string | Yes | Google Forms form ID | | `formId` | string | Yes | The ID of the Google Form |
| `watchId` | string | Yes | Watch ID to renew | | `watchId` | string | Yes | The ID of the watch to renew |
#### Output #### Output

View File

@@ -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 | | `customer` | string | No | Customer ID or "my_customer" for the authenticated user\'s domain |
| `domain` | string | No | Domain name to filter groups by | | `domain` | string | No | Domain name to filter groups by |
| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 | | `maxResults` | number | No | Maximum number of results to return \(1-200\) |
| `pageToken` | string | No | Token for fetching the next page of results | | `pageToken` | string | No | Token for pagination |
| `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) | | `query` | string | No | Search query to filter groups \(e.g., "email:admin*"\) |
#### Output #### Output
@@ -47,7 +47,7 @@ Get details of a specific Google Group by email or group ID
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
#### Output #### Output
@@ -63,8 +63,8 @@ Create a new Google Group in the domain
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `email` | string | Yes | Email address for the new group \(e.g., team@example.com\) | | `email` | string | Yes | Email address for the new group \(e.g., team@yourdomain.com\) |
| `name` | string | Yes | Display name for the group \(e.g., Engineering Team\) | | `name` | string | Yes | Display name for the group |
| `description` | string | No | Description of the group | | `description` | string | No | Description of the group |
#### Output #### Output
@@ -81,10 +81,10 @@ Update an existing Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `name` | string | No | New display name for the group \(e.g., Engineering Team\) | | `name` | string | No | New display name for the group |
| `description` | string | No | New description for the group | | `description` | string | No | New description for the group |
| `email` | string | No | New email address for the group \(e.g., newteam@example.com\) | | `email` | string | No | New email address for the group |
#### Output #### Output
@@ -100,7 +100,7 @@ Delete a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier to delete. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID to delete |
#### Output #### Output
@@ -116,9 +116,9 @@ List all members of a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `maxResults` | number | No | Maximum number of results to return \(1-200\). Example: 50 | | `maxResults` | number | No | Maximum number of results to return \(1-200\) |
| `pageToken` | string | No | Token for fetching the next page of results | | `pageToken` | string | No | Token for pagination |
| `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) | | `roles` | string | No | Filter by roles \(comma-separated: OWNER, MANAGER, MEMBER\) |
#### Output #### Output
@@ -136,8 +136,8 @@ Get details of a specific member in a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID | | `memberKey` | string | Yes | Member email address or unique member ID |
#### Output #### Output
@@ -153,9 +153,9 @@ Add a new member to a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `email` | string | Yes | Email address of the member to add \(e.g., user@example.com\) | | `email` | string | Yes | Email address of the member to add |
| `role` | string | No | Role for the member: MEMBER, MANAGER, or OWNER. Defaults to MEMBER | | `role` | string | No | Role for the member \(MEMBER, MANAGER, or OWNER\). Defaults to MEMBER. |
#### Output #### Output
@@ -171,8 +171,8 @@ Remove a member from a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or 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 | | `memberKey` | string | Yes | Email address or unique ID of the member to remove |
#### Output #### Output
@@ -188,9 +188,9 @@ Update a member
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `memberKey` | string | Yes | Member identifier. Can be the member email address \(e.g., user@example.com\) or the unique member ID | | `memberKey` | string | Yes | Member email address or unique member ID |
| `role` | string | Yes | New role for the member: MEMBER, MANAGER, or OWNER | | `role` | string | Yes | New role for the member \(MEMBER, MANAGER, or OWNER\) |
#### Output #### Output
@@ -206,8 +206,8 @@ Check if a user is a member of a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or 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 | | `memberKey` | string | Yes | Member email address or unique member ID to check |
#### Output #### Output
@@ -223,7 +223,7 @@ List all email aliases for a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
#### Output #### Output
@@ -231,7 +231,7 @@ List all email aliases for a Google Group
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `aliases` | array | List of email aliases for the group | | `aliases` | array | List of email aliases for the group |
| ↳ `id` | string | Unique group identifier | | ↳ `id` | string | Unique group identifier |
| ↳ `primaryEmail` | string | Group's primary email address | | ↳ `primaryEmail` | string | Group |
| ↳ `alias` | string | Alias email address | | ↳ `alias` | string | Alias email address |
| ↳ `kind` | string | API resource type | | ↳ `kind` | string | API resource type |
| ↳ `etag` | string | Resource version identifier | | ↳ `etag` | string | Resource version identifier |
@@ -244,7 +244,7 @@ Add an email alias to a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `alias` | string | Yes | The email alias to add to the group | | `alias` | string | Yes | The email alias to add to the group |
#### Output #### Output
@@ -252,7 +252,7 @@ Add an email alias to a Google Group
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `id` | string | Unique group identifier | | `id` | string | Unique group identifier |
| `primaryEmail` | string | Group's primary email address | | `primaryEmail` | string | Group |
| `alias` | string | The alias that was added | | `alias` | string | The alias that was added |
| `kind` | string | API resource type | | `kind` | string | API resource type |
| `etag` | string | Resource version identifier | | `etag` | string | Resource version identifier |
@@ -265,7 +265,7 @@ Remove an email alias from a Google Group
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupKey` | string | Yes | Group identifier. Can be the group email address \(e.g., team@example.com\) or the unique group ID | | `groupKey` | string | Yes | Group email address or unique group ID |
| `alias` | string | Yes | The email alias to remove from the group | | `alias` | string | Yes | The email alias to remove from the group |
#### Output #### Output
@@ -282,13 +282,13 @@ Get the settings for a Google Group including access permissions, moderation, an
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupEmail` | string | Yes | The email address of the group \(e.g., team@example.com\) | | `groupEmail` | string | Yes | The email address of the group |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `email` | string | The group's email address | | `email` | string | The group |
| `name` | string | The group name \(max 75 characters\) | | `name` | string | The group name \(max 75 characters\) |
| `description` | string | The group description \(max 4096 characters\) | | `description` | string | The group description \(max 4096 characters\) |
| `whoCanJoin` | string | Who can join the group \(ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN\) | | `whoCanJoin` | string | Who can join the group \(ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN\) |
@@ -297,7 +297,7 @@ Get the settings for a Google Group including access permissions, moderation, an
| `whoCanPostMessage` | string | Who can post messages to the group | | `whoCanPostMessage` | string | Who can post messages to the group |
| `allowExternalMembers` | string | Whether external users can be members | | `allowExternalMembers` | string | Whether external users can be members |
| `allowWebPosting` | string | Whether web posting is allowed | | `allowWebPosting` | string | Whether web posting is allowed |
| `primaryLanguage` | string | The group's primary language | | `primaryLanguage` | string | The group |
| `isArchived` | string | Whether messages are archived | | `isArchived` | string | Whether messages are archived |
| `archiveOnly` | string | Whether the group is archive-only \(inactive\) | | `archiveOnly` | string | Whether the group is archive-only \(inactive\) |
| `messageModerationLevel` | string | Message moderation level | | `messageModerationLevel` | string | Message moderation level |
@@ -330,7 +330,7 @@ Update the settings for a Google Group including access permissions, moderation,
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `groupEmail` | string | Yes | The email address of the group \(e.g., team@example.com\) | | `groupEmail` | string | Yes | The email address of the group |
| `name` | string | No | The group name \(max 75 characters\) | | `name` | string | No | The group name \(max 75 characters\) |
| `description` | string | No | The group description \(max 4096 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 | | `whoCanJoin` | string | No | Who can join: ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN |
@@ -368,7 +368,7 @@ Update the settings for a Google Group including access permissions, moderation,
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `email` | string | The group's email address | | `email` | string | The group |
| `name` | string | The group name | | `name` | string | The group name |
| `description` | string | The group description | | `description` | string | The group description |
| `whoCanJoin` | string | Who can join the group | | `whoCanJoin` | string | Who can join the group |
@@ -377,7 +377,7 @@ Update the settings for a Google Group including access permissions, moderation,
| `whoCanPostMessage` | string | Who can post messages to the group | | `whoCanPostMessage` | string | Who can post messages to the group |
| `allowExternalMembers` | string | Whether external users can be members | | `allowExternalMembers` | string | Whether external users can be members |
| `allowWebPosting` | string | Whether web posting is allowed | | `allowWebPosting` | string | Whether web posting is allowed |
| `primaryLanguage` | string | The group's primary language | | `primaryLanguage` | string | The group |
| `isArchived` | string | Whether messages are archived | | `isArchived` | string | Whether messages are archived |
| `archiveOnly` | string | Whether the group is archive-only | | `archiveOnly` | string | Whether the group is archive-only |
| `messageModerationLevel` | string | Message moderation level | | `messageModerationLevel` | string | Message moderation level |

View File

@@ -66,8 +66,8 @@ Search the web with the Custom Search API
| ↳ `title` | string | Title of the search result | | ↳ `title` | string | Title of the search result |
| ↳ `link` | string | URL of the search result | | ↳ `link` | string | URL of the search result |
| ↳ `snippet` | string | Snippet or description of the search result | | ↳ `snippet` | string | Snippet or description of the search result |
| ↳ `displayLink` | string | Display URL \(abbreviated form\) | | ↳ `displayLink` | string | Display URL |
| ↳ `pagemap` | object | PageMap information for the result \(structured data\) | | ↳ `pagemap` | object | Additional page metadata |
| `searchInformation` | object | Information about the search query and results | | `searchInformation` | object | Information about the search query and results |
| ↳ `totalResults` | string | Total number of search results available | | ↳ `totalResults` | string | Total number of search results available |
| ↳ `searchTime` | number | Time taken to perform the search in seconds | | ↳ `searchTime` | number | Time taken to perform the search in seconds |

View File

@@ -144,7 +144,7 @@ Clear values from a specific range in a Google Sheets spreadsheet
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `spreadsheetId` | string | Yes | The ID of the spreadsheet |
| `sheetName` | string | Yes | The name of the sheet/tab to clear | | `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. | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `spreadsheetId` | string | Yes | The ID of the spreadsheet |
| `includeGridData` | boolean | No | Whether to include grid data \(cell values\). Defaults to false. | | `includeGridData` | boolean | No | Whether to include grid data \(cell values\). Defaults to false. |
#### Output #### Output
@@ -219,7 +219,7 @@ Read multiple ranges from a Google Sheets spreadsheet in a single request
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `spreadsheetId` | string | Yes | The ID of the spreadsheet |
| `ranges` | json | Yes | Array of ranges to read \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. | | `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" | | `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" | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `spreadsheetId` | string | Yes | The ID of the spreadsheet |
| `data` | json | Yes | Array of value ranges to update. Each item should have "range" \(e.g., "Sheet1!A1:D10"\) and "values" \(2D array\). | | `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. | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | Google Sheets spreadsheet ID | | `spreadsheetId` | string | Yes | The ID of the spreadsheet |
| `ranges` | json | Yes | Array of ranges to clear \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. | | `ranges` | json | Yes | Array of ranges to clear \(e.g., \["Sheet1!A1:D10", "Sheet2!A1:B5"\]\). Each range should include sheet name. |
#### Output #### Output
@@ -297,7 +297,7 @@ Copy a sheet from one spreadsheet to another
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `sourceSpreadsheetId` | string | Yes | Source Google Sheets spreadsheet ID | | `sourceSpreadsheetId` | string | Yes | The ID of the source spreadsheet |
| `sheetId` | number | Yes | The ID of the sheet to copy \(numeric ID, not the sheet name\). Use Get Spreadsheet to find sheet IDs. | | `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 | | `destinationSpreadsheetId` | string | Yes | The ID of the destination spreadsheet where the sheet will be copied |

View File

@@ -44,7 +44,7 @@ Read content from a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation to read |
#### Output #### Output
@@ -57,6 +57,8 @@ Read content from a Google Slides presentation
| ↳ `pageSize` | object | Presentation page size | | ↳ `pageSize` | object | Presentation page size |
| ↳ `width` | json | Page width as a Dimension object | | ↳ `width` | json | Page width as a Dimension object |
| ↳ `height` | json | Page height as a Dimension object | | ↳ `height` | json | Page height as a Dimension object |
| ↳ `width` | json | Page width as a Dimension object |
| ↳ `height` | json | Page height as a Dimension object |
| ↳ `mimeType` | string | The mime type of the presentation | | ↳ `mimeType` | string | The mime type of the presentation |
| ↳ `url` | string | URL to open the presentation | | ↳ `url` | string | URL to open the presentation |
@@ -68,7 +70,7 @@ Write or update content in a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation to write to |
| `content` | string | Yes | The content to write to the slide | | `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\) | | `slideIndex` | number | No | The index of the slide to write to \(defaults to first slide\) |
@@ -93,7 +95,7 @@ Create a new Google Slides presentation
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `title` | string | Yes | The title of the presentation to create | | `title` | string | Yes | The title of the presentation to create |
| `content` | string | No | The content to add to the first slide | | `content` | string | No | The content to add to the first slide |
| `folderSelector` | string | No | Google Drive folder ID to create the presentation in \(e.g., 1ABCxyz...\) | | `folderSelector` | string | No | Select the folder to create the presentation in |
| `folderId` | string | No | The ID of the folder to create the presentation in \(internal use\) | | `folderId` | string | No | The ID of the folder to create the presentation in \(internal use\) |
#### Output #### Output
@@ -114,7 +116,7 @@ Find and replace all occurrences of text throughout a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `findText` | string | Yes | The text to find \(e.g., \{\{placeholder\}\}\) | | `findText` | string | Yes | The text to find \(e.g., \{\{placeholder\}\}\) |
| `replaceText` | string | Yes | The text to replace with | | `replaceText` | string | Yes | The text to replace with |
| `matchCase` | boolean | No | Whether the search should be case-sensitive \(default: true\) | | `matchCase` | boolean | No | Whether the search should be case-sensitive \(default: true\) |
@@ -139,7 +141,7 @@ Add a new slide to a Google Slides presentation with a specified layout
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `layout` | string | No | The predefined layout for the slide \(BLANK, TITLE, TITLE_AND_BODY, TITLE_ONLY, SECTION_HEADER, etc.\). Defaults to BLANK. | | `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. | | `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"\}\] | | `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 +165,7 @@ Insert an image into a specific slide in a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `pageObjectId` | string | Yes | The object ID of the slide/page to add the image to | | `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\) | | `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\) | | `width` | number | No | Width of the image in points \(default: 300\) |
@@ -190,7 +192,7 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `pageObjectId` | string | Yes | The object ID of the slide/page to get a thumbnail for | | `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. | | `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. | | `mimeType` | string | No | The MIME type of the thumbnail image: PNG or GIF. Defaults to PNG. |
@@ -216,7 +218,7 @@ Get detailed information about a specific slide/page in a Google Slides presenta
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `pageObjectId` | string | Yes | The object ID of the slide/page to retrieve | | `pageObjectId` | string | Yes | The object ID of the slide/page to retrieve |
#### Output #### Output
@@ -242,7 +244,7 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `objectId` | string | Yes | The object ID of the element or slide to delete | | `objectId` | string | Yes | The object ID of the element or slide to delete |
#### Output #### Output
@@ -263,7 +265,7 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `objectId` | string | Yes | The object ID of the element or slide to duplicate | | `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"\} | | `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 | | `Format` | string | No | No description |
@@ -286,7 +288,7 @@ Move one or more slides to a new position in a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `slideObjectIds` | string | Yes | Comma-separated list of slide object IDs to move. The slides will maintain their relative order. | | `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. | | `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 +311,7 @@ Create a new table on a slide in a Google Slides presentation
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `pageObjectId` | string | Yes | The object ID of the slide/page to add the table to | | `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\) | | `rows` | number | Yes | Number of rows in the table \(minimum 1\) |
| `columns` | number | Yes | Number of columns in the table \(minimum 1\) | | `columns` | number | Yes | Number of columns in the table \(minimum 1\) |
@@ -338,7 +340,7 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `pageObjectId` | string | Yes | The object ID of the slide/page to add the shape to | | `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 | | `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\) | | `width` | number | No | Width of the shape in points \(default: 200\) |
@@ -365,7 +367,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `presentationId` | string | Yes | Google Slides presentation ID | | `presentationId` | string | Yes | The ID of the presentation |
| `objectId` | string | Yes | The object ID of the shape or table cell to insert text into. For table cells, use the cell object 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 | | `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\). | | `insertionIndex` | number | No | The zero-based index at which to insert the text. If not specified, text is inserted at the beginning \(index 0\). |

View File

@@ -42,14 +42,14 @@ Create an export in a matter
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `matterId` | string | Yes | The matter ID |
| `exportName` | string | Yes | Name for the export \(avoid special characters\) | | `exportName` | string | Yes | Name for the export \(avoid special characters\) |
| `corpus` | string | Yes | Data corpus to export \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) | | `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 \(e.g., "user1@example.com, user2@example.com"\) | | `accountEmails` | string | No | Comma-separated list of user emails to scope export |
| `orgUnitId` | string | No | Organization unit ID to scope export \(e.g., "id:03ph8a2z1enx5q0", alternative to emails\) | | `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"\) | | `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"\) | | `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"\) | | `terms` | string | No | Search query terms to filter exported content |
#### Output #### Output
@@ -65,10 +65,10 @@ List exports for a matter
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `matterId` | string | Yes | The matter ID |
| `pageSize` | number | No | Number of exports to return per page | | `pageSize` | number | No | Number of exports to return per page |
| `pageToken` | string | No | Token for pagination | | `pageToken` | string | No | Token for pagination |
| `exportId` | string | No | Optional export ID to fetch a specific export \(e.g., "exportId123456"\) | | `exportId` | string | No | Optional export ID to fetch a specific export |
#### Output #### Output
@@ -86,7 +86,7 @@ Download a single file from a Google Vault export (GCS object)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `matterId` | string | Yes | The matter ID |
| `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName | | `bucketName` | string | Yes | GCS bucket name from cloudStorageSink.files.bucketName |
| `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName | | `objectName` | string | Yes | GCS object name from cloudStorageSink.files.objectName |
| `fileName` | string | No | Optional filename override for the downloaded file | | `fileName` | string | No | Optional filename override for the downloaded file |
@@ -105,14 +105,14 @@ Create a hold in a matter
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `matterId` | string | Yes | The matter ID |
| `holdName` | string | Yes | Name for the hold | | `holdName` | string | Yes | Name for the hold |
| `corpus` | string | Yes | Data corpus to hold \(MAIL, DRIVE, GROUPS, HANGOUTS_CHAT, VOICE\) | | `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 \(e.g., "user1@example.com, user2@example.com"\) | | `accountEmails` | string | No | Comma-separated list of user emails to put on hold |
| `orgUnitId` | string | No | Organization unit ID to put on hold \(e.g., "id:03ph8a2z1enx5q0", alternative to accounts\) | | `orgUnitId` | string | No | Organization unit ID to put on hold \(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\) | | `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, e.g., "2024-01-01T00:00:00Z", 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, e.g., "2024-12-31T23:59:59Z", for MAIL and GROUPS corpus\) | | `endTime` | string | No | End time for date filtering \(ISO 8601 format, for MAIL and GROUPS corpus\) |
| `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) | | `includeSharedDrives` | boolean | No | Include files in shared drives \(for DRIVE corpus\) |
#### Output #### Output
@@ -129,10 +129,10 @@ List holds for a matter
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `matterId` | string | Yes | The matter ID \(e.g., "12345678901234567890"\) | | `matterId` | string | Yes | The matter ID |
| `pageSize` | number | No | Number of holds to return per page | | `pageSize` | number | No | Number of holds to return per page |
| `pageToken` | string | No | Token for pagination | | `pageToken` | string | No | Token for pagination |
| `holdId` | string | No | Optional hold ID to fetch a specific hold \(e.g., "holdId123456"\) | | `holdId` | string | No | Optional hold ID to fetch a specific hold |
#### Output #### 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 | | `pageSize` | number | No | Number of matters to return per page |
| `pageToken` | string | No | Token for pagination | | `pageToken` | string | No | Token for pagination |
| `matterId` | string | No | Optional matter ID to fetch a specific matter \(e.g., "12345678901234567890"\) | | `matterId` | string | No | Optional matter ID to fetch a specific matter |
#### Output #### Output

View File

@@ -48,8 +48,8 @@ Get a dashboard by its UID
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `dashboardUid` | string | Yes | The UID of the dashboard to retrieve \(e.g., abc123def\) | | `dashboardUid` | string | Yes | The UID of the dashboard to retrieve |
#### Output #### Output
@@ -68,10 +68,10 @@ Search and list all dashboards
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `query` | string | No | Search query to filter dashboards by title | | `query` | string | No | Search query to filter dashboards by title |
| `tag` | string | No | Filter by tag \(comma-separated for multiple tags\) | | `tag` | string | No | Filter by tag \(comma-separated for multiple tags\) |
| `folderIds` | string | No | Filter by folder IDs \(comma-separated, e.g., 1,2,3\) | | `folderIds` | string | No | Filter by folder IDs \(comma-separated\) |
| `starred` | boolean | No | Only return starred dashboards | | `starred` | boolean | No | Only return starred dashboards |
| `limit` | number | No | Maximum number of dashboards to return | | `limit` | number | No | Maximum number of dashboards to return |
@@ -97,9 +97,9 @@ Create a new dashboard
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `title` | string | Yes | The title of the new dashboard | | `title` | string | Yes | The title of the new dashboard |
| `folderUid` | string | No | The UID of the folder to create the dashboard in \(e.g., folder-abc123\) | | `folderUid` | string | No | The UID of the folder to create the dashboard in |
| `tags` | string | No | Comma-separated list of tags | | `tags` | string | No | Comma-separated list of tags |
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) | | `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) | | `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 | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `dashboardUid` | string | Yes | The UID of the dashboard to update \(e.g., abc123def\) | | `dashboardUid` | string | Yes | The UID of the dashboard to update |
| `title` | string | No | New title for the dashboard | | `title` | string | No | New title for the dashboard |
| `folderUid` | string | No | New folder UID to move the dashboard to \(e.g., folder-abc123\) | | `folderUid` | string | No | New folder UID to move the dashboard to |
| `tags` | string | No | Comma-separated list of new tags | | `tags` | string | No | Comma-separated list of new tags |
| `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) | | `timezone` | string | No | Dashboard timezone \(e.g., browser, utc\) |
| `refresh` | string | No | Auto-refresh interval \(e.g., 5s, 1m, 5m\) | | `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 | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `dashboardUid` | string | Yes | The UID of the dashboard to delete \(e.g., abc123def\) | | `dashboardUid` | string | Yes | The UID of the dashboard to delete |
#### Output #### Output
@@ -181,7 +181,7 @@ List all alert rules in the Grafana instance
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
#### Output #### Output
@@ -206,7 +206,7 @@ Get a specific alert rule by its UID
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `alertRuleUid` | string | Yes | The UID of the alert rule to retrieve | | `alertRuleUid` | string | Yes | The UID of the alert rule to retrieve |
#### Output #### Output
@@ -234,9 +234,9 @@ Create a new alert rule
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `title` | string | Yes | The title of the alert rule | | `title` | string | Yes | The title of the alert rule |
| `folderUid` | string | Yes | The UID of the folder to create the alert in \(e.g., folder-abc123\) | | `folderUid` | string | Yes | The UID of the folder to create the alert in |
| `ruleGroup` | string | Yes | The name of the rule group | | `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 | | `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 | | `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 | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `alertRuleUid` | string | Yes | The UID of the alert rule to update | | `alertRuleUid` | string | Yes | The UID of the alert rule to update |
| `title` | string | No | New title for the alert rule | | `title` | string | No | New title for the alert rule |
| `folderUid` | string | No | New folder UID to move the alert to \(e.g., folder-abc123\) | | `folderUid` | string | No | New folder UID to move the alert to |
| `ruleGroup` | string | No | New rule group name | | `ruleGroup` | string | No | New rule group name |
| `condition` | string | No | New condition refId | | `condition` | string | No | New condition refId |
| `data` | string | No | New JSON array of query/expression data objects | | `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 | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `alertRuleUid` | string | Yes | The UID of the alert rule to delete | | `alertRuleUid` | string | Yes | The UID of the alert rule to delete |
#### Output #### Output
@@ -316,7 +316,7 @@ List all alert notification contact points
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
#### Output #### Output
@@ -338,13 +338,13 @@ Create an annotation on a dashboard or as a global annotation
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `text` | string | Yes | The text content of the annotation | | `text` | string | Yes | The text content of the annotation |
| `tags` | string | No | Comma-separated list of tags | | `tags` | string | No | Comma-separated list of tags |
| `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to \(e.g., abc123def\) | | `dashboardUid` | string | Yes | UID of the dashboard to add the annotation to |
| `panelId` | number | No | ID of the panel to add the annotation to \(e.g., 1, 2\) | | `panelId` | number | No | ID of the panel to add the annotation to |
| `time` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000, defaults to now\) | | `time` | number | No | Start time in epoch milliseconds \(defaults to now\) |
| `timeEnd` | number | No | End time in epoch milliseconds for range annotations \(e.g., 1704153600000\) | | `timeEnd` | number | No | End time in epoch milliseconds \(for range annotations\) |
#### Output #### Output
@@ -363,11 +363,11 @@ Query annotations by time range, dashboard, or tags
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `from` | number | No | Start time in epoch milliseconds \(e.g., 1704067200000\) | | `from` | number | No | Start time in epoch milliseconds |
| `to` | number | No | End time in epoch milliseconds \(e.g., 1704153600000\) | | `to` | number | No | End time in epoch milliseconds |
| `dashboardUid` | string | Yes | Dashboard UID to query annotations from \(e.g., abc123def\) | | `dashboardUid` | string | Yes | Dashboard UID to query annotations from |
| `panelId` | number | No | Filter by panel ID \(e.g., 1, 2\) | | `panelId` | number | No | Filter by panel ID |
| `tags` | string | No | Comma-separated list of tags to filter by | | `tags` | string | No | Comma-separated list of tags to filter by |
| `type` | string | No | Filter by type \(alert or annotation\) | | `type` | string | No | Filter by type \(alert or annotation\) |
| `limit` | number | No | Maximum number of annotations to return | | `limit` | number | No | Maximum number of annotations to return |
@@ -401,12 +401,12 @@ Update an existing annotation
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `annotationId` | number | Yes | The ID of the annotation to update | | `annotationId` | number | Yes | The ID of the annotation to update |
| `text` | string | Yes | New text content for the annotation | | `text` | string | Yes | New text content for the annotation |
| `tags` | string | No | Comma-separated list of new tags | | `tags` | string | No | Comma-separated list of new tags |
| `time` | number | No | New start time in epoch milliseconds \(e.g., 1704067200000\) | | `time` | number | No | New start time in epoch milliseconds |
| `timeEnd` | number | No | New end time in epoch milliseconds \(e.g., 1704153600000\) | | `timeEnd` | number | No | New end time in epoch milliseconds |
#### Output #### Output
@@ -425,7 +425,7 @@ Delete an annotation by its ID
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `annotationId` | number | Yes | The ID of the annotation to delete | | `annotationId` | number | Yes | The ID of the annotation to delete |
#### Output #### Output
@@ -444,7 +444,7 @@ List all data sources configured in Grafana
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
#### Output #### Output
@@ -468,8 +468,8 @@ Get a data source by its ID or UID
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve \(e.g., prometheus, P1234AB5678\) | | `dataSourceId` | string | Yes | The ID or UID of the data source to retrieve |
#### Output #### Output
@@ -494,7 +494,7 @@ List all folders in Grafana
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `limit` | number | No | Maximum number of folders to return | | `limit` | number | No | Maximum number of folders to return |
| `page` | number | No | Page number for pagination | | `page` | number | No | Page number for pagination |
@@ -527,7 +527,7 @@ Create a new folder in Grafana
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grafana Service Account Token | | `apiKey` | string | Yes | Grafana Service Account Token |
| `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) | | `baseUrl` | string | Yes | Grafana instance URL \(e.g., https://your-grafana.com\) |
| `organizationId` | string | No | Organization ID for multi-org Grafana instances \(e.g., 1, 2\) | | `organizationId` | string | No | Organization ID for multi-org Grafana instances |
| `title` | string | Yes | The title of the new folder | | `title` | string | Yes | The title of the new folder |
| `uid` | string | No | Optional UID for the folder \(auto-generated if not provided\) | | `uid` | string | No | Optional UID for the folder \(auto-generated if not provided\) |

View File

@@ -48,13 +48,13 @@ List recordings from Grain with optional filters and pagination
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
| `cursor` | string | No | Pagination cursor for next page \(returned from previous response\) | | `cursor` | string | No | Pagination cursor for next page |
| `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp \(e.g., "2024-01-15T00:00:00Z"\) | | `beforeDatetime` | string | No | Only recordings before this ISO8601 timestamp |
| `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp \(e.g., "2024-01-01T00:00:00Z"\) | | `afterDatetime` | string | No | Only recordings after this ISO8601 timestamp |
| `participantScope` | string | No | Filter: "internal" or "external" | | `participantScope` | string | No | Filter: "internal" or "external" |
| `titleSearch` | string | No | Search term to filter by recording title \(e.g., "weekly standup"\) | | `titleSearch` | string | No | Search term to filter by recording title |
| `teamId` | string | No | Filter by team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `teamId` | string | No | Filter by team UUID |
| `meetingTypeId` | string | No | Filter by meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `meetingTypeId` | string | No | Filter by meeting type UUID |
| `includeHighlights` | boolean | No | Include highlights/clips in response | | `includeHighlights` | boolean | No | Include highlights/clips in response |
| `includeParticipants` | boolean | No | Include participant list in response | | `includeParticipants` | boolean | No | Include participant list in response |
| `includeAiSummary` | boolean | No | Include AI-generated summary | | `includeAiSummary` | boolean | No | Include AI-generated summary |
@@ -87,7 +87,7 @@ Get details of a single recording by ID
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
| `recordingId` | string | Yes | The recording UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `recordingId` | string | Yes | The recording UUID |
| `includeHighlights` | boolean | No | Include highlights/clips | | `includeHighlights` | boolean | No | Include highlights/clips |
| `includeParticipants` | boolean | No | Include participant list | | `includeParticipants` | boolean | No | Include participant list |
| `includeAiSummary` | boolean | No | Include AI summary | | `includeAiSummary` | boolean | No | Include AI summary |
@@ -125,7 +125,7 @@ Get the full transcript of a recording
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
| `recordingId` | string | Yes | The recording UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `recordingId` | string | Yes | The recording UUID |
#### Output #### Output
@@ -184,13 +184,13 @@ Create a webhook to receive recording events
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
| `hookUrl` | string | Yes | Webhook endpoint URL \(e.g., "https://example.com/webhooks/grain"\) | | `hookUrl` | string | Yes | Webhook endpoint URL \(must respond 2xx\) |
| `hookType` | string | Yes | Type of webhook: "recording_added" or "upload_status" | | `hookType` | string | Yes | Type of webhook: "recording_added" or "upload_status" |
| `filterBeforeDatetime` | string | No | Filter: recordings before this ISO8601 date \(e.g., "2024-01-15T00:00:00Z"\) | | `filterBeforeDatetime` | string | No | Filter: recordings before this date |
| `filterAfterDatetime` | string | No | Filter: recordings after this ISO8601 date \(e.g., "2024-01-01T00:00:00Z"\) | | `filterAfterDatetime` | string | No | Filter: recordings after this date |
| `filterParticipantScope` | string | No | Filter: "internal" or "external" | | `filterParticipantScope` | string | No | Filter: "internal" or "external" |
| `filterTeamId` | string | No | Filter: specific team UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `filterTeamId` | string | No | Filter: specific team UUID |
| `filterMeetingTypeId` | string | No | Filter: specific meeting type UUID \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `filterMeetingTypeId` | string | No | Filter: specific meeting type |
| `includeHighlights` | boolean | No | Include highlights in webhook payload | | `includeHighlights` | boolean | No | Include highlights in webhook payload |
| `includeParticipants` | boolean | No | Include participants in webhook payload | | `includeParticipants` | boolean | No | Include participants in webhook payload |
| `includeAiSummary` | boolean | No | Include AI summary 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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Grain API key \(Personal Access Token\) | | `apiKey` | string | Yes | Grain API key \(Personal Access Token\) |
| `hookId` | string | Yes | The hook UUID to delete \(e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890"\) | | `hookId` | string | Yes | The hook UUID to delete |
#### Output #### Output

View File

@@ -46,9 +46,9 @@ Query repositories in natural language and get answers with relevant code refere
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Natural language question about the codebase. Example: "How does authentication work?" or "Where is the payment processing logic?" | | `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\). Example: "facebook/react" or "github:main:facebook/react,github:main:facebook/relay" | | `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. Use the same sessionId across multiple queries to maintain context. Example: "session-abc123" | | `sessionId` | string | No | Session ID for conversation continuity |
| `genius` | boolean | No | Enable genius mode for more thorough analysis \(slower but more accurate\) | | `genius` | boolean | No | Enable genius mode for more thorough analysis \(slower but more accurate\) |
| `apiKey` | string | Yes | Greptile API key | | `apiKey` | string | Yes | Greptile API key |
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Natural language search query to find relevant code. Example: "authentication middleware" or "database connection handling" | | `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\). Example: "facebook/react" or "github:main:facebook/react,github:main:facebook/relay" | | `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. Use the same sessionId across multiple searches to maintain context. Example: "session-abc123" | | `sessionId` | string | No | Session ID for conversation continuity |
| `genius` | boolean | No | Enable genius mode for more thorough search \(slower but more accurate\) | | `genius` | boolean | No | Enable genius mode for more thorough search \(slower but more accurate\) |
| `apiKey` | string | Yes | Greptile API key | | `apiKey` | string | Yes | Greptile API key |
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `remote` | string | Yes | Git remote type: github or gitlab | | `remote` | string | Yes | Git remote type: github or gitlab |
| `repository` | string | Yes | Repository in owner/repo format. Example: "facebook/react" or "vercel/next.js" | | `repository` | string | Yes | Repository in owner/repo format \(e.g., "facebook/react"\) |
| `branch` | string | Yes | Branch to index \(e.g., "main" or "master"\) | | `branch` | string | Yes | Branch to index \(e.g., "main" or "master"\) |
| `reload` | boolean | No | Force re-indexing even if already indexed | | `reload` | boolean | No | Force re-indexing even if already indexed |
| `notify` | boolean | No | Send email notification when indexing completes | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `remote` | string | Yes | Git remote type: github or gitlab | | `remote` | string | Yes | Git remote type: github or gitlab |
| `repository` | string | Yes | Repository in owner/repo format. Example: "facebook/react" or "vercel/next.js" | | `repository` | string | Yes | Repository in owner/repo format \(e.g., "facebook/react"\) |
| `branch` | string | Yes | Branch name \(e.g., "main" or "master"\) | | `branch` | string | Yes | Branch name \(e.g., "main" or "master"\) |
| `apiKey` | string | Yes | Greptile API key | | `apiKey` | string | Yes | Greptile API key |
| `githubToken` | string | Yes | GitHub Personal Access Token with repo read access | | `githubToken` | string | Yes | GitHub Personal Access Token with repo read access |

View File

@@ -44,19 +44,13 @@ Retrieve all users from HubSpot account
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Number of results to return \(default: 100, max: 100\) | | `limit` | string | No | Number of results to return \(default: 100\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `users` | array | Array of HubSpot user objects | | `users` | array | Array of HubSpot user objects |
| ↳ `id` | string | User ID |
| ↳ `email` | string | User email address |
| ↳ `roleId` | string | User role ID |
| ↳ `primaryTeamId` | string | Primary team ID |
| ↳ `secondaryTeamIds` | array | Secondary team IDs |
| ↳ `superAdmin` | boolean | Whether user is a super admin |
| `totalItems` | number | Total number of users returned | | `totalItems` | number | Total number of users returned |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -69,41 +63,17 @@ Retrieve all contacts from HubSpot account with pagination support
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) | | `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) | | `after` | string | No | Pagination cursor for next page of results |
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "email,firstname,lastname,phone"\) | | `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 \(e.g., "companies,deals"\) | | `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `contacts` | array | Array of HubSpot contact records | | `contacts` | array | Array of HubSpot contact objects |
| ↳ `email` | string | Contact email address | | `paging` | object | Pagination information |
| ↳ `firstname` | string | Contact first name | | `metadata` | object | Metadata with totalReturned and hasMore |
| ↳ `lastname` | string | Contact last name |
| ↳ `phone` | string | Contact phone number |
| ↳ `mobilephone` | string | Contact mobile phone number |
| ↳ `company` | string | Associated company name |
| ↳ `website` | string | Contact website URL |
| ↳ `jobtitle` | string | Contact job title |
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `address` | string | Street address |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `fax` | string | Fax number |
| ↳ `hs_timezone` | string | Contact timezone |
| `paging` | object | Pagination information for fetching more results |
| ↳ `after` | string | Cursor for next page of results |
| ↳ `link` | string | Link to next page |
| `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records are available |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
### `hubspot_get_contact` ### `hubspot_get_contact`
@@ -114,36 +84,16 @@ Retrieve a single contact by ID or email from HubSpot
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The HubSpot contact ID \(numeric string\) or email address to retrieve | | `contactId` | string | Yes | The ID or email of the contact to retrieve |
| `idProperty` | string | No | Property to use as unique identifier \(e.g., "email"\). If not specified, uses record ID | | `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 HubSpot property names to return \(e.g., "email,firstname,lastname,phone"\) | | `properties` | string | No | Comma-separated list of properties to return |
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "companies,deals"\) | | `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `contact` | object | HubSpot contact record | | `contact` | object | HubSpot contact object with properties |
| ↳ `email` | string | Contact email address |
| ↳ `firstname` | string | Contact first name |
| ↳ `lastname` | string | Contact last name |
| ↳ `phone` | string | Contact phone number |
| ↳ `mobilephone` | string | Contact mobile phone number |
| ↳ `company` | string | Associated company name |
| ↳ `website` | string | Contact website URL |
| ↳ `jobtitle` | string | Contact job title |
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `address` | string | Street address |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `fax` | string | Fax number |
| ↳ `hs_timezone` | string | Contact timezone |
| `contactId` | string | The retrieved contact ID | | `contactId` | string | The retrieved contact ID |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -155,34 +105,14 @@ Create a new contact in HubSpot. Requires at least one of: email, firstname, or
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `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"\}\) | | `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 as JSON. Each object should have "to.id" \(company/deal ID\) and "types" array with "associationCategory" and "associationTypeId" | | `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"\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `contact` | object | HubSpot contact record | | `contact` | object | Created HubSpot contact object |
| ↳ `email` | string | Contact email address |
| ↳ `firstname` | string | Contact first name |
| ↳ `lastname` | string | Contact last name |
| ↳ `phone` | string | Contact phone number |
| ↳ `mobilephone` | string | Contact mobile phone number |
| ↳ `company` | string | Associated company name |
| ↳ `website` | string | Contact website URL |
| ↳ `jobtitle` | string | Contact job title |
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `address` | string | Street address |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `fax` | string | Fax number |
| ↳ `hs_timezone` | string | Contact timezone |
| `contactId` | string | The created contact ID | | `contactId` | string | The created contact ID |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -194,35 +124,15 @@ Update an existing contact in HubSpot by ID or email
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `contactId` | string | Yes | The HubSpot contact ID \(numeric string\) or email of the contact to update | | `contactId` | string | Yes | The ID 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 | | `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 \(e.g., \{"firstname": "John", "phone": "+1234567890"\}\) | | `properties` | object | Yes | Contact properties to update as JSON object |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `contact` | object | HubSpot contact record | | `contact` | object | Updated HubSpot contact object |
| ↳ `email` | string | Contact email address |
| ↳ `firstname` | string | Contact first name |
| ↳ `lastname` | string | Contact last name |
| ↳ `phone` | string | Contact phone number |
| ↳ `mobilephone` | string | Contact mobile phone number |
| ↳ `company` | string | Associated company name |
| ↳ `website` | string | Contact website URL |
| ↳ `jobtitle` | string | Contact job title |
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `address` | string | Street address |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `fax` | string | Fax number |
| ↳ `hs_timezone` | string | Contact timezone |
| `contactId` | string | The updated contact ID | | `contactId` | string | The updated contact ID |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -234,45 +144,21 @@ Search for contacts in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `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" | | `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value |
| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) | | `sorts` | array | No | Array of sort objects with propertyName and direction \("ASCENDING" or "DESCENDING"\) |
| `query` | string | No | Search query string to match against contact name, email, and other text fields | | `query` | string | No | Search query string |
| `properties` | array | No | Array of HubSpot property names to return \(e.g., \["email", "firstname", "lastname", "phone"\]\) | | `properties` | array | No | Array of property names to return |
| `limit` | number | No | Maximum number of results to return \(max 100\) | | `limit` | number | No | Maximum number of results to return \(max 100\) |
| `after` | string | No | Pagination cursor for next page \(from previous response\) | | `after` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `contacts` | array | Array of HubSpot contact records | | `contacts` | array | Array of matching HubSpot contact objects |
| ↳ `email` | string | Contact email address |
| ↳ `firstname` | string | Contact first name |
| ↳ `lastname` | string | Contact last name |
| ↳ `phone` | string | Contact phone number |
| ↳ `mobilephone` | string | Contact mobile phone number |
| ↳ `company` | string | Associated company name |
| ↳ `website` | string | Contact website URL |
| ↳ `jobtitle` | string | Contact job title |
| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `createdate` | string | Contact creation date \(ISO 8601\) |
| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `address` | string | Street address |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `fax` | string | Fax number |
| ↳ `hs_timezone` | string | Contact timezone |
| `paging` | object | Pagination information for fetching more results |
| ↳ `after` | string | Cursor for next page of results |
| ↳ `link` | string | Link to next page |
| `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records are available |
| `total` | number | Total number of matching contacts | | `total` | number | Total number of matching contacts |
| `paging` | object | Pagination information |
| `metadata` | object | Metadata with totalReturned and hasMore |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
### `hubspot_list_companies` ### `hubspot_list_companies`
@@ -284,42 +170,17 @@ Retrieve all companies from HubSpot account with pagination support
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) | | `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) | | `after` | string | No | Pagination cursor for next page of results |
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "name,domain,industry"\) | | `properties` | string | No | Comma-separated list of properties to return |
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) | | `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `companies` | array | Array of HubSpot company records | | `companies` | array | Array of HubSpot company objects |
| ↳ `name` | string | Company name | | `paging` | object | Pagination information |
| ↳ `domain` | string | Company website domain \(unique identifier\) | | `metadata` | object | Metadata with totalReturned and hasMore |
| ↳ `description` | string | Company description |
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
| ↳ `phone` | string | Company phone number |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `address` | string | Street address |
| ↳ `numberofemployees` | string | Total number of employees |
| ↳ `annualrevenue` | string | Annual revenue estimate |
| ↳ `lifecyclestage` | string | Lifecycle stage |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
| ↳ `website` | string | Company website URL |
| `paging` | object | Pagination information for fetching more results |
| ↳ `after` | string | Cursor for next page of results |
| ↳ `link` | string | Link to next page |
| `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records are available |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
### `hubspot_get_company` ### `hubspot_get_company`
@@ -330,37 +191,16 @@ Retrieve a single company by ID or domain from HubSpot
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `companyId` | string | Yes | The HubSpot company ID \(numeric string\) or domain to retrieve | | `companyId` | string | Yes | The ID or domain of the company to retrieve |
| `idProperty` | string | No | Property to use as unique identifier \(e.g., "domain"\). If not specified, uses record ID | | `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 HubSpot property names to return \(e.g., "name,domain,industry"\) | | `properties` | string | No | Comma-separated list of properties to return |
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,deals"\) | | `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `company` | object | HubSpot company record | | `company` | object | HubSpot company object with properties |
| ↳ `name` | string | Company name |
| ↳ `domain` | string | Company website domain \(unique identifier\) |
| ↳ `description` | string | Company description |
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
| ↳ `phone` | string | Company phone number |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `address` | string | Street address |
| ↳ `numberofemployees` | string | Total number of employees |
| ↳ `annualrevenue` | string | Annual revenue estimate |
| ↳ `lifecyclestage` | string | Lifecycle stage |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
| ↳ `website` | string | Company website URL |
| `companyId` | string | The retrieved company ID | | `companyId` | string | The retrieved company ID |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -372,35 +212,14 @@ Create a new company in HubSpot
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `properties` | object | Yes | Company properties as JSON object \(e.g., \{"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"\}\) | | `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 as JSON \(each with "to.id" and "types" containing "associationCategory" and "associationTypeId"\) | | `associations` | array | No | Array of associations to create with the company |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `company` | object | HubSpot company record | | `company` | object | Created HubSpot company object |
| ↳ `name` | string | Company name |
| ↳ `domain` | string | Company website domain \(unique identifier\) |
| ↳ `description` | string | Company description |
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
| ↳ `phone` | string | Company phone number |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `address` | string | Street address |
| ↳ `numberofemployees` | string | Total number of employees |
| ↳ `annualrevenue` | string | Annual revenue estimate |
| ↳ `lifecyclestage` | string | Lifecycle stage |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
| ↳ `website` | string | Company website URL |
| `companyId` | string | The created company ID | | `companyId` | string | The created company ID |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -412,36 +231,15 @@ Update an existing company in HubSpot by ID or domain
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `companyId` | string | Yes | The HubSpot company ID \(numeric string\) or domain of the company to update | | `companyId` | string | Yes | The ID 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 | | `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 \(e.g., \{"name": "New Name", "industry": "Finance"\}\) | | `properties` | object | Yes | Company properties to update as JSON object |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `company` | object | HubSpot company record | | `company` | object | Updated HubSpot company object |
| ↳ `name` | string | Company name |
| ↳ `domain` | string | Company website domain \(unique identifier\) |
| ↳ `description` | string | Company description |
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
| ↳ `phone` | string | Company phone number |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `address` | string | Street address |
| ↳ `numberofemployees` | string | Total number of employees |
| ↳ `annualrevenue` | string | Annual revenue estimate |
| ↳ `lifecyclestage` | string | Lifecycle stage |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
| ↳ `website` | string | Company website URL |
| `companyId` | string | The updated company ID | | `companyId` | string | The updated company ID |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -453,46 +251,21 @@ Search for companies in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `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" | | `filterGroups` | array | No | Array of filter groups. Each group contains filters with propertyName, operator, and value |
| `sorts` | array | No | Array of sort objects as JSON with "propertyName" and "direction" \("ASCENDING" or "DESCENDING"\) | | `sorts` | array | No | Array of sort objects with propertyName and direction \("ASCENDING" or "DESCENDING"\) |
| `query` | string | No | Search query string to match against company name, domain, and other text fields | | `query` | string | No | Search query string |
| `properties` | array | No | Array of HubSpot property names to return \(e.g., \["name", "domain", "industry"\]\) | | `properties` | array | No | Array of property names to return |
| `limit` | number | No | Maximum number of results to return \(max 100\) | | `limit` | number | No | Maximum number of results to return \(max 100\) |
| `after` | string | No | Pagination cursor for next page \(from previous response\) | | `after` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `companies` | array | Array of HubSpot company records | | `companies` | array | Array of matching HubSpot company objects |
| ↳ `name` | string | Company name |
| ↳ `domain` | string | Company website domain \(unique identifier\) |
| ↳ `description` | string | Company description |
| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) |
| ↳ `phone` | string | Company phone number |
| ↳ `city` | string | City |
| ↳ `state` | string | State/Region |
| ↳ `zip` | string | Postal/ZIP code |
| ↳ `country` | string | Country |
| ↳ `address` | string | Street address |
| ↳ `numberofemployees` | string | Total number of employees |
| ↳ `annualrevenue` | string | Annual revenue estimate |
| ↳ `lifecyclestage` | string | Lifecycle stage |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) |
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) |
| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) |
| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) |
| ↳ `website` | string | Company website URL |
| `paging` | object | Pagination information for fetching more results |
| ↳ `after` | string | Cursor for next page of results |
| ↳ `link` | string | Link to next page |
| `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records are available |
| `total` | number | Total number of matching companies | | `total` | number | Total number of matching companies |
| `paging` | object | Pagination information |
| `metadata` | object | Metadata with totalReturned and hasMore |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
### `hubspot_list_deals` ### `hubspot_list_deals`
@@ -504,33 +277,17 @@ Retrieve all deals from HubSpot account with pagination support
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Maximum number of results per page \(max 100, default 100\) | | `limit` | string | No | Maximum number of results per page \(max 100, default 100\) |
| `after` | string | No | Pagination cursor for next page of results \(from previous response\) | | `after` | string | No | Pagination cursor for next page of results |
| `properties` | string | No | Comma-separated list of HubSpot property names to return \(e.g., "dealname,amount,dealstage"\) | | `properties` | string | No | Comma-separated list of properties to return |
| `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for \(e.g., "contacts,companies"\) | | `associations` | string | No | Comma-separated list of object types to retrieve associated IDs for |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `deals` | array | Array of HubSpot deal records | | `deals` | array | Array of HubSpot deal objects |
| ↳ `dealname` | string | Deal name | | `paging` | object | Pagination information |
| ↳ `amount` | string | Deal amount | | `metadata` | object | Metadata with totalReturned and hasMore |
| ↳ `dealstage` | string | Current deal stage |
| ↳ `pipeline` | string | Pipeline the deal is in |
| ↳ `closedate` | string | Expected close date \(ISO 8601\) |
| ↳ `dealtype` | string | Deal type \(New Business, Existing Business, etc.\) |
| ↳ `description` | string | Deal description |
| ↳ `hubspot_owner_id` | string | HubSpot owner ID |
| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) |
| ↳ `createdate` | string | Deal creation date \(ISO 8601\) |
| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) |
| ↳ `num_associated_contacts` | string | Number of associated contacts |
| `paging` | object | Pagination information for fetching more results |
| ↳ `after` | string | Cursor for next page of results |
| ↳ `link` | string | Link to next page |
| `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records are available |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |

View File

@@ -43,7 +43,7 @@ Generate completions using Hugging Face Inference API
| `systemPrompt` | string | No | System prompt to guide the model behavior | | `systemPrompt` | string | No | System prompt to guide the model behavior |
| `content` | string | Yes | The user message content to send to the model | | `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.\) | | `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", "meta-llama/Llama-3.3-70B-Instruct"\) | | `model` | string | Yes | Model to use for chat completions \(e.g., deepseek/deepseek-v3-0324\) |
| `maxTokens` | number | No | Maximum number of tokens to generate | | `maxTokens` | number | No | Maximum number of tokens to generate |
| `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random | | `temperature` | number | No | Sampling temperature \(0-2\). Higher values make output more random |
| `apiKey` | string | Yes | Hugging Face API token | | `apiKey` | string | Yes | Hugging Face API token |
@@ -60,5 +60,8 @@ Generate completions using Hugging Face Inference API
| ↳ `prompt_tokens` | number | Number of tokens in the prompt | | ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `completion_tokens` | number | Number of tokens in the completion | | ↳ `completion_tokens` | number | Number of tokens in the completion |
| ↳ `total_tokens` | number | Total number of tokens used | | ↳ `total_tokens` | number | Total number of tokens used |
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `completion_tokens` | number | Number of tokens in the completion |
| ↳ `total_tokens` | number | Total number of tokens used |

View File

@@ -42,7 +42,7 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | No | Natural language search query for companies | | `query` | string | No | Natural language search query for companies |
| `domain` | string | No | Company domain name to filter by \(e.g., "stripe.com", "company.io"\) | | `domain` | string | No | Company domain names to filter by |
| `headcount` | string | No | Company size filter \(e.g., "1-10", "11-50"\) | | `headcount` | string | No | Company size filter \(e.g., "1-10", "11-50"\) |
| `company_type` | string | No | Type of organization | | `company_type` | string | No | Type of organization |
| `technology` | string | No | Technology used by companies | | `technology` | string | No | Technology used by companies |
@@ -52,12 +52,7 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `results` | array | List of companies matching the search criteria | | `results` | array | Array of companies matching the search criteria, each containing domain, name, headcount, technologies, and email_count |
| ↳ `domain` | string | Company domain |
| ↳ `name` | string | Company/organization name |
| ↳ `headcount` | number | Company size/headcount |
| ↳ `technologies` | array | Technologies used by the company |
| ↳ `email_count` | number | Total number of email addresses found |
### `hunter_domain_search` ### `hunter_domain_search`
@@ -67,58 +62,38 @@ Returns all the email addresses found using one given domain name, with sources.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Domain name to search for email addresses \(e.g., "stripe.com", "company.io"\) | | `domain` | string | Yes | Domain name to search for email addresses |
| `limit` | number | No | Maximum email addresses to return \(e.g., 10, 25, 50\). Default: 10 | | `limit` | number | No | Maximum email addresses to return \(default: 10\) |
| `offset` | number | No | Number of email addresses to skip for pagination \(e.g., 0, 10, 20\) | | `offset` | number | No | Number of email addresses to skip |
| `type` | string | No | Filter for personal or generic emails \(e.g., "personal", "generic", "all"\) | | `type` | string | No | Filter for personal or generic emails |
| `seniority` | string | No | Filter by seniority level \(e.g., "junior", "senior", "executive"\) | | `seniority` | string | No | Filter by seniority level: junior, senior, or executive |
| `department` | string | No | Filter by specific department \(e.g., "sales", "marketing", "engineering", "hr"\) | | `department` | string | No | Filter by specific departments \(e.g., sales, marketing\) |
| `apiKey` | string | Yes | Hunter.io API Key | | `apiKey` | string | Yes | Hunter.io API Key |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `emails` | array | List of email addresses found for the domain \(up to 100 per request\) |
| ↳ `value` | string | The email address |
| ↳ `type` | string | Email type: personal or generic \(role-based\) |
| ↳ `confidence` | number | Probability score \(0-100\) that the email is correct |
| ↳ `first_name` | string | Person's first name |
| ↳ `last_name` | string | Person's last name |
| ↳ `position` | string | Job title/position |
| ↳ `seniority` | string | Seniority level \(junior, senior, executive\) |
| ↳ `department` | string | Department \(executive, it, finance, management, sales, legal, support, hr, marketing, communication\) |
| ↳ `linkedin` | string | LinkedIn profile URL |
| ↳ `twitter` | string | Twitter handle |
| ↳ `phone_number` | string | Phone number |
| ↳ `sources` | array | List of sources where the email was found \(limited to 20\) |
| ↳ `domain` | string | Domain where the email was found |
| ↳ `uri` | string | Full URL of the source page |
| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) |
| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) |
| ↳ `still_on_page` | boolean | Whether the email is still present on the source page |
| ↳ `verification` | object | Email verification information |
| ↳ `date` | string | Date when the email was verified \(YYYY-MM-DD\) |
| ↳ `status` | string | Verification status \(valid, invalid, accept_all, webmail, disposable, unknown\) |
| `domain` | string | The searched domain name | | `domain` | string | The searched domain name |
| `disposable` | boolean | Whether the domain is a disposable email service | | `disposable` | boolean | Whether the domain accepts disposable email addresses |
| `webmail` | boolean | Whether the domain is a webmail provider \(e.g., Gmail\) | | `webmail` | boolean | Whether the domain is a webmail provider |
| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) | | `accept_all` | boolean | Whether the domain accepts all email addresses |
| `pattern` | string | The email pattern used by the organization \(e.g., \{first\}, \{first\}.\{last\}\) | | `pattern` | string | The email pattern used by the organization |
| `organization` | string | The organization/company name | | `organization` | string | The organization name |
| `description` | string | Description of the organization | | `description` | string | Description of the organization |
| `industry` | string | Industry classification of the organization | | `industry` | string | Industry of the organization |
| `twitter` | string | Twitter handle of the organization | | `twitter` | string | Twitter profile of the organization |
| `facebook` | string | Facebook page URL of the organization | | `facebook` | string | Facebook profile of the organization |
| `linkedin` | string | LinkedIn company page URL | | `linkedin` | string | LinkedIn profile of the organization |
| `instagram` | string | Instagram profile of the organization | | `instagram` | string | Instagram profile of the organization |
| `youtube` | string | YouTube channel of the organization | | `youtube` | string | YouTube channel of the organization |
| `technologies` | array | Technologies used by the organization | | `technologies` | array | Array of technologies used by the organization |
| `country` | string | Country where the organization is headquartered | | `country` | string | Country where the organization is located |
| `state` | string | State/province where the organization is located | | `state` | string | State where the organization is located |
| `city` | string | City where the organization is located | | `city` | string | City where the organization is located |
| `postal_code` | string | Postal code of the organization | | `postal_code` | string | Postal code of the organization |
| `street` | string | Street address of the organization | | `street` | string | Street address of the organization |
| `emails` | array | Array of email addresses found for the domain, each containing value, type, confidence, sources, and person details |
### `hunter_email_finder` ### `hunter_email_finder`
@@ -128,27 +103,20 @@ Finds the most likely email address for a person given their name and company do
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Company domain name \(e.g., "stripe.com", "company.io"\) | | `domain` | string | Yes | Company domain name |
| `first_name` | string | Yes | Person\'s first name \(e.g., "John", "Sarah"\) | | `first_name` | string | Yes | Person's first name |
| `last_name` | string | Yes | Person\'s last name \(e.g., "Smith", "Johnson"\) | | `last_name` | string | Yes | Person's last name |
| `company` | string | No | Company name \(e.g., "Stripe", "Acme Inc"\) | | `company` | string | No | Company name |
| `apiKey` | string | Yes | Hunter.io API Key | | `apiKey` | string | Yes | Hunter.io API Key |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `sources` | array | List of sources where the email was found \(limited to 20\) |
| ↳ `domain` | string | Domain where the email was found |
| ↳ `uri` | string | Full URL of the source page |
| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) |
| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) |
| ↳ `still_on_page` | boolean | Whether the email is still present on the source page |
| `verification` | object | Email verification information |
| ↳ `date` | string | Date when the email was verified \(YYYY-MM-DD\) |
| ↳ `status` | string | Verification status \(valid, invalid, accept_all, webmail, disposable, unknown\) |
| `email` | string | The found email address | | `email` | string | The found email address |
| `score` | number | Confidence score \(0-100\) for the found email address | | `score` | number | Confidence score for the found email address |
| `sources` | array | Array of sources where the email was found, each containing domain, uri, extracted_on, last_seen_on, and still_on_page |
| `verification` | object | Verification information containing date and status |
### `hunter_email_verifier` ### `hunter_email_verifier`
@@ -165,25 +133,20 @@ Verifies the deliverability of an email address and provides detailed verificati
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `sources` | array | List of sources where the email was found \(limited to 20\) |
| ↳ `domain` | string | Domain where the email was found |
| ↳ `uri` | string | Full URL of the source page |
| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) |
| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) |
| ↳ `still_on_page` | boolean | Whether the email is still present on the source page |
| `result` | string | Deliverability result: deliverable, undeliverable, or risky | | `result` | string | Deliverability result: deliverable, undeliverable, or risky |
| `score` | number | Deliverability score \(0-100\). Webmail and disposable emails receive an arbitrary score of 50. | | `score` | number | Confidence score for the verification result |
| `email` | string | The verified email address | | `email` | string | The verified email address |
| `regexp` | boolean | Whether the email passes regular expression validation | | `regexp` | boolean | Whether the email follows a valid regex pattern |
| `gibberish` | boolean | Whether the email appears to be auto-generated \(e.g., e65rc109q@company.com\) | | `gibberish` | boolean | Whether the email appears to be gibberish |
| `disposable` | boolean | Whether the email is from a disposable email service | | `disposable` | boolean | Whether the email is from a disposable email provider |
| `webmail` | boolean | Whether the email is from a webmail provider \(e.g., Gmail\) | | `webmail` | boolean | Whether the email is from a webmail provider |
| `mx_records` | boolean | Whether MX records exist for the domain | | `mx_records` | boolean | Whether MX records exist for the domain |
| `smtp_server` | boolean | Whether connection to the SMTP server was successful | | `smtp_server` | boolean | Whether the SMTP server is reachable |
| `smtp_check` | boolean | Whether the email address doesn't bounce | | `smtp_check` | boolean | Whether the SMTP check was successful |
| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) | | `accept_all` | boolean | Whether the domain accepts all email addresses |
| `block` | boolean | Whether the domain is blocking verification \(validity could not be determined\) | | `block` | boolean | Whether the email is blocked |
| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, unknown, or blocked | | `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, or unknown |
| `sources` | array | Array of sources where the email was found |
### `hunter_companies_find` ### `hunter_companies_find`
@@ -193,22 +156,15 @@ Enriches company data using domain name.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Domain to find company data for \(e.g., "stripe.com", "company.io"\) | | `domain` | string | Yes | Domain to find company data for |
| `apiKey` | string | Yes | Hunter.io API Key | | `apiKey` | string | Yes | Hunter.io API Key |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `company` | object | Company information |
| ↳ `name` | string | Company name |
| ↳ `domain` | string | Company domain |
| ↳ `industry` | string | Industry classification |
| ↳ `size` | string | Company size/headcount range |
| ↳ `country` | string | Country where the company is located |
| ↳ `linkedin` | string | LinkedIn company page URL |
| ↳ `twitter` | string | Twitter handle |
| `person` | object | Person information \(undefined for companies_find tool\) | | `person` | object | Person information \(undefined for companies_find tool\) |
| `company` | object | Company information including name, domain, industry, size, country, linkedin, and twitter |
### `hunter_email_count` ### `hunter_email_count`
@@ -218,36 +174,19 @@ Returns the total number of email addresses found for a domain or company.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | No | Domain to count emails for \(e.g., "stripe.com"\). Required if company not provided | | `domain` | string | No | Domain to count emails for \(required if company not provided\) |
| `company` | string | No | Company name to count emails for \(e.g., "Stripe", "Acme Inc"\). Required if domain 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 \(e.g., "personal", "generic", "all"\) | | `type` | string | No | Filter for personal or generic emails only |
| `apiKey` | string | Yes | Hunter.io API Key | | `apiKey` | string | Yes | Hunter.io API Key |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `department` | object | Email count breakdown by department |
| ↳ `executive` | number | Number of executive department emails |
| ↳ `it` | number | Number of IT department emails |
| ↳ `finance` | number | Number of finance department emails |
| ↳ `management` | number | Number of management department emails |
| ↳ `sales` | number | Number of sales department emails |
| ↳ `legal` | number | Number of legal department emails |
| ↳ `support` | number | Number of support department emails |
| ↳ `hr` | number | Number of HR department emails |
| ↳ `marketing` | number | Number of marketing department emails |
| ↳ `communication` | number | Number of communication department emails |
| ↳ `education` | number | Number of education department emails |
| ↳ `design` | number | Number of design department emails |
| ↳ `health` | number | Number of health department emails |
| ↳ `operations` | number | Number of operations department emails |
| `seniority` | object | Email count breakdown by seniority level |
| ↳ `junior` | number | Number of junior-level emails |
| ↳ `senior` | number | Number of senior-level emails |
| ↳ `executive` | number | Number of executive-level emails |
| `total` | number | Total number of email addresses found | | `total` | number | Total number of email addresses found |
| `personal_emails` | number | Number of personal email addresses \(individual employees\) | | `personal_emails` | number | Number of personal email addresses found |
| `generic_emails` | number | Number of generic/role-based email addresses \(e.g., contact@, info@\) | | `generic_emails` | number | Number of generic email addresses found |
| `department` | object | Breakdown of email addresses by department \(executive, it, finance, management, sales, legal, support, hr, marketing, communication\) |
| `seniority` | object | Breakdown of email addresses by seniority level \(junior, senior, executive\) |

View File

@@ -62,5 +62,6 @@ Generate images using OpenAI
| ↳ `image` | string | Base64 encoded image data | | ↳ `image` | string | Base64 encoded image data |
| ↳ `metadata` | object | Image generation metadata | | ↳ `metadata` | object | Image generation metadata |
| ↳ `model` | string | Model used for image generation | | ↳ `model` | string | Model used for image generation |
| ↳ `model` | string | Model used for image generation |

View File

@@ -49,45 +49,43 @@ List incidents from incident.io. Returns a list of incidents with their details
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `page_size` | number | No | Number of incidents to return per page \(e.g., 10, 25, 50\). Default: 25 | | `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 \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `after` | string | No | Pagination cursor to fetch the next page of results |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `incidents` | array | List of incidents | | `incidents` | array | List of incidents |
| ↳ `id` | string | Incident ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Incident name/title | | ↳ `name` | string | Type name |
| ↳ `summary` | string | Incident summary | | ↳ `summary` | string | Brief summary of the incident |
| ↳ `description` | string | Incident description | | ↳ `description` | string | Detailed description of the incident |
| ↳ `mode` | string | Incident mode \(standard, retrospective, test\) | | ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
| ↳ `call_url` | string | Video call URL | | ↳ `call_url` | string | URL for the incident call/bridge |
| ↳ `severity` | object | Incident severity | | ↳ `severity` | object | Severity of the incident |
| ↳ `id` | string | Severity ID | | ↳ `id` | string | Severity ID |
| ↳ `name` | string | Severity name \(e.g., Critical, Major, Minor\) | | ↳ `name` | string | Severity name |
| ↳ `description` | string | Severity description | | ↳ `rank` | number | Severity rank |
| ↳ `rank` | number | Severity rank \(lower = more severe\) | | ↳ `rank` | number | Severity rank |
| ↳ `status` | object | Current incident status | | ↳ `status` | object | Current status of the incident |
| ↳ `id` | string | Status ID | | ↳ `id` | string | Status ID |
| ↳ `name` | string | Status name | | ↳ `name` | string | Status name |
| ↳ `description` | string | Status description | | ↳ `category` | string | Status category |
| ↳ `category` | string | Status category \(triage, active, post-incident, closed\) | | ↳ `category` | string | Status category |
| ↳ `incident_type` | object | Incident type | | ↳ `incident_type` | object | Type of the incident |
| ↳ `id` | string | Incident type ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Incident type name | | ↳ `name` | string | Type name |
| ↳ `description` | string | Incident type description | | ↳ `created_at` | string | Creation timestamp |
| ↳ `is_default` | boolean | Whether this is the default incident type | | ↳ `updated_at` | string | Last update timestamp |
| ↳ `created_at` | string | When the incident was created \(ISO 8601\) | | ↳ `incident_url` | string | URL to the incident |
| ↳ `updated_at` | string | When the incident was last updated \(ISO 8601\) | | ↳ `slack_channel_id` | string | Associated Slack channel ID |
| ↳ `incident_url` | string | URL to the incident page | | ↳ `slack_channel_name` | string | Associated Slack channel name |
| ↳ `slack_channel_id` | string | Slack channel ID | | ↳ `visibility` | string | Incident visibility |
| ↳ `slack_channel_name` | string | Slack channel name |
| ↳ `visibility` | string | Incident visibility \(public, private\) |
| `pagination_meta` | object | Pagination metadata | | `pagination_meta` | object | Pagination metadata |
| ↳ `after` | string | Cursor for next page | | ↳ `after` | string | Cursor for the next page |
| ↳ `page_size` | number | Number of items per page | | ↳ `page_size` | number | Number of items per page |
| ↳ `total_record_count` | number | Total number of records | | ↳ `total_record_count` | number | Total number of records available |
### `incidentio_incidents_create` ### `incidentio_incidents_create`
@@ -99,9 +97,9 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `idempotency_key` | string | Yes | Unique identifier to prevent duplicate incident creation. Use a UUID or unique string. | | `idempotency_key` | string | Yes | Unique identifier to prevent duplicate incident creation. Use a UUID or unique string. |
| `name` | string | No | Name of the incident \(e.g., "Database connection issues"\) | | `name` | string | No | Name of the incident \(optional\) |
| `summary` | string | No | Brief summary of the incident \(e.g., "Intermittent connection failures to primary database"\) | | `summary` | string | No | Brief summary of the incident |
| `severity_id` | string | Yes | ID of the severity level \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `severity_id` | string | Yes | ID of the severity level \(required\) |
| `incident_type_id` | string | No | ID of the incident type | | `incident_type_id` | string | No | ID of the incident type |
| `incident_status_id` | string | No | ID of the initial incident status | | `incident_status_id` | string | No | ID of the initial incident status |
| `visibility` | string | Yes | Visibility of the incident: "public" or "private" \(required\) | | `visibility` | string | Yes | Visibility of the incident: "public" or "private" \(required\) |
@@ -111,8 +109,8 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `incident` | object | The created incident object | | `incident` | object | The created incident object |
| ↳ `id` | string | Incident ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Incident name | | ↳ `name` | string | Type name |
| ↳ `summary` | string | Brief summary of the incident | | ↳ `summary` | string | Brief summary of the incident |
| ↳ `description` | string | Detailed description of the incident | | ↳ `description` | string | Detailed description of the incident |
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | | ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
@@ -121,10 +119,12 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and
| ↳ `id` | string | Severity ID | | ↳ `id` | string | Severity ID |
| ↳ `name` | string | Severity name | | ↳ `name` | string | Severity name |
| ↳ `rank` | number | Severity rank | | ↳ `rank` | number | Severity rank |
| ↳ `rank` | number | Severity rank |
| ↳ `status` | object | Current status of the incident | | ↳ `status` | object | Current status of the incident |
| ↳ `id` | string | Status ID | | ↳ `id` | string | Status ID |
| ↳ `name` | string | Status name | | ↳ `name` | string | Status name |
| ↳ `category` | string | Status category | | ↳ `category` | string | Status category |
| ↳ `category` | string | Status category |
| ↳ `incident_type` | object | Type of the incident | | ↳ `incident_type` | object | Type of the incident |
| ↳ `id` | string | Type ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Type name | | ↳ `name` | string | Type name |
@@ -144,15 +144,15 @@ Retrieve detailed information about a specific incident from incident.io by its
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | ID of the incident to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | ID of the incident to retrieve |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `incident` | object | Detailed incident information | | `incident` | object | Detailed incident information |
| ↳ `id` | string | Incident ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Incident name | | ↳ `name` | string | Type name |
| ↳ `summary` | string | Brief summary of the incident | | ↳ `summary` | string | Brief summary of the incident |
| ↳ `description` | string | Detailed description of the incident | | ↳ `description` | string | Detailed description of the incident |
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | | ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
@@ -162,10 +162,12 @@ Retrieve detailed information about a specific incident from incident.io by its
| ↳ `id` | string | Severity ID | | ↳ `id` | string | Severity ID |
| ↳ `name` | string | Severity name | | ↳ `name` | string | Severity name |
| ↳ `rank` | number | Severity rank | | ↳ `rank` | number | Severity rank |
| ↳ `rank` | number | Severity rank |
| ↳ `status` | object | Current status of the incident | | ↳ `status` | object | Current status of the incident |
| ↳ `id` | string | Status ID | | ↳ `id` | string | Status ID |
| ↳ `name` | string | Status name | | ↳ `name` | string | Status name |
| ↳ `category` | string | Status category | | ↳ `category` | string | Status category |
| ↳ `category` | string | Status category |
| ↳ `incident_type` | object | Type of the incident | | ↳ `incident_type` | object | Type of the incident |
| ↳ `id` | string | Type ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Type name | | ↳ `name` | string | Type name |
@@ -187,11 +189,11 @@ Update an existing incident in incident.io. Can update name, summary, severity,
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | ID of the incident to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | ID of the incident to update |
| `name` | string | No | Updated name of the incident \(e.g., "Database connection issues"\) | | `name` | string | No | Updated name of the incident |
| `summary` | string | No | Updated summary of the incident \(e.g., "Intermittent connection failures to primary database"\) | | `summary` | string | No | Updated summary of the incident |
| `severity_id` | string | No | Updated severity ID for the incident \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `severity_id` | string | No | Updated severity ID for the incident |
| `incident_status_id` | string | No | Updated status ID for the incident \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_status_id` | string | No | Updated status ID for the incident |
| `incident_type_id` | string | No | Updated incident type ID | | `incident_type_id` | string | No | Updated incident type ID |
| `notify_incident_channel` | boolean | Yes | Whether to notify the incident channel about this update | | `notify_incident_channel` | boolean | Yes | Whether to notify the incident channel about this update |
@@ -200,8 +202,8 @@ Update an existing incident in incident.io. Can update name, summary, severity,
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `incident` | object | The updated incident object | | `incident` | object | The updated incident object |
| ↳ `id` | string | Incident ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Incident name | | ↳ `name` | string | Type name |
| ↳ `summary` | string | Brief summary of the incident | | ↳ `summary` | string | Brief summary of the incident |
| ↳ `description` | string | Detailed description of the incident | | ↳ `description` | string | Detailed description of the incident |
| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | | ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) |
@@ -210,10 +212,12 @@ Update an existing incident in incident.io. Can update name, summary, severity,
| ↳ `id` | string | Severity ID | | ↳ `id` | string | Severity ID |
| ↳ `name` | string | Severity name | | ↳ `name` | string | Severity name |
| ↳ `rank` | number | Severity rank | | ↳ `rank` | number | Severity rank |
| ↳ `rank` | number | Severity rank |
| ↳ `status` | object | Current status of the incident | | ↳ `status` | object | Current status of the incident |
| ↳ `id` | string | Status ID | | ↳ `id` | string | Status ID |
| ↳ `name` | string | Status name | | ↳ `name` | string | Status name |
| ↳ `category` | string | Status category | | ↳ `category` | string | Status category |
| ↳ `category` | string | Status category |
| ↳ `incident_type` | object | Type of the incident | | ↳ `incident_type` | object | Type of the incident |
| ↳ `id` | string | Type ID | | ↳ `id` | string | Type ID |
| ↳ `name` | string | Type name | | ↳ `name` | string | Type name |
@@ -233,20 +237,22 @@ List actions from incident.io. Optionally filter by incident ID.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `incident_id` | string | No | Filter actions by incident ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_id` | string | No | Filter actions by incident ID |
| `page_size` | number | No | Number of actions to return per page \(e.g., 10, 25, 50\) | | `page_size` | number | No | Number of actions to return per page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `actions` | array | List of actions | | `actions` | array | List of actions |
| ↳ `id` | string | Action ID | | ↳ `id` | string | User ID |
| ↳ `description` | string | Action description | | ↳ `description` | string | Action description |
| ↳ `assignee` | object | Assigned user | | ↳ `assignee` | object | Assigned user |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `status` | string | Action status | | ↳ `status` | string | Action status |
| ↳ `due_at` | string | Due date/time | | ↳ `due_at` | string | Due date/time |
| ↳ `created_at` | string | Creation timestamp | | ↳ `created_at` | string | Creation timestamp |
@@ -261,6 +267,9 @@ List actions from incident.io. Optionally filter by incident ID.
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) | | ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
| ↳ `issue_name` | string | Issue identifier | | ↳ `issue_name` | string | Issue identifier |
| ↳ `issue_permalink` | string | URL to the external issue | | ↳ `issue_permalink` | string | URL to the external issue |
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
| ↳ `issue_name` | string | Issue identifier |
| ↳ `issue_permalink` | string | URL to the external issue |
### `incidentio_actions_show` ### `incidentio_actions_show`
@@ -271,19 +280,21 @@ Get detailed information about a specific action from incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | Action ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | Action ID |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `action` | object | Action details | | `action` | object | Action details |
| ↳ `id` | string | Action ID | | ↳ `id` | string | User ID |
| ↳ `description` | string | Action description | | ↳ `description` | string | Action description |
| ↳ `assignee` | object | Assigned user | | ↳ `assignee` | object | Assigned user |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `status` | string | Action status | | ↳ `status` | string | Action status |
| ↳ `due_at` | string | Due date/time | | ↳ `due_at` | string | Due date/time |
| ↳ `created_at` | string | Creation timestamp | | ↳ `created_at` | string | Creation timestamp |
@@ -298,6 +309,9 @@ Get detailed information about a specific action from incident.io.
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) | | ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
| ↳ `issue_name` | string | Issue identifier | | ↳ `issue_name` | string | Issue identifier |
| ↳ `issue_permalink` | string | URL to the external issue | | ↳ `issue_permalink` | string | URL to the external issue |
| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) |
| ↳ `issue_name` | string | Issue identifier |
| ↳ `issue_permalink` | string | URL to the external issue |
### `incidentio_follow_ups_list` ### `incidentio_follow_ups_list`
@@ -308,27 +322,30 @@ List follow-ups from incident.io. Optionally filter by incident ID.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `incident_id` | string | No | Filter follow-ups by incident ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `incident_id` | string | No | Filter follow-ups by incident ID |
| `page_size` | number | No | Number of follow-ups to return per page \(e.g., 10, 25, 50\) | | `page_size` | number | No | Number of follow-ups to return per page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `follow_ups` | array | List of follow-ups | | `follow_ups` | array | List of follow-ups |
| ↳ `id` | string | Follow-up ID | | ↳ `id` | string | User ID |
| ↳ `title` | string | Follow-up title | | ↳ `title` | string | Follow-up title |
| ↳ `description` | string | Follow-up description | | ↳ `description` | string | Priority description |
| ↳ `assignee` | object | Assigned user | | ↳ `assignee` | object | Assigned user |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `status` | string | Follow-up status | | ↳ `status` | string | Follow-up status |
| ↳ `priority` | object | Follow-up priority | | ↳ `priority` | object | Follow-up priority |
| ↳ `id` | string | Priority ID | | ↳ `id` | string | Priority ID |
| ↳ `name` | string | Priority name | | ↳ `name` | string | Priority name |
| ↳ `description` | string | Priority description | | ↳ `description` | string | Priority description |
| ↳ `rank` | number | Priority rank | | ↳ `rank` | number | Priority rank |
| ↳ `rank` | number | Priority rank |
| ↳ `created_at` | string | Creation timestamp | | ↳ `created_at` | string | Creation timestamp |
| ↳ `updated_at` | string | Last update timestamp | | ↳ `updated_at` | string | Last update timestamp |
| ↳ `incident_id` | string | Associated incident ID | | ↳ `incident_id` | string | Associated incident ID |
@@ -342,6 +359,9 @@ List follow-ups from incident.io. Optionally filter by incident ID.
| ↳ `provider` | string | External provider name | | ↳ `provider` | string | External provider name |
| ↳ `issue_name` | string | External issue name or ID | | ↳ `issue_name` | string | External issue name or ID |
| ↳ `issue_permalink` | string | Permalink to external issue | | ↳ `issue_permalink` | string | Permalink to external issue |
| ↳ `provider` | string | External provider name |
| ↳ `issue_name` | string | External issue name or ID |
| ↳ `issue_permalink` | string | Permalink to external issue |
### `incidentio_follow_ups_show` ### `incidentio_follow_ups_show`
@@ -352,26 +372,29 @@ Get detailed information about a specific follow-up from incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | Follow-up ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | Follow-up ID |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `follow_up` | object | Follow-up details | | `follow_up` | object | Follow-up details |
| ↳ `id` | string | Follow-up ID | | ↳ `id` | string | User ID |
| ↳ `title` | string | Follow-up title | | ↳ `title` | string | Follow-up title |
| ↳ `description` | string | Follow-up description | | ↳ `description` | string | Priority description |
| ↳ `assignee` | object | Assigned user | | ↳ `assignee` | object | Assigned user |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `status` | string | Follow-up status | | ↳ `status` | string | Follow-up status |
| ↳ `priority` | object | Follow-up priority | | ↳ `priority` | object | Follow-up priority |
| ↳ `id` | string | Priority ID | | ↳ `id` | string | Priority ID |
| ↳ `name` | string | Priority name | | ↳ `name` | string | Priority name |
| ↳ `description` | string | Priority description | | ↳ `description` | string | Priority description |
| ↳ `rank` | number | Priority rank | | ↳ `rank` | number | Priority rank |
| ↳ `rank` | number | Priority rank |
| ↳ `created_at` | string | Creation timestamp | | ↳ `created_at` | string | Creation timestamp |
| ↳ `updated_at` | string | Last update timestamp | | ↳ `updated_at` | string | Last update timestamp |
| ↳ `incident_id` | string | Associated incident ID | | ↳ `incident_id` | string | Associated incident ID |
@@ -385,6 +408,9 @@ Get detailed information about a specific follow-up from incident.io.
| ↳ `provider` | string | External provider name | | ↳ `provider` | string | External provider name |
| ↳ `issue_name` | string | External issue name or ID | | ↳ `issue_name` | string | External issue name or ID |
| ↳ `issue_permalink` | string | Permalink to external issue | | ↳ `issue_permalink` | string | Permalink to external issue |
| ↳ `provider` | string | External provider name |
| ↳ `issue_name` | string | External issue name or ID |
| ↳ `issue_permalink` | string | Permalink to external issue |
### `incidentio_users_list` ### `incidentio_users_list`
@@ -395,7 +421,7 @@ List all users in your Incident.io workspace. Returns user details including id,
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Incident.io API Key | | `apiKey` | string | Yes | Incident.io API Key |
| `page_size` | number | No | Number of results to return per page \(e.g., 10, 25, 50\). Default: 25 | | `page_size` | number | No | Number of results to return per page \(default: 25\) |
#### Output #### Output
@@ -416,7 +442,7 @@ Get detailed information about a specific user in your Incident.io workspace by
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Incident.io API Key | | `apiKey` | string | Yes | Incident.io API Key |
| `id` | string | Yes | The unique identifier of the user to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The unique identifier of the user to retrieve |
#### Output #### Output
@@ -437,8 +463,8 @@ List all workflows in your incident.io workspace.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `page_size` | number | No | Number of workflows to return per page \(e.g., 10, 25, 50\) | | `page_size` | number | No | Number of workflows to return per page |
| `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `after` | string | No | Pagination cursor to fetch the next page of results |
#### Output #### Output
@@ -464,7 +490,7 @@ Get details of a specific workflow in incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the workflow to retrieve \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the workflow to retrieve |
#### Output #### Output
@@ -487,8 +513,8 @@ Update an existing workflow in incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the workflow to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the workflow to update |
| `name` | string | No | New name for the workflow \(e.g., "Notify on Critical Incidents"\) | | `name` | string | No | New name for the workflow |
| `state` | string | No | New state for the workflow \(active, draft, or disabled\) | | `state` | string | No | New state for the workflow \(active, draft, or disabled\) |
| `folder` | string | No | New folder for the workflow | | `folder` | string | No | New folder for the workflow |
@@ -513,7 +539,7 @@ Delete a workflow in incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the workflow to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the workflow to delete |
#### Output #### Output
@@ -530,8 +556,8 @@ List all schedules in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | | `page_size` | number | No | Number of results per page \(default: 25\) |
| `after` | string | No | Pagination cursor to fetch the next page of results \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `after` | string | No | Pagination cursor to fetch the next page of results |
#### Output #### Output
@@ -556,7 +582,7 @@ Create a new schedule in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `name` | string | Yes | Name of the schedule \(e.g., "Primary On-Call"\) | | `name` | string | Yes | Name of the schedule |
| `timezone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) | | `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"\}\]\}\]\} | | `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 | | `Example` | string | No | No description |
@@ -581,7 +607,7 @@ Get details of a specific schedule in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the schedule \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the schedule |
#### Output #### Output
@@ -603,8 +629,8 @@ Update an existing schedule in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the schedule to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the schedule to update |
| `name` | string | No | New name for the schedule \(e.g., "Primary On-Call"\) | | `name` | string | No | New name for the schedule |
| `timezone` | string | No | New timezone for the schedule \(e.g., America/New_York\) | | `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"\}\]\}\]\} | | `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 | | `Example` | string | No | No description |
@@ -629,7 +655,7 @@ Delete a schedule in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the schedule to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the schedule to delete |
#### Output #### Output
@@ -646,7 +672,7 @@ List all escalation policies in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `page_size` | number | No | Number of results per page \(e.g., 10, 25, 50\). Default: 25 | | `page_size` | number | No | Number of results per page \(default: 25\) |
#### Output #### Output
@@ -668,7 +694,7 @@ Create a new escalation policy in incident.io
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `idempotency_key` | string | Yes | Unique identifier to prevent duplicate escalation creation. Use a UUID or unique string. | | `idempotency_key` | string | Yes | Unique identifier to prevent duplicate escalation creation. Use a UUID or unique string. |
| `title` | string | Yes | Title of the escalation \(e.g., "Database Critical Alert"\) | | `title` | string | Yes | Title of the escalation |
| `escalation_path_id` | string | No | ID of the escalation path to use \(required if user_ids not provided\) | | `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\) | | `user_ids` | string | No | Comma-separated list of user IDs to notify \(required if escalation_path_id not provided\) |
@@ -691,7 +717,7 @@ Get details of a specific escalation policy in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the escalation policy \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the escalation policy |
#### Output #### Output
@@ -734,7 +760,7 @@ Create a new custom field in incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `name` | string | Yes | Name of the custom field \(e.g., "Affected Service"\) | | `name` | string | Yes | Name of the custom field |
| `description` | string | Yes | Description of the custom field \(required\) | | `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\) | | `field_type` | string | Yes | Type of the custom field \(e.g., text, single_select, multi_select, numeric, datetime, link, user, team\) |
@@ -759,7 +785,7 @@ Get detailed information about a specific custom field from incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | Custom field ID |
#### Output #### Output
@@ -782,8 +808,8 @@ Update an existing custom field in incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | Custom field ID |
| `name` | string | Yes | New name for the custom field \(e.g., "Affected Service"\) | | `name` | string | Yes | New name for the custom field \(required\) |
| `description` | string | Yes | New description for the custom field \(required\) | | `description` | string | Yes | New description for the custom field \(required\) |
#### Output #### Output
@@ -807,7 +833,7 @@ Delete a custom field from incident.io.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | Custom field ID \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | Custom field ID |
#### Output #### Output
@@ -909,7 +935,7 @@ Create a new incident role in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `name` | string | Yes | Name of the incident role \(e.g., "Incident Commander"\) | | `name` | string | Yes | Name of the incident role |
| `description` | string | Yes | Description of the incident role | | `description` | string | Yes | Description of the incident role |
| `instructions` | string | Yes | Instructions for the incident role | | `instructions` | string | Yes | Instructions for the incident role |
| `shortform` | string | Yes | Short form abbreviation for the role | | `shortform` | string | Yes | Short form abbreviation for the role |
@@ -938,7 +964,7 @@ Get details of a specific incident role in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the incident role \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the incident role |
#### Output #### Output
@@ -964,8 +990,8 @@ Update an existing incident role in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the incident role to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the incident role to update |
| `name` | string | Yes | Name of the incident role \(e.g., "Incident Commander"\) | | `name` | string | Yes | Name of the incident role |
| `description` | string | Yes | Description of the incident role | | `description` | string | Yes | Description of the incident role |
| `instructions` | string | Yes | Instructions for the incident role | | `instructions` | string | Yes | Instructions for the incident role |
| `shortform` | string | Yes | Short form abbreviation for the role | | `shortform` | string | Yes | Short form abbreviation for the role |
@@ -994,7 +1020,7 @@ Delete an incident role in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the incident role to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the incident role to delete |
#### Output #### Output
@@ -1032,7 +1058,7 @@ Get details of a specific incident timestamp definition in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the incident timestamp \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the incident timestamp |
#### Output #### Output
@@ -1054,30 +1080,34 @@ List all updates for a specific incident in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `incident_id` | string | No | The ID of the incident to get updates for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\). If not provided, returns all updates | | `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 \(e.g., 10, 25, 50\) | | `page_size` | number | No | Number of results to return per page |
| `after` | string | No | Cursor for pagination \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `after` | string | No | Cursor for pagination |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `incident_updates` | array | List of incident updates | | `incident_updates` | array | List of incident updates |
| ↳ `id` | string | The update ID | | ↳ `id` | string | User ID |
| ↳ `incident_id` | string | The incident ID | | ↳ `incident_id` | string | The incident ID |
| ↳ `message` | string | The update message | | ↳ `message` | string | The update message |
| ↳ `new_severity` | object | New severity if changed | | ↳ `new_severity` | object | New severity if changed |
| ↳ `id` | string | Severity ID | | ↳ `id` | string | Severity ID |
| ↳ `name` | string | Severity name | | ↳ `name` | string | Severity name |
| ↳ `rank` | number | Severity rank | | ↳ `rank` | number | Severity rank |
| ↳ `name` | string | User name |
| ↳ `rank` | number | Severity rank |
| ↳ `new_status` | object | New status if changed | | ↳ `new_status` | object | New status if changed |
| ↳ `id` | string | Status ID | | ↳ `id` | string | Status ID |
| ↳ `name` | string | Status name | | ↳ `name` | string | Status name |
| ↳ `category` | string | Status category | | ↳ `category` | string | Status category |
| ↳ `category` | string | Status category |
| ↳ `updater` | object | User who created the update | | ↳ `updater` | object | User who created the update |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `email` | string | User email |
| ↳ `created_at` | string | When the update was created | | ↳ `created_at` | string | When the update was created |
| ↳ `updated_at` | string | When the update was last modified | | ↳ `updated_at` | string | When the update was last modified |
| `pagination_meta` | object | Pagination information | | `pagination_meta` | object | Pagination information |
@@ -1093,23 +1123,25 @@ List all entries for a specific schedule in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `schedule_id` | string | Yes | The ID of the schedule to get entries for \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `schedule_id` | string | Yes | The ID of the schedule to get entries for |
| `entry_window_start` | string | No | Start date/time to filter entries in ISO 8601 format \(e.g., "2024-01-15T09:00:00Z"\) | | `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 in ISO 8601 format \(e.g., "2024-01-22T09:00:00Z"\) | | `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 \(e.g., 10, 25, 50\) | | `page_size` | number | No | Number of results to return per page |
| `after` | string | No | Cursor for pagination \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `after` | string | No | Cursor for pagination |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `schedule_entries` | array | List of schedule entries | | `schedule_entries` | array | List of schedule entries |
| ↳ `id` | string | The entry ID | | ↳ `id` | string | User ID |
| ↳ `schedule_id` | string | The schedule ID | | ↳ `schedule_id` | string | The schedule ID |
| ↳ `user` | object | User assigned to this entry | | ↳ `user` | object | User assigned to this entry |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `start_at` | string | When the entry starts | | ↳ `start_at` | string | When the entry starts |
| ↳ `end_at` | string | When the entry ends | | ↳ `end_at` | string | When the entry ends |
| ↳ `layer_id` | string | The schedule layer ID | | ↳ `layer_id` | string | The schedule layer ID |
@@ -1129,26 +1161,28 @@ Create a new schedule override in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `rotation_id` | string | Yes | The ID of the rotation to override \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `rotation_id` | string | Yes | The ID of the rotation to override |
| `schedule_id` | string | Yes | The ID of the schedule \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `schedule_id` | string | Yes | The ID of the schedule |
| `user_id` | string | No | The ID of the user to assign \(provide one of: user_id, user_email, or user_slack_id\) | | `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_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\) | | `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 in ISO 8601 format \(e.g., "2024-01-15T09:00:00Z"\) | | `start_at` | string | Yes | When the override starts \(ISO 8601 format\) |
| `end_at` | string | Yes | When the override ends in ISO 8601 format \(e.g., "2024-01-22T09:00:00Z"\) | | `end_at` | string | Yes | When the override ends \(ISO 8601 format\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `override` | object | The created schedule override | | `override` | object | The created schedule override |
| ↳ `id` | string | The override ID | | ↳ `id` | string | User ID |
| ↳ `rotation_id` | string | The rotation ID | | ↳ `rotation_id` | string | The rotation ID |
| ↳ `schedule_id` | string | The schedule ID | | ↳ `schedule_id` | string | The schedule ID |
| ↳ `user` | object | User assigned to this override | | ↳ `user` | object | User assigned to this override |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `start_at` | string | When the override starts | | ↳ `start_at` | string | When the override starts |
| ↳ `end_at` | string | When the override ends | | ↳ `end_at` | string | When the override ends |
| ↳ `created_at` | string | When the override was created | | ↳ `created_at` | string | When the override was created |
@@ -1163,7 +1197,7 @@ Create a new escalation path in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `name` | string | Yes | Name of the escalation path \(e.g., "Critical Incident Path"\) | | `name` | string | Yes | Name of the escalation 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\) | | `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\} | | `working_hours` | json | No | Optional working hours configuration. Array of \{weekday, start_time, end_time\} |
@@ -1172,7 +1206,7 @@ Create a new escalation path in incident.io
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `escalation_path` | object | The created escalation path | | `escalation_path` | object | The created escalation path |
| ↳ `id` | string | The escalation path ID | | ↳ `id` | string | Target ID |
| ↳ `name` | string | The escalation path name | | ↳ `name` | string | The escalation path name |
| ↳ `path` | array | Array of escalation levels | | ↳ `path` | array | Array of escalation levels |
| ↳ `targets` | array | Targets for this level | | ↳ `targets` | array | Targets for this level |
@@ -1181,11 +1215,30 @@ Create a new escalation path in incident.io
| ↳ `schedule_id` | string | Schedule ID if type is schedule | | ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user | | ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level | | ↳ `urgency` | string | Urgency level |
| ↳ `id` | string | Target ID |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
| ↳ `targets` | array | Targets for this level |
| ↳ `id` | string | Target ID |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | | ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
| ↳ `working_hours` | array | Working hours configuration | | ↳ `working_hours` | array | Working hours configuration |
| ↳ `weekday` | string | Day of week | | ↳ `weekday` | string | Day of week |
| ↳ `start_time` | string | Start time | | ↳ `start_time` | string | Start time |
| ↳ `end_time` | string | End time | | ↳ `end_time` | string | End time |
| ↳ `weekday` | string | Day of week |
| ↳ `start_time` | string | Start time |
| ↳ `end_time` | string | End time |
| ↳ `created_at` | string | When the path was created | | ↳ `created_at` | string | When the path was created |
| ↳ `updated_at` | string | When the path was last updated | | ↳ `updated_at` | string | When the path was last updated |
@@ -1198,14 +1251,14 @@ Get details of a specific escalation path in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the escalation path \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the escalation path |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `escalation_path` | object | The escalation path details | | `escalation_path` | object | The escalation path details |
| ↳ `id` | string | The escalation path ID | | ↳ `id` | string | Target ID |
| ↳ `name` | string | The escalation path name | | ↳ `name` | string | The escalation path name |
| ↳ `path` | array | Array of escalation levels | | ↳ `path` | array | Array of escalation levels |
| ↳ `targets` | array | Targets for this level | | ↳ `targets` | array | Targets for this level |
@@ -1214,11 +1267,30 @@ Get details of a specific escalation path in incident.io
| ↳ `schedule_id` | string | Schedule ID if type is schedule | | ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user | | ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level | | ↳ `urgency` | string | Urgency level |
| ↳ `id` | string | Target ID |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
| ↳ `targets` | array | Targets for this level |
| ↳ `id` | string | Target ID |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | | ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
| ↳ `working_hours` | array | Working hours configuration | | ↳ `working_hours` | array | Working hours configuration |
| ↳ `weekday` | string | Day of week | | ↳ `weekday` | string | Day of week |
| ↳ `start_time` | string | Start time | | ↳ `start_time` | string | Start time |
| ↳ `end_time` | string | End time | | ↳ `end_time` | string | End time |
| ↳ `weekday` | string | Day of week |
| ↳ `start_time` | string | Start time |
| ↳ `end_time` | string | End time |
| ↳ `created_at` | string | When the path was created | | ↳ `created_at` | string | When the path was created |
| ↳ `updated_at` | string | When the path was last updated | | ↳ `updated_at` | string | When the path was last updated |
@@ -1231,8 +1303,8 @@ Update an existing escalation path in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the escalation path to update \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the escalation path to update |
| `name` | string | No | New name for the escalation path \(e.g., "Critical Incident Path"\) | | `name` | string | No | New name for the escalation path |
| `path` | json | No | New escalation path configuration. Array of escalation levels with targets and time_to_ack_seconds | | `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\} | | `working_hours` | json | No | New working hours configuration. Array of \{weekday, start_time, end_time\} |
@@ -1241,7 +1313,7 @@ Update an existing escalation path in incident.io
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `escalation_path` | object | The updated escalation path | | `escalation_path` | object | The updated escalation path |
| ↳ `id` | string | The escalation path ID | | ↳ `id` | string | Target ID |
| ↳ `name` | string | The escalation path name | | ↳ `name` | string | The escalation path name |
| ↳ `path` | array | Array of escalation levels | | ↳ `path` | array | Array of escalation levels |
| ↳ `targets` | array | Targets for this level | | ↳ `targets` | array | Targets for this level |
@@ -1250,11 +1322,30 @@ Update an existing escalation path in incident.io
| ↳ `schedule_id` | string | Schedule ID if type is schedule | | ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user | | ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level | | ↳ `urgency` | string | Urgency level |
| ↳ `id` | string | Target ID |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
| ↳ `targets` | array | Targets for this level |
| ↳ `id` | string | Target ID |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `type` | string | Target type |
| ↳ `schedule_id` | string | Schedule ID if type is schedule |
| ↳ `user_id` | string | User ID if type is user |
| ↳ `urgency` | string | Urgency level |
| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | | ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds |
| ↳ `working_hours` | array | Working hours configuration | | ↳ `working_hours` | array | Working hours configuration |
| ↳ `weekday` | string | Day of week | | ↳ `weekday` | string | Day of week |
| ↳ `start_time` | string | Start time | | ↳ `start_time` | string | Start time |
| ↳ `end_time` | string | End time | | ↳ `end_time` | string | End time |
| ↳ `weekday` | string | Day of week |
| ↳ `start_time` | string | Start time |
| ↳ `end_time` | string | End time |
| ↳ `created_at` | string | When the path was created | | ↳ `created_at` | string | When the path was created |
| ↳ `updated_at` | string | When the path was last updated | | ↳ `updated_at` | string | When the path was last updated |
@@ -1267,7 +1358,7 @@ Delete an escalation path in incident.io
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | incident.io API Key | | `apiKey` | string | Yes | incident.io API Key |
| `id` | string | Yes | The ID of the escalation path to delete \(e.g., "01FCNDV6P870EA6S7TK1DSYDG0"\) | | `id` | string | Yes | The ID of the escalation path to delete |
#### Output #### Output

View File

@@ -62,7 +62,7 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `contact` | object | Created contact object | | `contact` | object | Created contact object |
| ↳ `id` | string | Unique identifier for the contact | | ↳ `id` | string | Unique identifier for the contact |
| ↳ `type` | string | Object type \(contact\) | | ↳ `type` | string | List type |
| ↳ `role` | string | Role of the contact \(user or lead\) | | ↳ `role` | string | Role of the contact \(user or lead\) |
| ↳ `email` | string | Email address of the contact | | ↳ `email` | string | Email address of the contact |
| ↳ `phone` | string | Phone number of the contact | | ↳ `phone` | string | Phone number of the contact |
@@ -82,6 +82,10 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
| ↳ `data` | array | Array of tag objects | | ↳ `data` | array | Array of tag objects |
| ↳ `has_more` | boolean | Whether there are more tags | | ↳ `has_more` | boolean | Whether there are more tags |
| ↳ `total_count` | number | Total number of tags | | ↳ `total_count` | number | Total number of tags |
| ↳ `url` | string | URL to fetch companies |
| ↳ `data` | array | Array of social profile objects |
| ↳ `has_more` | boolean | Whether there are more companies |
| ↳ `total_count` | number | Total number of companies |
| ↳ `notes` | object | Notes associated with the contact | | ↳ `notes` | object | Notes associated with the contact |
| ↳ `type` | string | List type | | ↳ `type` | string | List type |
| ↳ `url` | string | URL to fetch notes | | ↳ `url` | string | URL to fetch notes |
@@ -101,6 +105,11 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a
| ↳ `country` | string | Country | | ↳ `country` | string | Country |
| ↳ `country_code` | string | Country code | | ↳ `country_code` | string | Country code |
| ↳ `continent_code` | string | Continent code | | ↳ `continent_code` | string | Continent code |
| ↳ `city` | string | City |
| ↳ `region` | string | Region/State |
| ↳ `country` | string | Country |
| ↳ `country_code` | string | Country code |
| ↳ `continent_code` | string | Continent code |
| ↳ `social_profiles` | object | Social profiles of the contact | | ↳ `social_profiles` | object | Social profiles of the contact |
| ↳ `type` | string | List type | | ↳ `type` | string | List type |
| ↳ `data` | array | Array of social profile objects | | ↳ `data` | array | Array of social profile objects |
@@ -126,61 +135,21 @@ Get a single contact by ID from Intercom. Returns API-aligned fields only.
| ↳ `type` | string | Object type \(contact\) | | ↳ `type` | string | Object type \(contact\) |
| ↳ `role` | string | Role of the contact \(user or lead\) | | ↳ `role` | string | Role of the contact \(user or lead\) |
| ↳ `email` | string | Email address of the contact | | ↳ `email` | string | Email address of the contact |
| ↳ `email_domain` | string | Email domain of the contact |
| ↳ `phone` | string | Phone number of the contact | | ↳ `phone` | string | Phone number of the contact |
| ↳ `name` | string | Name of the contact | | ↳ `name` | string | Name of the contact |
| ↳ `avatar` | string | Avatar URL of the contact | | ↳ `avatar` | string | Avatar URL of the contact |
| ↳ `owner_id` | string | ID of the admin assigned account ownership | | ↳ `owner_id` | string | ID of the admin assigned to this contact |
| ↳ `external_id` | string | External identifier provided by the client | | ↳ `external_id` | string | External identifier for the contact |
| ↳ `workspace_id` | string | Workspace ID the contact belongs to |
| ↳ `created_at` | number | Unix timestamp when contact was created | | ↳ `created_at` | number | Unix timestamp when contact was created |
| ↳ `updated_at` | number | Unix timestamp when contact was last updated | | ↳ `updated_at` | number | Unix timestamp when contact was last updated |
| ↳ `signed_up_at` | number | Unix timestamp when user signed up | | ↳ `workspace_id` | string | Workspace ID the contact belongs to |
| ↳ `last_seen_at` | number | Unix timestamp when user was last seen |
| ↳ `last_contacted_at` | number | Unix timestamp when contact was last contacted |
| ↳ `last_replied_at` | number | Unix timestamp when contact last replied |
| ↳ `last_email_opened_at` | number | Unix timestamp when contact last opened an email |
| ↳ `last_email_clicked_at` | number | Unix timestamp when contact last clicked an email link |
| ↳ `has_hard_bounced` | boolean | Whether email to this contact has hard bounced |
| ↳ `marked_email_as_spam` | boolean | Whether contact marked email as spam |
| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
| ↳ `browser` | string | Browser used by contact |
| ↳ `browser_version` | string | Browser version |
| ↳ `browser_language` | string | Browser language setting |
| ↳ `os` | string | Operating system |
| ↳ `language_override` | string | Language override setting |
| ↳ `custom_attributes` | object | Custom attributes set on the contact | | ↳ `custom_attributes` | object | Custom attributes set on the contact |
| ↳ `tags` | object | Tags associated with the contact \(up to 10 displayed\) | | ↳ `tags` | object | Tags associated with the contact |
| ↳ `type` | string | List type identifier | | ↳ `notes` | object | Notes associated with the contact |
| ↳ `url` | string | URL to fetch full list | | ↳ `companies` | object | Companies associated with the contact |
| ↳ `data` | array | Array of objects \(up to 10\) |
| ↳ `has_more` | boolean | Whether there are more items beyond this list |
| ↳ `total_count` | number | Total number of items |
| ↳ `notes` | object | Notes associated with the contact \(up to 10 displayed\) |
| ↳ `type` | string | List type identifier |
| ↳ `url` | string | URL to fetch full list |
| ↳ `data` | array | Array of objects \(up to 10\) |
| ↳ `has_more` | boolean | Whether there are more items beyond this list |
| ↳ `total_count` | number | Total number of items |
| ↳ `companies` | object | Companies associated with the contact \(up to 10 displayed\) |
| ↳ `type` | string | List type identifier |
| ↳ `url` | string | URL to fetch full list |
| ↳ `data` | array | Array of objects \(up to 10\) |
| ↳ `has_more` | boolean | Whether there are more items beyond this list |
| ↳ `total_count` | number | Total number of items |
| ↳ `location` | object | Location information for the contact | | ↳ `location` | object | Location information for the contact |
| ↳ `type` | string | Object type \(location\) |
| ↳ `city` | string | City name |
| ↳ `region` | string | Region or state name |
| ↳ `country` | string | Country name |
| ↳ `country_code` | string | ISO country code |
| ↳ `continent_code` | string | Continent code |
| ↳ `social_profiles` | object | Social profiles of the contact | | ↳ `social_profiles` | object | Social profiles of the contact |
| ↳ `type` | string | Social network type \(e.g., twitter, facebook\) | | ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails |
| ↳ `name` | string | Social network name |
| ↳ `url` | string | Profile URL |
| ↳ `username` | string | Username on the social network |
| ↳ `id` | string | User ID on the social network |
### `intercom_update_contact` ### `intercom_update_contact`
@@ -354,7 +323,7 @@ Create or update a company in Intercom
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `company` | object | Created or updated company object | | `company` | object | Created or updated company object |
| ↳ `id` | string | Unique identifier for the company | | ↳ `id` | string | Unique identifier for the company |
| ↳ `type` | string | Object type \(company\) | | ↳ `type` | string | Segment list type |
| ↳ `app_id` | string | Intercom app ID | | ↳ `app_id` | string | Intercom app ID |
| ↳ `company_id` | string | Your unique identifier for the company | | ↳ `company_id` | string | Your unique identifier for the company |
| ↳ `name` | string | Name of the company | | ↳ `name` | string | Name of the company |
@@ -369,11 +338,7 @@ Create or update a company in Intercom
| ↳ `updated_at` | number | Unix timestamp when company was last updated | | ↳ `updated_at` | number | Unix timestamp when company was last updated |
| ↳ `remote_created_at` | number | Unix timestamp when company was created by you | | ↳ `remote_created_at` | number | Unix timestamp when company was created by you |
| ↳ `custom_attributes` | object | Custom attributes set on the company | | ↳ `custom_attributes` | object | Custom attributes set on the company |
| ↳ `tags` | object | Tags associated with the company |
| ↳ `type` | string | Tag list type |
| ↳ `tags` | array | Array of tag objects | | ↳ `tags` | array | Array of tag objects |
| ↳ `segments` | object | Segments the company belongs to |
| ↳ `type` | string | Segment list type |
| ↳ `segments` | array | Array of segment objects | | ↳ `segments` | array | Array of segment objects |
| `companyId` | string | ID of the created/updated company | | `companyId` | string | ID of the created/updated company |

View File

@@ -43,7 +43,7 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The URL to read and convert to markdown \(e.g., "https://example.com/page"\) | | `url` | string | Yes | The URL to read and convert to markdown |
| `useReaderLMv2` | boolean | No | Whether to use ReaderLM-v2 for better quality \(3x token cost\) | | `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 | | `gatherLinks` | boolean | No | Whether to gather all links at the end |
| `jsonResponse` | boolean | No | Whether to return response in JSON format | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `q` | string | Yes | Search query string \(e.g., "machine learning tutorials"\) | | `q` | string | Yes | Search query string |
| `apiKey` | string | Yes | Your Jina AI API key | | `apiKey` | string | Yes | Your Jina AI API key |
| `num` | number | No | Maximum number of results per page \(default: 5\) | | `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"\) | | `site` | string | No | Restrict results to specific domain\(s\). Can be comma-separated for multiple sites \(e.g., "jina.ai,github.com"\) |
@@ -91,11 +91,5 @@ Search the web and return top 5 results with LLM-friendly content. Each result i
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `results` | array | Array of search results, each containing title, description, url, and LLM-friendly content | | `results` | array | Array of search results, each containing title, description, url, and LLM-friendly content |
| ↳ `title` | string | Page title |
| ↳ `description` | string | Page description or meta description |
| ↳ `url` | string | Page URL |
| ↳ `content` | string | LLM-friendly extracted content |
| ↳ `usage` | object | Token usage information |
| ↳ `tokens` | number | Number of tokens consumed by this request |

View File

@@ -43,7 +43,7 @@ Retrieve detailed information about a specific Jira issue
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when retrieving a single issue. | | `projectId` | string | No | Jira project ID \(optional; not required to retrieve a single issue\). |
| `issueKey` | string | Yes | Jira issue key to retrieve \(e.g., PROJ-123\) | | `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. | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when updating a single issue. | | `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 \(e.g., PROJ-123\) | | `issueKey` | string | Yes | Jira issue key to update |
| `summary` | string | No | New summary for the issue | | `summary` | string | No | New summary for the issue |
| `description` | string | No | New description for the issue | | `description` | string | No | New description for the issue |
| `status` | string | No | New status for the issue | | `status` | string | No | New status for the issue |
@@ -94,7 +94,7 @@ Write a Jira issue
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) | | `projectId` | string | Yes | Project ID for the issue |
| `summary` | string | Yes | Summary for the issue | | `summary` | string | Yes | Summary for the issue |
| `description` | string | No | Description 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"\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `projectId` | string | Yes | Jira project key \(e.g., PROJ\) | | `projectId` | string | Yes | Jira project ID |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. | | `cloudId` | string | No | Jira cloud ID |
#### Output #### Output

View File

@@ -46,8 +46,8 @@ Get all service desks from Jira Service Management
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to get request types for |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to create the request in |
| `requestTypeId` | string | Yes | Request Type ID \(e.g., "10", "15"\) | | `requestTypeId` | string | Yes | Request Type ID for the new request |
| `summary` | string | Yes | Summary/title for the service request | | `summary` | string | Yes | Summary/title for the service request |
| `description` | string | No | Description 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 | | `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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | No | Filter by service desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | No | Filter by service desk ID |
| `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, ORGANIZATION, ALL_REQUESTS | | `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, ORGANIZATION, ALL_REQUESTS |
| `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL | | `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL |
| `searchTerm` | string | No | Search term to filter requests \(e.g., "password reset", "laptop"\) | | `searchTerm` | string | No | Search term to filter requests |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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 | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
| `body` | string | Yes | Comment body text | | `body` | string | Yes | Comment body text |
| `isPublic` | boolean | Yes | Whether the comment is public \(visible to customer\) or internal \(true/false\) | | `isPublic` | boolean | Yes | Whether the comment is public \(visible to customer\) or internal |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
| `isPublic` | boolean | No | Filter to only public comments \(true/false\) | | `isPublic` | boolean | No | Filter to only public comments |
| `internal` | boolean | No | Filter to only internal comments \(true/false\) | | `internal` | boolean | No | Filter to only internal comments |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to get customers for |
| `query` | string | No | Search query to filter customers \(e.g., "john", "acme"\) | | `query` | string | No | Search query to filter customers |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to add customers to |
| `emails` | string | Yes | Comma-separated email addresses to add as customers | | `emails` | string | Yes | Comma-separated email addresses to add as customers |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to get organizations for |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to add the organization to |
| `organizationId` | string | Yes | Organization ID to add to the service desk | | `organizationId` | string | Yes | Organization ID to add to the service desk |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) | | `serviceDeskId` | string | Yes | Service Desk ID to get queues for |
| `includeCount` | boolean | No | Include issue count for each queue \(true/false\) | | `includeCount` | boolean | No | Include issue count for each queue |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### 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\) | | `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `cloudId` | string | No | Jira Cloud ID for the instance | | `cloudId` | string | No | Jira Cloud ID for the instance |
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) | | `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) | | `start` | number | No | Start index for pagination \(default: 0\) |
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) | | `limit` | number | No | Maximum results to return \(default: 50\) |
#### Output #### Output

View File

@@ -42,44 +42,17 @@ Retrieve a list of prediction markets from Kalshi with all filtering options (V2
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `status` | string | No | Filter by market status: "unopened", "open", "closed", or "settled" | | `status` | string | No | Filter by status \(unopened, open, closed, settled\) |
| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) | | `seriesTicker` | string | No | Filter by series ticker |
| `eventTicker` | string | No | Filter by event ticker \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) | | `eventTicker` | string | No | Filter by event ticker |
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | | `limit` | string | No | Number of results \(1-1000, default: 100\) |
| `cursor` | string | No | Pagination cursor from previous response for fetching next page | | `cursor` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `markets` | array | Array of market objects with all API fields | | `markets` | array | Array of market objects with all API fields |
| ↳ `ticker` | string | Unique market ticker identifier |
| ↳ `event_ticker` | string | Parent event ticker |
| ↳ `market_type` | string | Market type \(binary, etc.\) |
| ↳ `title` | string | Market title/question |
| ↳ `subtitle` | string | Market subtitle |
| ↳ `yes_sub_title` | string | Yes outcome subtitle |
| ↳ `no_sub_title` | string | No outcome subtitle |
| ↳ `open_time` | string | Market open time \(ISO 8601\) |
| ↳ `close_time` | string | Market close time \(ISO 8601\) |
| ↳ `expiration_time` | string | Contract expiration time |
| ↳ `status` | string | Market status \(open, closed, settled, etc.\) |
| ↳ `yes_bid` | number | Current best yes bid price in cents |
| ↳ `yes_ask` | number | Current best yes ask price in cents |
| ↳ `no_bid` | number | Current best no bid price in cents |
| ↳ `no_ask` | number | Current best no ask price in cents |
| ↳ `last_price` | number | Last trade price in cents |
| ↳ `previous_yes_bid` | number | Previous yes bid |
| ↳ `previous_yes_ask` | number | Previous yes ask |
| ↳ `previous_price` | number | Previous last price |
| ↳ `volume` | number | Total volume \(contracts traded\) |
| ↳ `volume_24h` | number | 24-hour trading volume |
| ↳ `liquidity` | number | Market liquidity measure |
| ↳ `open_interest` | number | Open interest \(outstanding contracts\) |
| ↳ `result` | string | Settlement result \(yes, no, null\) |
| ↳ `cap_strike` | number | Cap strike for ranged markets |
| ↳ `floor_strike` | number | Floor strike for ranged markets |
| ↳ `category` | string | Market category |
| `cursor` | string | Pagination cursor for fetching more results | | `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_market` ### `kalshi_get_market`
@@ -90,7 +63,7 @@ Retrieve details of a specific prediction market by ticker (V2 - full API respon
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | | `ticker` | string | Yes | The market ticker \(e.g., "KXBTC-24DEC31"\) |
#### Output #### Output
@@ -157,30 +130,18 @@ Retrieve a list of events from Kalshi with optional filtering (V2 - exact API re
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `status` | string | No | Filter by event status: "open", "closed", or "settled" | | `status` | string | No | Filter by status \(open, closed, settled\) |
| `seriesTicker` | string | No | Filter by series ticker \(e.g., "KXBTC", "INX", "FED-RATE"\) | | `seriesTicker` | string | No | Filter by series ticker |
| `withNestedMarkets` | string | No | Include nested markets in response: "true" or "false" | | `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
| `limit` | string | No | Number of results to return \(1-200, default: 200\) | | `limit` | string | No | Number of results \(1-200, default: 200\) |
| `cursor` | string | No | Pagination cursor from previous response for fetching next page | | `cursor` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `events` | array | Array of event objects | | `events` | array | Array of event objects |
| ↳ `event_ticker` | string | Unique event ticker identifier |
| ↳ `series_ticker` | string | Parent series ticker |
| ↳ `title` | string | Event title |
| ↳ `sub_title` | string | Event subtitle |
| ↳ `mutually_exclusive` | boolean | Whether markets are mutually exclusive |
| ↳ `category` | string | Event category |
| ↳ `strike_date` | string | Strike/settlement date |
| ↳ `status` | string | Event status |
| `milestones` | array | Array of milestone objects \(if requested\) | | `milestones` | array | Array of milestone objects \(if requested\) |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `milestone_type` | string | Milestone type |
| ↳ `milestone_date` | string | Milestone date |
| ↳ `milestone_title` | string | Milestone title |
| `cursor` | string | Pagination cursor for fetching more results | | `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_event` ### `kalshi_get_event`
@@ -191,7 +152,7 @@ Retrieve details of a specific event by ticker (V2 - exact API response)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `eventTicker` | string | Yes | Event ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03"\) | | `eventTicker` | string | Yes | The event ticker |
| `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) | | `withNestedMarkets` | string | No | Include nested markets in response \(true/false\) |
#### Output #### Output
@@ -241,32 +202,18 @@ Retrieve your open positions from Kalshi (V2 - exact API response)
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyId` | string | Yes | Your Kalshi API Key ID | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) | | `ticker` | string | No | Filter by market ticker |
| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) | | `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
| `settlementStatus` | string | No | Filter by settlement status: "all", "unsettled", or "settled" \(default: "unsettled"\) | | `settlementStatus` | string | No | Filter by settlement status \(all, unsettled, settled\). Default: unsettled |
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | | `limit` | string | No | Number of results \(1-1000, default: 100\) |
| `cursor` | string | No | Pagination cursor from previous response for fetching next page | | `cursor` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `market_positions` | array | Array of market position objects | | `market_positions` | array | Array of market position objects |
| ↳ `ticker` | string | Market ticker |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `event_title` | string | Event title |
| ↳ `market_title` | string | Market title |
| ↳ `position` | number | Net position \(positive=yes, negative=no\) |
| ↳ `market_exposure` | number | Maximum potential loss in cents |
| ↳ `realized_pnl` | number | Realized profit/loss in cents |
| ↳ `total_traded` | number | Total contracts traded |
| ↳ `resting_orders_count` | number | Number of resting orders |
| ↳ `fees_paid` | number | Total fees paid in cents |
| `event_positions` | array | Array of event position objects | | `event_positions` | array | Array of event position objects |
| ↳ `event_ticker` | string | Event ticker |
| ↳ `event_exposure` | number | Event-level exposure in cents |
| ↳ `realized_pnl` | number | Realized P&L in cents |
| ↳ `total_cost` | number | Total cost basis in cents |
| `cursor` | string | Pagination cursor for fetching more results | | `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_orders` ### `kalshi_get_orders`
@@ -279,35 +226,17 @@ Retrieve your orders from Kalshi with optional filtering (V2 with full API respo
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyId` | string | Yes | Your Kalshi API Key ID | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) | | `ticker` | string | No | Filter by market ticker |
| `eventTicker` | string | No | Filter by event ticker, max 10 comma-separated \(e.g., "KXBTC-24DEC31,INX-25JAN03"\) | | `eventTicker` | string | No | Filter by event ticker \(max 10 comma-separated\) |
| `status` | string | No | Filter by order status: "resting", "canceled", or "executed" | | `status` | string | No | Filter by status \(resting, canceled, executed\) |
| `limit` | string | No | Number of results to return \(1-200, default: 100\) | | `limit` | string | No | Number of results \(1-200, default: 100\) |
| `cursor` | string | No | Pagination cursor from previous response for fetching next page | | `cursor` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `orders` | array | Array of order objects with full API response fields | | `orders` | array | Array of order objects with full API response fields |
| ↳ `order_id` | string | Unique order identifier |
| ↳ `user_id` | string | User ID |
| ↳ `client_order_id` | string | Client-provided order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Order side \(yes/no\) |
| ↳ `action` | string | Order action \(buy/sell\) |
| ↳ `type` | string | Order type \(limit/market\) |
| ↳ `status` | string | Order status \(resting, canceled, executed\) |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `fill_count` | number | Number of contracts filled |
| ↳ `remaining_count` | number | Remaining contracts to fill |
| ↳ `initial_count` | number | Initial order size |
| ↳ `taker_fees` | number | Taker fees paid in cents |
| ↳ `maker_fees` | number | Maker fees paid in cents |
| ↳ `created_time` | string | Order creation time \(ISO 8601\) |
| ↳ `expiration_time` | string | Order expiration time |
| ↳ `last_update_time` | string | Last order update time |
| `cursor` | string | Pagination cursor for fetching more results | | `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_order` ### `kalshi_get_order`
@@ -320,7 +249,7 @@ Retrieve details of a specific order by ID from Kalshi (V2 with full API respons
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyId` | string | Yes | Your Kalshi API Key ID | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `orderId` | string | Yes | Order ID to retrieve \(e.g., "abc123-def456-ghi789"\) | | `orderId` | string | Yes | The order ID to retrieve |
#### Output #### Output
@@ -369,7 +298,7 @@ Retrieve the orderbook (yes and no bids) for a specific market (V2 - includes de
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | | `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
#### Output #### Output
@@ -392,20 +321,14 @@ Retrieve recent trades with additional filtering options (V2 - includes trade_id
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | | `limit` | string | No | Number of results \(1-1000, default: 100\) |
| `cursor` | string | No | Pagination cursor from previous response for fetching next page | | `cursor` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `trades` | array | Array of trade objects with trade_id and count_fp | | `trades` | array | Array of trade objects with trade_id and count_fp |
| ↳ `ticker` | string | Market ticker |
| ↳ `yes_price` | number | Trade price for yes in cents |
| ↳ `no_price` | number | Trade price for no in cents |
| ↳ `count` | number | Number of contracts traded |
| ↳ `taker_side` | string | Taker side \(yes/no\) |
| ↳ `created_time` | string | Trade time \(ISO 8601\) |
| `cursor` | string | Pagination cursor for fetching more results | | `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_candlesticks` ### `kalshi_get_candlesticks`
@@ -416,11 +339,11 @@ Retrieve OHLC candlestick data for a specific market (V2 - full API response)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) | | `seriesTicker` | string | Yes | Series ticker |
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | | `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
| `startTs` | number | Yes | Start timestamp in Unix seconds \(e.g., 1704067200\) | | `startTs` | number | Yes | Start timestamp \(Unix seconds\) |
| `endTs` | number | Yes | End timestamp in Unix seconds \(e.g., 1704153600\) | | `endTs` | number | Yes | End timestamp \(Unix seconds\) |
| `periodInterval` | number | Yes | Period interval: 1 \(1 minute\), 60 \(1 hour\), or 1440 \(1 day\) | | `periodInterval` | number | Yes | Period interval: 1 \(1min\), 60 \(1hour\), or 1440 \(1day\) |
#### Output #### Output
@@ -439,28 +362,18 @@ Retrieve your portfolio
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyId` | string | Yes | Your Kalshi API Key ID | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `ticker` | string | No | Filter by market ticker \(e.g., "KXBTC-24DEC31"\) | | `ticker` | string | No | Filter by market ticker |
| `orderId` | string | No | Filter by order ID \(e.g., "abc123-def456-ghi789"\) | | `orderId` | string | No | Filter by order ID |
| `minTs` | number | No | Minimum timestamp in Unix milliseconds \(e.g., 1704067200000\) | | `minTs` | number | No | Minimum timestamp \(Unix milliseconds\) |
| `maxTs` | number | No | Maximum timestamp in Unix milliseconds \(e.g., 1704153600000\) | | `maxTs` | number | No | Maximum timestamp \(Unix milliseconds\) |
| `limit` | string | No | Number of results to return \(1-1000, default: 100\) | | `limit` | string | No | Number of results \(1-1000, default: 100\) |
| `cursor` | string | No | Pagination cursor from previous response for fetching next page | | `cursor` | string | No | Pagination cursor for next page |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `fills` | array | Array of fill/trade objects with all API fields | | `fills` | array | Array of fill/trade objects with all API fields |
| ↳ `trade_id` | string | Unique trade identifier |
| ↳ `order_id` | string | Associated order ID |
| ↳ `ticker` | string | Market ticker |
| ↳ `side` | string | Trade side \(yes/no\) |
| ↳ `action` | string | Trade action \(buy/sell\) |
| ↳ `count` | number | Number of contracts |
| ↳ `yes_price` | number | Yes price in cents |
| ↳ `no_price` | number | No price in cents |
| ↳ `is_taker` | boolean | Whether this was a taker trade |
| ↳ `created_time` | string | Trade execution time \(ISO 8601\) |
| `cursor` | string | Pagination cursor for fetching more results | | `cursor` | string | Pagination cursor for fetching more results |
### `kalshi_get_series_by_ticker` ### `kalshi_get_series_by_ticker`
@@ -471,7 +384,7 @@ Retrieve details of a specific market series by ticker (V2 - exact API response)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `seriesTicker` | string | Yes | Series ticker identifier \(e.g., "KXBTC", "INX", "FED-RATE"\) | | `seriesTicker` | string | Yes | Series ticker |
#### Output #### Output
@@ -520,11 +433,11 @@ Create a new order on a Kalshi prediction market (V2 with full API response)
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyId` | string | Yes | Your Kalshi API Key ID | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | | `ticker` | string | Yes | Market ticker \(e.g., KXBTC-24DEC31\) |
| `side` | string | Yes | Side of the order: "yes" or "no" | | `side` | string | Yes | Side of the order: 'yes' or 'no' |
| `action` | string | Yes | Action type: "buy" or "sell" | | `action` | string | Yes | Action type: 'buy' or 'sell' |
| `count` | string | Yes | Number of contracts to trade \(e.g., "10", "100"\) | | `count` | string | Yes | Number of contracts \(minimum 1\) |
| `type` | string | No | Order type: "limit" or "market" \(default: "limit"\) | | `type` | string | No | Order type: 'limit' or 'market' \(default: limit\) |
| `yesPrice` | string | No | Yes price in cents \(1-99\) | | `yesPrice` | string | No | Yes price in cents \(1-99\) |
| `noPrice` | string | No | No 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"\) | | `yesPriceDollars` | string | No | Yes price in dollars \(e.g., "0.56"\) |
@@ -587,7 +500,7 @@ Cancel an existing order on Kalshi (V2 with full API response)
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `keyId` | string | Yes | Your Kalshi API Key ID | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `orderId` | string | Yes | Order ID to cancel \(e.g., "abc123-def456-ghi789"\) | | `orderId` | string | Yes | The order ID to cancel |
#### Output #### Output
@@ -640,13 +553,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 | | `keyId` | string | Yes | Your Kalshi API Key ID |
| `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) | | `privateKey` | string | Yes | Your RSA Private Key \(PEM format\) |
| `orderId` | string | Yes | Order ID to amend \(e.g., "abc123-def456-ghi789"\) | | `orderId` | string | Yes | The order ID to amend |
| `ticker` | string | Yes | Market ticker identifier \(e.g., "KXBTC-24DEC31", "INX-25JAN03-T4485.99"\) | | `ticker` | string | Yes | Market ticker |
| `side` | string | Yes | Side of the order: "yes" or "no" | | `side` | string | Yes | Side of the order: 'yes' or 'no' |
| `action` | string | Yes | Action type: "buy" or "sell" | | `action` | string | Yes | Action type: 'buy' or 'sell' |
| `clientOrderId` | string | Yes | Original client-specified order ID | | `clientOrderId` | string | Yes | The original client-specified order ID |
| `updatedClientOrderId` | string | Yes | New client-specified order ID after amendment | | `updatedClientOrderId` | string | Yes | The new client-specified order ID after amendment |
| `count` | string | No | Updated quantity for the order \(e.g., "10", "100"\) | | `count` | string | No | Updated quantity for the order |
| `yesPrice` | string | No | Updated yes price in cents \(1-99\) | | `yesPrice` | string | No | Updated yes price in cents \(1-99\) |
| `noPrice` | string | No | Updated no 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"\) | | `yesPriceDollars` | string | No | Updated yes price in dollars \(e.g., "0.56"\) |

View File

@@ -46,11 +46,11 @@ Retrieves campaign activities and steps performed, including email opens, clicks
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Lemlist API key | | `apiKey` | string | Yes | Lemlist API key |
| `type` | string | No | Filter by activity type \(e.g., emailOpened, emailClicked, emailReplied, paused\) | | `type` | string | No | Filter by activity type \(e.g., emailOpened, emailClicked, emailReplied, paused\) |
| `campaignId` | string | No | Filter by campaign ID \(e.g., "cam_abc123def456"\) | | `campaignId` | string | No | Filter by campaign ID |
| `leadId` | string | No | Filter by lead ID \(e.g., "lea_abc123def456"\) | | `leadId` | string | No | Filter by lead ID |
| `isFirst` | boolean | No | Filter for first activity only | | `isFirst` | boolean | No | Filter for first activity only |
| `limit` | number | No | Number of results per request \(e.g., 50\). Max 100, default 100 | | `limit` | number | No | Number of results per request \(max 100, default 100\) |
| `offset` | number | No | Number of records to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of records to skip for pagination |
#### Output #### Output
@@ -75,7 +75,7 @@ Retrieves lead information by email address or lead ID.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Lemlist API key | | `apiKey` | string | Yes | Lemlist API key |
| `leadIdentifier` | string | Yes | Lead email address \(e.g., "john@example.com"\) or lead ID \(e.g., "lea_abc123def456"\) | | `leadIdentifier` | string | Yes | Lead email address or lead ID |
#### Output #### Output
@@ -102,11 +102,11 @@ Sends an email to a contact through the Lemlist inbox.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Lemlist API key | | `apiKey` | string | Yes | Lemlist API key |
| `sendUserId` | string | Yes | Identifier for the user sending the message \(e.g., "usr_abc123def456"\) | | `sendUserId` | string | Yes | Identifier for the user sending the message |
| `sendUserEmail` | string | Yes | Email address of the sender \(e.g., "sales@company.com"\) | | `sendUserEmail` | string | Yes | Email address of the sender |
| `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender \(e.g., "mbx_abc123def456"\) | | `sendUserMailboxId` | string | Yes | Mailbox identifier for the sender |
| `contactId` | string | Yes | Recipient contact identifier \(e.g., "con_abc123def456"\) | | `contactId` | string | Yes | Recipient contact identifier |
| `leadId` | string | Yes | Associated lead identifier \(e.g., "lea_abc123def456"\) | | `leadId` | string | Yes | Associated lead identifier |
| `subject` | string | Yes | Email subject line | | `subject` | string | Yes | Email subject line |
| `message` | string | Yes | Email message body in HTML format | | `message` | string | Yes | Email message body in HTML format |
| `cc` | json | No | Array of CC email addresses | | `cc` | json | No | Array of CC email addresses |

View File

@@ -42,8 +42,8 @@ Fetch and filter issues from Linear
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | No | Linear team ID \(UUID format\) to filter issues by team | | `teamId` | string | No | Linear team ID to filter by |
| `projectId` | string | No | Linear project ID \(UUID format\) to filter issues by project | | `projectId` | string | No | Linear project ID to filter by |
| `assigneeId` | string | No | User ID to filter by assignee | | `assigneeId` | string | No | User ID to filter by assignee |
| `stateId` | string | No | Workflow state ID to filter by status | | `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\) | | `priority` | number | No | Priority to filter by \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
@@ -59,27 +59,18 @@ Fetch and filter issues from Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `hasNextPage` | boolean | Whether there are more results |
| `endCursor` | string | Cursor for the next page |
| `issues` | array | Array of filtered issues from Linear | | `issues` | array | Array of filtered issues from Linear |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | | ↳ `priority` | number | Issue priority |
| ↳ `estimate` | number | Estimate in points | | ↳ `estimate` | number | Issue estimate |
| ↳ `url` | string | Issue URL | | ↳ `url` | string | Issue URL |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | | ↳ `state` | object | Issue state |
| ↳ `state` | object | Workflow state/status | | ↳ `assignee` | object | Assigned user |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID | | ↳ `teamId` | string | Team ID |
| ↳ `teamName` | string | Team name | | ↳ `teamName` | string | Team name |
| ↳ `projectId` | string | Project ID | | ↳ `projectId` | string | Project ID |
@@ -88,9 +79,8 @@ Fetch and filter issues from Linear
| ↳ `cycleNumber` | number | Cycle number | | ↳ `cycleNumber` | number | Cycle number |
| ↳ `cycleName` | string | Cycle name | | ↳ `cycleName` | string | Cycle name |
| ↳ `labels` | array | Issue labels | | ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID | | `hasNextPage` | boolean | Whether there are more results available |
| ↳ `name` | string | Label name | | `endCursor` | string | Cursor for fetching the next page \(use as |
| ↳ `color` | string | Label color \(hex\) |
### `linear_get_issue` ### `linear_get_issue`
@@ -110,29 +100,14 @@ Get a single issue by ID from Linear with full details
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | | ↳ `priority` | number | Issue priority \(0-4\) |
| ↳ `estimate` | number | Estimate in points | | ↳ `estimate` | number | Issue estimate in points |
| ↳ `url` | string | Issue URL | | ↳ `url` | string | Issue URL |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `state` | object | Issue state/status |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `assignee` | object | Assigned user |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels | | ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `name` | string | Label name | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `color` | string | Label color \(hex\) |
### `linear_create_issue` ### `linear_create_issue`
@@ -142,8 +117,8 @@ Create a new issue in Linear
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | Linear team ID \(UUID format\) where the issue will be created | | `teamId` | string | Yes | Linear team ID |
| `projectId` | string | No | Linear project ID \(UUID format\) to associate with the issue | | `projectId` | string | No | Linear project ID |
| `title` | string | Yes | Issue title | | `title` | string | Yes | Issue title |
| `description` | string | No | Issue description | | `description` | string | No | Issue description |
| `stateId` | string | No | Workflow state ID \(status\) | | `stateId` | string | No | Workflow state ID \(status\) |
@@ -165,29 +140,14 @@ Create a new issue in Linear
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | | ↳ `priority` | number | Issue priority |
| ↳ `estimate` | number | Estimate in points | | ↳ `estimate` | number | Issue estimate |
| ↳ `url` | string | Issue URL | | ↳ `url` | string | Issue URL |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `state` | object | Issue state |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | | ↳ `assignee` | object | Assigned user |
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID | | ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID | | ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) |
| ↳ `cycleId` | string | Cycle ID | | ↳ `cycleId` | string | Cycle ID |
| ↳ `cycleNumber` | number | Cycle number | | ↳ `cycleNumber` | number | Cycle number |
| ↳ `cycleName` | string | Cycle name | | ↳ `cycleName` | string | Cycle name |
@@ -195,6 +155,7 @@ Create a new issue in Linear
| ↳ `parentTitle` | string | Parent issue title | | ↳ `parentTitle` | string | Parent issue title |
| ↳ `projectMilestoneId` | string | Project milestone ID | | ↳ `projectMilestoneId` | string | Project milestone ID |
| ↳ `projectMilestoneName` | string | Project milestone name | | ↳ `projectMilestoneName` | string | Project milestone name |
| ↳ `labels` | array | Issue labels |
### `linear_update_issue` ### `linear_update_issue`
@@ -227,36 +188,19 @@ Update an existing issue in Linear
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | | ↳ `priority` | number | Issue priority |
| ↳ `estimate` | number | Estimate in points | | ↳ `estimate` | number | Issue estimate |
| ↳ `url` | string | Issue URL | | ↳ `state` | object | Issue state |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | | ↳ `assignee` | object | Assigned user |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels | | ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `name` | string | Label name | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `color` | string | Label color \(hex\) | | ↳ `projectId` | string | Project ID |
| ↳ `cycleId` | string | Cycle ID | | ↳ `cycleId` | string | Cycle ID |
| ↳ `cycleNumber` | number | Cycle number | | ↳ `cycleNumber` | number | Cycle number |
| ↳ `cycleName` | string | Cycle name | | ↳ `cycleName` | string | Cycle name |
| ↳ `parentId` | string | Parent issue ID | | ↳ `parentId` | string | Parent issue ID |
| ↳ `parentTitle` | string | Parent issue title | | ↳ `parentTitle` | string | Parent issue title |
| ↳ `projectMilestoneId` | string | Project milestone ID |
| ↳ `projectMilestoneName` | string | Project milestone name |
### `linear_archive_issue` ### `linear_archive_issue`
@@ -325,36 +269,17 @@ Search for issues in Linear using full-text search
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `issues` | array | Array of matching issues | | `issues` | array | Array of matching issues |
| ↳ `id` | string | Issue ID | | ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `description` | string | Issue description | | ↳ `description` | string | Issue description |
| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | | ↳ `priority` | number | Issue priority |
| ↳ `estimate` | number | Estimate in points | | ↳ `state` | object | Issue state |
| ↳ `url` | string | Issue URL | | ↳ `assignee` | object | Assigned user |
| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) |
| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
| ↳ `state` | object | Workflow state/status |
| ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) |
| ↳ `assignee` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teamId` | string | Team ID |
| ↳ `projectId` | string | Project ID |
| ↳ `labels` | array | Issue labels | | ↳ `labels` | array | Issue labels |
| ↳ `id` | string | Label ID | | `pageInfo` | object | Pagination information |
| ↳ `name` | string | Label name | | ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `color` | string | Label color \(hex\) | | ↳ `endCursor` | string | Cursor for next page |
### `linear_add_label_to_issue` ### `linear_add_label_to_issue`
@@ -409,16 +334,10 @@ Add a comment to an issue in Linear
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `comment` | object | The created comment | | `comment` | object | The created comment |
| ↳ `id` | string | Comment ID | | ↳ `id` | string | Comment ID |
| ↳ `body` | string | Comment text \(Markdown\) | | ↳ `body` | string | Comment text |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | | ↳ `user` | object | User who created the comment |
| ↳ `user` | object | User object | | ↳ `issue` | object | Associated issue |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `issue` | object | Issue object |
| ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title |
### `linear_update_comment` ### `linear_update_comment`
@@ -437,16 +356,9 @@ Edit a comment in Linear
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `comment` | object | The updated comment | | `comment` | object | The updated comment |
| ↳ `id` | string | Comment ID | | ↳ `id` | string | Comment ID |
| ↳ `body` | string | Comment text \(Markdown\) | | ↳ `body` | string | Comment text |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | | ↳ `user` | object | User who created the comment |
| ↳ `user` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `issue` | object | Issue object |
| ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title |
### `linear_delete_comment` ### `linear_delete_comment`
@@ -480,21 +392,15 @@ List all comments on an issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `comments` | array | Array of comments on the issue | | `comments` | array | Array of comments on the issue |
| ↳ `id` | string | Comment ID | | ↳ `id` | string | Comment ID |
| ↳ `body` | string | Comment text \(Markdown\) | | ↳ `body` | string | Comment text |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `user` | object | User object | | ↳ `user` | object | User who created the comment |
| ↳ `id` | string | User ID | | `pageInfo` | object | Pagination information |
| ↳ `name` | string | User name | | ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `email` | string | User email | | ↳ `endCursor` | string | Cursor for next page |
| ↳ `issue` | object | Issue object |
| ↳ `id` | string | Issue ID |
| ↳ `title` | string | Issue title |
### `linear_list_projects` ### `linear_list_projects`
@@ -513,25 +419,15 @@ List projects in Linear with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `projects` | array | Array of projects | | `projects` | array | Array of projects |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | | ↳ `state` | string | Project state |
| ↳ `priority` | number | Project priority \(0-4\) | | ↳ `priority` | number | Project priority |
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | | ↳ `lead` | object | Project lead |
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | | ↳ `teams` | array | Teams associated with project |
| ↳ `url` | string | Project URL | | `pageInfo` | object | Pagination information |
| ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_get_project` ### `linear_get_project`
@@ -551,18 +447,12 @@ Get a single project by ID from Linear
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | | ↳ `state` | string | Project state |
| ↳ `priority` | number | Project priority \(0-4\) | | ↳ `priority` | number | Project priority |
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | | ↳ `startDate` | string | Start date |
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | | ↳ `targetDate` | string | Target completion date |
| ↳ `url` | string | Project URL | | ↳ `lead` | object | Project lead |
| ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams | | ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_create_project` ### `linear_create_project`
@@ -588,18 +478,10 @@ Create a new project in Linear
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | | ↳ `state` | string | Project state |
| ↳ `priority` | number | Project priority \(0-4\) | | ↳ `priority` | number | Project priority |
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | | ↳ `lead` | object | Project lead |
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) |
| ↳ `url` | string | Project URL |
| ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams | | ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_update_project` ### `linear_update_project`
@@ -626,18 +508,12 @@ Update an existing project in Linear
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `description` | string | Project description | | ↳ `description` | string | Project description |
| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | | ↳ `state` | string | Project state |
| ↳ `priority` | number | Project priority \(0-4\) | | ↳ `priority` | number | Project priority |
| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | | ↳ `startDate` | string | Project start date |
| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | | ↳ `targetDate` | string | Project target date |
| ↳ `url` | string | Project URL | | ↳ `lead` | object | Project lead |
| ↳ `lead` | object | User object |
| ↳ `id` | string | User ID |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `teams` | array | Associated teams | | ↳ `teams` | array | Associated teams |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_archive_project` ### `linear_archive_project`
@@ -672,9 +548,6 @@ List all users in the Linear workspace
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `users` | array | Array of workspace users | | `users` | array | Array of workspace users |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
@@ -683,6 +556,7 @@ List all users in the Linear workspace
| ↳ `active` | boolean | Whether user is active | | ↳ `active` | boolean | Whether user is active |
| ↳ `admin` | boolean | Whether user is admin | | ↳ `admin` | boolean | Whether user is admin |
| ↳ `avatarUrl` | string | Avatar URL | | ↳ `avatarUrl` | string | Avatar URL |
| `pageInfo` | object | Pagination information |
### `linear_list_teams` ### `linear_list_teams`
@@ -699,14 +573,12 @@ List all teams in the Linear workspace
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `teams` | array | Array of teams | | `teams` | array | Array of teams |
| ↳ `id` | string | Team ID | | ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name | | ↳ `name` | string | Team name |
| ↳ `key` | string | Team key \(used in issue identifiers\) | | ↳ `key` | string | Team key \(used in issue identifiers\) |
| ↳ `description` | string | Team description | | ↳ `description` | string | Team description |
| `pageInfo` | object | Pagination information |
### `linear_get_viewer` ### `linear_get_viewer`
@@ -746,17 +618,13 @@ List all labels in Linear workspace or team
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `labels` | array | Array of labels | | `labels` | array | Array of labels |
| ↳ `id` | string | Label ID | | ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) | | ↳ `color` | string | Label color \(hex\) |
| ↳ `description` | string | Label description | | ↳ `description` | string | Label description |
| ↳ `team` | object | Team object | | ↳ `team` | object | Team this label belongs to |
| ↳ `id` | string | Team ID | | `pageInfo` | object | Pagination information |
| ↳ `name` | string | Team name |
### `linear_create_label` ### `linear_create_label`
@@ -778,11 +646,9 @@ Create a new label in Linear
| `label` | object | The created label | | `label` | object | The created label |
| ↳ `id` | string | Label ID | | ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) | | ↳ `color` | string | Label color |
| ↳ `description` | string | Label description | | ↳ `description` | string | Label description |
| ↳ `team` | object | Team object | | ↳ `team` | object | Team this label belongs to |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_update_label` ### `linear_update_label`
@@ -804,11 +670,8 @@ Update an existing label in Linear
| `label` | object | The updated label | | `label` | object | The updated label |
| ↳ `id` | string | Label ID | | ↳ `id` | string | Label ID |
| ↳ `name` | string | Label name | | ↳ `name` | string | Label name |
| ↳ `color` | string | Label color \(hex\) | | ↳ `color` | string | Label color |
| ↳ `description` | string | Label description | | ↳ `description` | string | Label description |
| ↳ `team` | object | Team object |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_archive_label` ### `linear_archive_label`
@@ -843,18 +706,14 @@ List all workflow states (statuses) in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `states` | array | Array of workflow states | | `states` | array | Array of workflow states |
| ↳ `id` | string | State ID | | ↳ `id` | string | State ID |
| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | | ↳ `name` | string | State name \(e.g., |
| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | | ↳ `type` | string | State type \(e.g., |
| ↳ `color` | string | State color \(hex\) | | ↳ `color` | string | State color |
| ↳ `position` | number | State position in workflow | | ↳ `position` | number | State position in workflow |
| ↳ `team` | object | Team object | | ↳ `team` | object | Team this state belongs to |
| ↳ `id` | string | Team ID | | `pageInfo` | object | Pagination information |
| ↳ `name` | string | Team name |
### `linear_create_workflow_state` ### `linear_create_workflow_state`
@@ -924,20 +783,16 @@ List cycles (sprints/iterations) in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `cycles` | array | Array of cycles | | `cycles` | array | Array of cycles |
| ↳ `id` | string | Cycle ID | | ↳ `id` | string | Cycle ID |
| ↳ `number` | number | Cycle number | | ↳ `number` | number | Cycle number |
| ↳ `name` | string | Cycle name | | ↳ `name` | string | Cycle name |
| ↳ `startsAt` | string | Start date \(ISO 8601\) | | ↳ `startsAt` | string | Start date |
| ↳ `endsAt` | string | End date \(ISO 8601\) | | ↳ `endsAt` | string | End date |
| ↳ `completedAt` | string | Completion date \(ISO 8601\) | | ↳ `completedAt` | string | Completion date |
| ↳ `progress` | number | Progress percentage \(0-1\) | | ↳ `progress` | number | Progress percentage \(0-1\) |
| ↳ `team` | object | Team object | | ↳ `team` | object | Team this cycle belongs to |
| ↳ `id` | string | Team ID | | `pageInfo` | object | Pagination information |
| ↳ `name` | string | Team name |
### `linear_get_cycle` ### `linear_get_cycle`
@@ -957,13 +812,10 @@ Get a single cycle by ID from Linear
| ↳ `id` | string | Cycle ID | | ↳ `id` | string | Cycle ID |
| ↳ `number` | number | Cycle number | | ↳ `number` | number | Cycle number |
| ↳ `name` | string | Cycle name | | ↳ `name` | string | Cycle name |
| ↳ `startsAt` | string | Start date \(ISO 8601\) | | ↳ `startsAt` | string | Start date |
| ↳ `endsAt` | string | End date \(ISO 8601\) | | ↳ `endsAt` | string | End date |
| ↳ `completedAt` | string | Completion date \(ISO 8601\) | | ↳ `progress` | number | Progress percentage |
| ↳ `progress` | number | Progress percentage \(0-1\) | | ↳ `team` | object | Team this cycle belongs to |
| ↳ `team` | object | Team object |
| ↳ `id` | string | Team ID |
| ↳ `name` | string | Team name |
### `linear_create_cycle` ### `linear_create_cycle`
@@ -1035,8 +887,7 @@ Add an attachment to an issue in Linear
| ↳ `title` | string | Attachment title | | ↳ `title` | string | Attachment title |
| ↳ `subtitle` | string | Attachment subtitle | | ↳ `subtitle` | string | Attachment subtitle |
| ↳ `url` | string | Attachment URL | | ↳ `url` | string | Attachment URL |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
### `linear_list_attachments` ### `linear_list_attachments`
@@ -1054,16 +905,13 @@ List all attachments on an issue in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `attachments` | array | Array of attachments | | `attachments` | array | Array of attachments |
| ↳ `id` | string | Attachment ID | | ↳ `id` | string | Attachment ID |
| ↳ `title` | string | Attachment title | | ↳ `title` | string | Attachment title |
| ↳ `subtitle` | string | Attachment subtitle | | ↳ `subtitle` | string | Attachment subtitle |
| ↳ `url` | string | Attachment URL | | ↳ `url` | string | Attachment URL |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | | `pageInfo` | object | Pagination information |
### `linear_update_attachment` ### `linear_update_attachment`
@@ -1086,8 +934,7 @@ Update an attachment metadata in Linear
| ↳ `title` | string | Attachment title | | ↳ `title` | string | Attachment title |
| ↳ `subtitle` | string | Attachment subtitle | | ↳ `subtitle` | string | Attachment subtitle |
| ↳ `url` | string | Attachment URL | | ↳ `url` | string | Attachment URL |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `updatedAt` | string | Last update timestamp |
| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) |
### `linear_delete_attachment` ### `linear_delete_attachment`
@@ -1331,11 +1178,11 @@ Create a new customer in Linear
| ↳ `id` | string | Customer ID | | ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name | | ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains | | ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs from other systems | | ↳ `externalIds` | array | External IDs |
| ↳ `logoUrl` | string | Logo URL | | ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs | | ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | | ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
### `linear_list_customers` ### `linear_list_customers`
@@ -1353,18 +1200,16 @@ List all customers in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results |
| ↳ `endCursor` | string | Cursor for the next page |
| `customers` | array | Array of customers | | `customers` | array | Array of customers |
| ↳ `id` | string | Customer ID | | ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name | | ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains | | ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs from other systems | | ↳ `externalIds` | array | External IDs |
| ↳ `logoUrl` | string | Logo URL | | ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs | | ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | | ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
| `pageInfo` | object | Pagination information |
### `linear_create_customer_request` ### `linear_create_customer_request`
@@ -1477,11 +1322,11 @@ Get a single customer by ID in Linear
| ↳ `id` | string | Customer ID | | ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name | | ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains | | ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs from other systems | | ↳ `externalIds` | array | External IDs |
| ↳ `logoUrl` | string | Logo URL | | ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs | | ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | | ↳ `createdAt` | string | Creation timestamp |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | | ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) |
### `linear_update_customer` ### `linear_update_customer`
@@ -1507,14 +1352,6 @@ Update a customer in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The updated customer | | `customer` | object | The updated customer |
| ↳ `id` | string | Customer ID |
| ↳ `name` | string | Customer name |
| ↳ `domains` | array | Associated domains |
| ↳ `externalIds` | array | External IDs from other systems |
| ↳ `logoUrl` | string | Logo URL |
| ↳ `approximateNeedCount` | number | Number of customer needs |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_delete_customer` ### `linear_delete_customer`
@@ -1568,14 +1405,6 @@ Create a new customer status in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerStatus` | object | The created customer status | | `customerStatus` | object | The created customer status |
| ↳ `id` | string | Customer status ID |
| ↳ `name` | string | Status name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Status description |
| ↳ `color` | string | Status color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_update_customer_status` ### `linear_update_customer_status`
@@ -1628,14 +1457,6 @@ List all customer statuses in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerStatuses` | array | List of customer statuses | | `customerStatuses` | array | List of customer statuses |
| ↳ `id` | string | Customer status ID |
| ↳ `name` | string | Status name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Status description |
| ↳ `color` | string | Status color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_create_customer_tier` ### `linear_create_customer_tier`
@@ -1656,14 +1477,6 @@ Create a new customer tier in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerTier` | object | The created customer tier | | `customerTier` | object | The created customer tier |
| ↳ `id` | string | Customer tier ID |
| ↳ `name` | string | Tier name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Tier description |
| ↳ `color` | string | Tier color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_update_customer_tier` ### `linear_update_customer_tier`
@@ -1716,14 +1529,6 @@ List all customer tiers in Linear
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customerTiers` | array | List of customer tiers | | `customerTiers` | array | List of customer tiers |
| ↳ `id` | string | Customer tier ID |
| ↳ `name` | string | Tier name |
| ↳ `displayName` | string | Display name |
| ↳ `description` | string | Tier description |
| ↳ `color` | string | Tier color \(hex\) |
| ↳ `position` | number | Position in list |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) |
### `linear_delete_project` ### `linear_delete_project`

View File

@@ -40,9 +40,9 @@ Search the web for information using Linkup
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `q` | string | Yes | The search query \(e.g., "latest AI research papers 2024"\) | | `q` | string | Yes | The search query |
| `depth` | string | Yes | Search depth: "standard" for quick results, "deep" for comprehensive search | | `depth` | string | Yes | Search depth \(has to either be "standard" or "deep"\) |
| `outputType` | string | Yes | Output format: "sourcedAnswer" for AI-generated answer with citations, "searchResults" for raw results | | `outputType` | string | Yes | Type of output to return \(has to be "sourcedAnswer" or "searchResults"\) |
| `apiKey` | string | Yes | Enter your Linkup API key | | `apiKey` | string | Yes | Enter your Linkup API key |
| `includeImages` | boolean | No | Whether to include images in search results | | `includeImages` | boolean | No | Whether to include images in search results |
| `fromDate` | string | No | Start date for filtering results \(YYYY-MM-DD format\) | | `fromDate` | string | No | Start date for filtering results \(YYYY-MM-DD format\) |

View File

@@ -63,8 +63,8 @@ Retrieve a list of audiences (lists) from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -85,7 +85,7 @@ Retrieve details of a specific audience (list) from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
#### Output #### Output
@@ -105,11 +105,11 @@ Create a new audience (list) in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `audienceName` | string | Yes | The name of the audience/list \(e.g., "Newsletter Subscribers"\) | | `audienceName` | string | Yes | The name of the list |
| `contact` | string | Yes | JSON object of contact information \(e.g., \{"company": "Acme", "address1": "123 Main St", "city": "NYC", "state": "NY", "zip": "10001", "country": "US"\}\) | | `contact` | string | Yes | JSON object of contact information |
| `permissionReminder` | string | Yes | Permission reminder text shown to subscribers \(e.g., "You signed up for updates on our website"\) | | `permissionReminder` | string | Yes | Permission reminder text |
| `campaignDefaults` | string | Yes | JSON object of default campaign settings \(e.g., \{"from_name": "Acme", "from_email": "news@acme.com", "subject": "", "language": "en"\}\) | | `campaignDefaults` | string | Yes | JSON object of default campaign settings |
| `emailTypeOption` | string | Yes | Support multiple email formats: "true" or "false" | | `emailTypeOption` | string | Yes | Support multiple email formats |
#### Output #### Output
@@ -130,11 +130,11 @@ Update an existing audience (list) in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `audienceName` | string | No | The name of the audience/list \(e.g., "Newsletter Subscribers"\) | | `audienceName` | string | No | The name of the list |
| `permissionReminder` | string | No | Permission reminder text shown to subscribers \(e.g., "You signed up for updates on our website"\) | | `permissionReminder` | string | No | Permission reminder text |
| `campaignDefaults` | string | No | JSON object of default campaign settings \(e.g., \{"from_name": "Acme", "from_email": "news@acme.com"\}\) | | `campaignDefaults` | string | No | JSON object of default campaign settings |
| `emailTypeOption` | string | No | Support multiple email formats: "true" or "false" | | `emailTypeOption` | string | No | Support multiple email formats |
#### Output #### Output
@@ -155,7 +155,7 @@ Delete an audience (list) from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list to delete \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list to delete |
#### Output #### Output
@@ -172,10 +172,10 @@ Retrieve a list of members from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `status` | string | No | Filter by status: "subscribed", "unsubscribed", "cleaned", or "pending" | | `status` | string | No | Filter by status \(subscribed, unsubscribed, cleaned, pending\) |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -196,8 +196,8 @@ Retrieve details of a specific member from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
#### Output #### Output
@@ -217,11 +217,11 @@ Add a new member to a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | | `emailAddress` | string | Yes | Member email address |
| `status` | string | Yes | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | | `status` | string | Yes | Subscriber status |
| `mergeFields` | string | No | JSON object of merge fields \(e.g., \{"FNAME": "John", "LNAME": "Doe"\}\) | | `mergeFields` | string | No | JSON object of merge fields |
| `interests` | string | No | JSON object of interest IDs and their boolean values \(e.g., \{"abc123": true\}\) | | `interests` | string | No | JSON object of interests |
#### Output #### Output
@@ -242,12 +242,12 @@ Add a new member or update an existing member in a Mailchimp audience (upsert)
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
| `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | | `emailAddress` | string | Yes | Member email address |
| `statusIfNew` | string | Yes | Subscriber status if new: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | | `statusIfNew` | string | Yes | Subscriber status if new member |
| `mergeFields` | string | No | JSON object of merge fields \(e.g., \{"FNAME": "John", "LNAME": "Doe"\}\) | | `mergeFields` | string | No | JSON object of merge fields |
| `interests` | string | No | JSON object of interest IDs and their boolean values \(e.g., \{"abc123": true\}\) | | `interests` | string | No | JSON object of interests |
#### Output #### Output
@@ -268,12 +268,12 @@ Update an existing member in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
| `emailAddress` | string | No | New member email address \(e.g., "user@example.com"\) | | `emailAddress` | string | No | Member email address |
| `status` | string | No | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | | `status` | string | No | Subscriber status |
| `mergeFields` | string | No | JSON object of merge fields \(e.g., \{"FNAME": "John", "LNAME": "Doe"\}\) | | `mergeFields` | string | No | JSON object of merge fields |
| `interests` | string | No | JSON object of interest IDs and their boolean values \(e.g., \{"abc123": true\}\) | | `interests` | string | No | JSON object of interests |
#### Output #### Output
@@ -294,8 +294,8 @@ Delete a member from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
#### Output #### Output
@@ -312,8 +312,8 @@ Permanently archive (delete) a member from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
#### Output #### Output
@@ -332,10 +332,10 @@ Restore an archived member to a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
| `emailAddress` | string | Yes | Member email address \(e.g., "user@example.com"\) | | `emailAddress` | string | Yes | Member email address |
| `status` | string | Yes | Subscriber status: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional" | | `status` | string | Yes | Subscriber status |
#### Output #### Output
@@ -356,10 +356,10 @@ Retrieve a list of campaigns from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignType` | string | No | Filter by campaign type: "regular", "plaintext", "absplit", "rss", or "variate" | | `campaignType` | string | No | Filter by campaign type \(regular, plaintext, absplit, rss, variate\) |
| `status` | string | No | Filter by status: "save", "paused", "schedule", "sending", or "sent" | | `status` | string | No | Filter by status \(save, paused, schedule, sending, sent\) |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -380,7 +380,7 @@ Retrieve details of a specific campaign from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign |
#### Output #### Output
@@ -400,9 +400,9 @@ Create a new campaign in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignType` | string | Yes | Campaign type: "regular", "plaintext", "absplit", "rss", or "variate" | | `campaignType` | string | Yes | Campaign type |
| `campaignSettings` | string | Yes | JSON object of campaign settings \(e.g., \{"subject_line": "Newsletter", "from_name": "Acme", "reply_to": "news@acme.com"\}\) | | `campaignSettings` | string | Yes | JSON object of campaign settings |
| `recipients` | string | No | JSON object of recipients \(e.g., \{"list_id": "abc123"\}\) | | `recipients` | string | No | JSON object of recipients |
#### Output #### Output
@@ -423,9 +423,9 @@ Update an existing campaign in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign |
| `campaignSettings` | string | No | JSON object of campaign settings \(e.g., \{"subject_line": "Newsletter", "from_name": "Acme"\}\) | | `campaignSettings` | string | No | JSON object of campaign settings |
| `recipients` | string | No | JSON object of recipients \(e.g., \{"list_id": "abc123"\}\) | | `recipients` | string | No | JSON object of recipients |
#### Output #### Output
@@ -446,7 +446,7 @@ Delete a campaign from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign to delete \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign to delete |
#### Output #### Output
@@ -463,7 +463,7 @@ Send a Mailchimp campaign
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign to send \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign to send |
#### Output #### Output
@@ -482,8 +482,8 @@ Schedule a Mailchimp campaign to be sent at a specific time
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign to schedule \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign to schedule |
| `scheduleTime` | string | Yes | Schedule time in ISO 8601 format \(e.g., "2024-12-25T10:00:00Z"\) | | `scheduleTime` | string | Yes | ISO 8601 format date and time |
#### Output #### Output
@@ -500,7 +500,7 @@ Unschedule a previously scheduled Mailchimp campaign
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign to unschedule \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign to unschedule |
#### Output #### Output
@@ -519,7 +519,7 @@ Create a copy of an existing Mailchimp campaign
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign to replicate \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign to replicate |
#### Output #### Output
@@ -540,7 +540,7 @@ Retrieve the HTML and plain-text content for a Mailchimp campaign
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign |
#### Output #### Output
@@ -559,10 +559,10 @@ Set the content for a Mailchimp campaign
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign |
| `html` | string | No | The HTML content for the campaign | | `html` | string | No | The HTML content for the campaign |
| `plainText` | string | No | The plain-text content for the campaign | | `plainText` | string | No | The plain-text content for the campaign |
| `templateId` | string | No | The unique ID of the template to use \(e.g., "12345"\) | | `templateId` | string | No | The ID of the template to use |
#### Output #### Output
@@ -582,8 +582,8 @@ Retrieve a list of automations from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -604,7 +604,7 @@ Retrieve details of a specific automation from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | | `workflowId` | string | Yes | The unique ID for the automation workflow |
#### Output #### Output
@@ -624,7 +624,7 @@ Start all emails in a Mailchimp automation workflow
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | | `workflowId` | string | Yes | The unique ID for the automation workflow |
#### Output #### Output
@@ -643,7 +643,7 @@ Pause all emails in a Mailchimp automation workflow
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | | `workflowId` | string | Yes | The unique ID for the automation workflow |
#### Output #### Output
@@ -662,9 +662,9 @@ Manually add a subscriber to a workflow email queue
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `workflowId` | string | Yes | The unique ID for the automation workflow \(e.g., "abc123def4"\) | | `workflowId` | string | Yes | The unique ID for the automation workflow |
| `workflowEmailId` | string | Yes | The unique ID for the workflow email \(e.g., "xyz789"\) | | `workflowEmailId` | string | Yes | The unique ID for the workflow email |
| `emailAddress` | string | Yes | Email address of the subscriber \(e.g., "user@example.com"\) | | `emailAddress` | string | Yes | Email address of the subscriber |
#### Output #### Output
@@ -684,8 +684,8 @@ Retrieve a list of templates from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -706,7 +706,7 @@ Retrieve details of a specific template from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `templateId` | string | Yes | The unique ID for the template \(e.g., "12345"\) | | `templateId` | string | Yes | The unique ID for the template |
#### Output #### Output
@@ -726,7 +726,7 @@ Create a new template in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `templateName` | string | Yes | The name of the template \(e.g., "Monthly Newsletter"\) | | `templateName` | string | Yes | The name of the template |
| `templateHtml` | string | Yes | The HTML content for the template | | `templateHtml` | string | Yes | The HTML content for the template |
#### Output #### Output
@@ -748,8 +748,8 @@ Update an existing template in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `templateId` | string | Yes | The unique ID for the template \(e.g., "12345"\) | | `templateId` | string | Yes | The unique ID for the template |
| `templateName` | string | No | The name of the template \(e.g., "Monthly Newsletter"\) | | `templateName` | string | No | The name of the template |
| `templateHtml` | string | No | The HTML content for the template | | `templateHtml` | string | No | The HTML content for the template |
#### Output #### Output
@@ -771,7 +771,7 @@ Delete a template from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `templateId` | string | Yes | The unique ID for the template to delete \(e.g., "12345"\) | | `templateId` | string | Yes | The unique ID for the template to delete |
#### Output #### Output
@@ -788,8 +788,8 @@ Retrieve a list of campaign reports from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -810,7 +810,7 @@ Retrieve the report for a specific campaign from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `campaignId` | string | Yes | The unique ID for the campaign \(e.g., "abc123def4"\) | | `campaignId` | string | Yes | The unique ID for the campaign |
#### Output #### Output
@@ -830,9 +830,9 @@ Retrieve a list of segments from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -853,8 +853,8 @@ Retrieve details of a specific segment from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `segmentId` | string | Yes | The unique ID for the segment |
#### Output #### Output
@@ -874,9 +874,9 @@ Create a new segment in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentName` | string | Yes | The name of the segment \(e.g., "VIP Customers"\) | | `segmentName` | string | Yes | The name of the segment |
| `segmentOptions` | string | No | JSON object of segment options for saved segments \(e.g., \{"match": "all", "conditions": \[...\]\}\) | | `segmentOptions` | string | No | JSON object of segment options |
#### Output #### Output
@@ -897,10 +897,10 @@ Update an existing segment in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `segmentId` | string | Yes | The unique ID for the segment |
| `segmentName` | string | No | The name of the segment \(e.g., "VIP Customers"\) | | `segmentName` | string | No | The name of the segment |
| `segmentOptions` | string | No | JSON object of segment options \(e.g., \{"match": "all", "conditions": \[...\]\}\) | | `segmentOptions` | string | No | JSON object of segment options |
#### Output #### Output
@@ -921,8 +921,8 @@ Delete a segment from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentId` | string | Yes | The unique ID for the segment to delete \(e.g., "12345"\) | | `segmentId` | string | Yes | The unique ID for the segment to delete |
#### Output #### Output
@@ -939,10 +939,10 @@ Retrieve members of a specific segment from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `segmentId` | string | Yes | The unique ID for the segment |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -963,9 +963,9 @@ Add a member to a specific segment in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `segmentId` | string | Yes | The unique ID for the segment |
| `emailAddress` | string | Yes | Email address of the member \(e.g., "user@example.com"\) | | `emailAddress` | string | Yes | Email address of the member |
#### Output #### Output
@@ -985,9 +985,9 @@ Remove a member from a specific segment in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `segmentId` | string | Yes | The unique ID for the segment \(e.g., "12345"\) | | `segmentId` | string | Yes | The unique ID for the segment |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
#### Output #### Output
@@ -1006,8 +1006,8 @@ Retrieve tags associated with a member in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
#### Output #### Output
@@ -1028,9 +1028,9 @@ Add tags to a member in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
| `tags` | string | Yes | JSON array of tag objects \(e.g., \[\{"name": "VIP", "status": "active"\}\]\) | | `tags` | string | Yes | JSON array of tags |
#### Output #### Output
@@ -1049,9 +1049,9 @@ Remove tags from a member in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `subscriberEmail` | string | Yes | Member email address or MD5 hash of the lowercase email | | `subscriberEmail` | string | Yes | Member email address or MD5 hash |
| `tags` | string | Yes | JSON array of tag objects with inactive status \(e.g., \[\{"name": "VIP", "status": "inactive"\}\]\) | | `tags` | string | Yes | JSON array of tags with inactive status |
#### Output #### Output
@@ -1070,9 +1070,9 @@ Retrieve a list of merge fields from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -1093,8 +1093,8 @@ Retrieve details of a specific merge field from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `mergeId` | string | Yes | The unique ID for the merge field \(e.g., "1" or "FNAME"\) | | `mergeId` | string | Yes | The unique ID for the merge field |
#### Output #### Output
@@ -1114,9 +1114,9 @@ Create a new merge field in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `mergeName` | string | Yes | The name of the merge field \(e.g., "First Name"\) | | `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", or "zip" | | `mergeType` | string | Yes | The type of the merge field \(text, number, address, phone, date, url, imageurl, radio, dropdown, birthday, zip\) |
#### Output #### Output
@@ -1137,9 +1137,9 @@ Update an existing merge field in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `mergeId` | string | Yes | The unique ID for the merge field \(e.g., "1" or "FNAME"\) | | `mergeId` | string | Yes | The unique ID for the merge field |
| `mergeName` | string | No | The name of the merge field \(e.g., "First Name"\) | | `mergeName` | string | No | The name of the merge field |
#### Output #### Output
@@ -1160,8 +1160,8 @@ Delete a merge field from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `mergeId` | string | Yes | The unique ID for the merge field to delete \(e.g., "1" or "FNAME"\) | | `mergeId` | string | Yes | The unique ID for the merge field to delete |
#### Output #### Output
@@ -1178,9 +1178,9 @@ Retrieve a list of interest categories from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -1201,8 +1201,8 @@ Retrieve details of a specific interest category from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
#### Output #### Output
@@ -1222,9 +1222,9 @@ Create a new interest category in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryTitle` | string | Yes | The title of the interest category \(e.g., "Email Preferences"\) | | `interestCategoryTitle` | string | Yes | The title of the interest category |
| `interestCategoryType` | string | Yes | The type of interest category: "checkboxes", "dropdown", "radio", or "hidden" | | `interestCategoryType` | string | Yes | The type of interest category \(checkboxes, dropdown, radio, hidden\) |
#### Output #### Output
@@ -1245,9 +1245,9 @@ Update an existing interest category in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
| `interestCategoryTitle` | string | No | The title of the interest category \(e.g., "Email Preferences"\) | | `interestCategoryTitle` | string | No | The title of the interest category |
#### Output #### Output
@@ -1268,8 +1268,8 @@ Delete an interest category from a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category to delete \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category to delete |
#### Output #### Output
@@ -1286,10 +1286,10 @@ Retrieve a list of interests from an interest category in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -1310,9 +1310,9 @@ Retrieve details of a specific interest from an interest category in a Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
| `interestId` | string | Yes | The unique ID for the interest \(e.g., "def456"\) | | `interestId` | string | Yes | The unique ID for the interest |
#### Output #### Output
@@ -1332,9 +1332,9 @@ Create a new interest in an interest category in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
| `interestName` | string | Yes | The name of the interest \(e.g., "Weekly Updates"\) | | `interestName` | string | Yes | The name of the interest |
#### Output #### Output
@@ -1355,10 +1355,10 @@ Update an existing interest in an interest category in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
| `interestId` | string | Yes | The unique ID for the interest \(e.g., "def456"\) | | `interestId` | string | Yes | The unique ID for the interest |
| `interestName` | string | No | The name of the interest \(e.g., "Weekly Updates"\) | | `interestName` | string | No | The name of the interest |
#### Output #### Output
@@ -1379,9 +1379,9 @@ Delete an interest from an interest category in a Mailchimp audience
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `listId` | string | Yes | The unique ID for the audience/list \(e.g., "abc123def4"\) | | `listId` | string | Yes | The unique ID for the list |
| `interestCategoryId` | string | Yes | The unique ID for the interest category \(e.g., "xyz789"\) | | `interestCategoryId` | string | Yes | The unique ID for the interest category |
| `interestId` | string | Yes | The unique ID for the interest to delete \(e.g., "def456"\) | | `interestId` | string | Yes | The unique ID for the interest to delete |
#### Output #### Output
@@ -1398,8 +1398,8 @@ Retrieve a list of landing pages from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -1420,7 +1420,7 @@ Retrieve details of a specific landing page from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | | `pageId` | string | Yes | The unique ID for the landing page |
#### Output #### Output
@@ -1440,8 +1440,8 @@ Create a new landing page in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `landingPageType` | string | Yes | The type of landing page: "signup" | | `landingPageType` | string | Yes | The type of landing page \(signup\) |
| `landingPageTitle` | string | No | The title of the landing page \(e.g., "Join Our Newsletter"\) | | `landingPageTitle` | string | No | The title of the landing page |
#### Output #### Output
@@ -1462,8 +1462,8 @@ Update an existing landing page in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | | `pageId` | string | Yes | The unique ID for the landing page |
| `landingPageTitle` | string | No | The title of the landing page \(e.g., "Join Our Newsletter"\) | | `landingPageTitle` | string | No | The title of the landing page |
#### Output #### Output
@@ -1484,7 +1484,7 @@ Delete a landing page from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `pageId` | string | Yes | The unique ID for the landing page to delete \(e.g., "abc123def4"\) | | `pageId` | string | Yes | The unique ID for the landing page to delete |
#### Output #### Output
@@ -1501,7 +1501,7 @@ Publish a landing page in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | | `pageId` | string | Yes | The unique ID for the landing page |
#### Output #### Output
@@ -1520,7 +1520,7 @@ Unpublish a landing page in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `pageId` | string | Yes | The unique ID for the landing page \(e.g., "abc123def4"\) | | `pageId` | string | Yes | The unique ID for the landing page |
#### Output #### Output
@@ -1539,8 +1539,8 @@ Retrieve a list of batch operations from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `count` | string | No | Number of results to return \(default: 10, max: 1000\) | | `count` | string | No | Number of results \(default: 10, max: 1000\) |
| `offset` | string | No | Number of results to skip for pagination | | `offset` | string | No | Number of results to skip |
#### Output #### Output
@@ -1561,7 +1561,7 @@ Retrieve details of a specific batch operation from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `batchId` | string | Yes | The unique ID for the batch operation \(e.g., "abc123def4"\) | | `batchId` | string | Yes | The unique ID for the batch operation |
#### Output #### Output
@@ -1581,7 +1581,7 @@ Create a new batch operation in Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `operations` | string | Yes | JSON array of batch operations \(e.g., \[\{"method": "POST", "path": "/lists/\{list_id\}/members", "body": "..."\}\]\) | | `operations` | string | Yes | JSON array of operations |
#### Output #### Output
@@ -1602,7 +1602,7 @@ Delete a batch operation from Mailchimp
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailchimp API key with server prefix | | `apiKey` | string | Yes | Mailchimp API key with server prefix |
| `batchId` | string | Yes | The unique ID for the batch operation to delete \(e.g., "abc123def4"\) | | `batchId` | string | Yes | The unique ID for the batch operation to delete |
#### Output #### Output

View File

@@ -45,14 +45,14 @@ Send an email using Mailgun API
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `domain` | string | Yes | Mailgun sending domain \(e.g., mg.example.com\) | | `domain` | string | Yes | Mailgun domain \(e.g., mg.example.com\) |
| `from` | string | Yes | Sender email address \(e.g., sender@example.com or "Name &lt;sender@example.com&gt;"\) | | `from` | string | Yes | Sender email address |
| `to` | string | Yes | Recipient email address \(e.g., user@example.com\). Use comma-separated values for multiple recipients | | `to` | string | Yes | Recipient email address \(comma-separated for multiple\) |
| `subject` | string | Yes | Email subject line | | `subject` | string | Yes | Email subject |
| `text` | string | No | Plain text body of the email | | `text` | string | No | Plain text body of the email |
| `html` | string | No | HTML body of the email \(e.g., "&lt;h1&gt;Hello&lt;/h1&gt;&lt;p&gt;Message content&lt;/p&gt;"\) | | `html` | string | No | HTML body of the email |
| `cc` | string | No | CC recipient email address \(e.g., cc@example.com\). Use comma-separated values for multiple recipients | | `cc` | string | No | CC email address \(comma-separated for multiple\) |
| `bcc` | string | No | BCC recipient email address \(e.g., bcc@example.com\). Use comma-separated values for multiple recipients | | `bcc` | string | No | BCC email address \(comma-separated for multiple\) |
| `tags` | string | No | Tags for the email \(comma-separated\) | | `tags` | string | No | Tags for the email \(comma-separated\) |
#### Output #### Output
@@ -72,7 +72,7 @@ Retrieve a stored message by its key
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `domain` | string | Yes | Mailgun domain for retrieving messages \(e.g., mg.example.com\) | | `domain` | string | Yes | Mailgun domain |
| `messageKey` | string | Yes | Message storage key | | `messageKey` | string | Yes | Message storage key |
#### Output #### Output
@@ -102,7 +102,7 @@ List events (logs) for messages sent through Mailgun
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `domain` | string | Yes | Mailgun domain for listing events \(e.g., mg.example.com\) | | `domain` | string | Yes | Mailgun domain |
| `event` | string | No | Filter by event type \(accepted, delivered, failed, opened, clicked, etc.\) | | `event` | string | No | Filter by event type \(accepted, delivered, failed, opened, clicked, etc.\) |
| `limit` | number | No | Maximum number of events to return \(default: 100\) | | `limit` | number | No | Maximum number of events to return \(default: 100\) |
@@ -123,7 +123,7 @@ Create a new mailing list
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `address` | string | Yes | Mailing list address \(e.g., newsletter@mg.example.com\) | | `address` | string | Yes | Mailing list address \(e.g., list@example.com\) |
| `name` | string | No | Mailing list name | | `name` | string | No | Mailing list name |
| `description` | string | No | Mailing list description | | `description` | string | No | Mailing list description |
| `accessLevel` | string | No | Access level: readonly, members, or everyone | | `accessLevel` | string | No | Access level: readonly, members, or everyone |
@@ -145,7 +145,7 @@ Get details of a mailing list
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `address` | string | Yes | Mailing list address to retrieve \(e.g., newsletter@mg.example.com\) | | `address` | string | Yes | Mailing list address |
#### Output #### Output
@@ -163,8 +163,8 @@ Add a member to a mailing list
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `listAddress` | string | Yes | Mailing list address \(e.g., list@mg.example.com\) | | `listAddress` | string | Yes | Mailing list address |
| `address` | string | Yes | Member email address to add \(e.g., user@example.com\) | | `address` | string | Yes | Member email address |
| `name` | string | No | Member name | | `name` | string | No | Member name |
| `vars` | string | No | JSON string of custom variables | | `vars` | string | No | JSON string of custom variables |
| `subscribed` | boolean | No | Whether the member is subscribed | | `subscribed` | boolean | No | Whether the member is subscribed |
@@ -204,7 +204,7 @@ Get details of a specific domain
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Mailgun API key | | `apiKey` | string | Yes | Mailgun API key |
| `domain` | string | Yes | Domain name to retrieve details for \(e.g., mg.example.com\) | | `domain` | string | Yes | Domain name |
#### Output #### Output

View File

@@ -42,8 +42,8 @@ Add memories to Mem0 for persistent storage and retrieval
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `userId` | string | Yes | User ID associated with the memory \(e.g., "user_123", "alice@example.com"\) | | `userId` | string | Yes | User ID associated with the memory |
| `messages` | json | Yes | Array of message objects with role and content \(e.g., \[\{"role": "user", "content": "Hello"\}\]\) | | `messages` | json | Yes | Array of message objects with role and content |
| `apiKey` | string | Yes | Your Mem0 API key | | `apiKey` | string | Yes | Your Mem0 API key |
#### Output #### Output
@@ -52,10 +52,6 @@ Add memories to Mem0 for persistent storage and retrieval
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `ids` | array | Array of memory IDs that were created | | `ids` | array | Array of memory IDs that were created |
| `memories` | array | Array of memory objects that were created | | `memories` | array | Array of memory objects that were created |
| ↳ `id` | string | Unique identifier for the memory |
| ↳ `memory` | string | The content of the memory |
| ↳ `event` | string | Event type indicating operation performed \(ADD, UPDATE, DELETE, NOOP\) |
| ↳ `metadata` | json | Custom metadata associated with the memory |
### `mem0_search_memories` ### `mem0_search_memories`
@@ -65,28 +61,16 @@ Search for memories in Mem0 using semantic search
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `userId` | string | Yes | User ID to search memories for \(e.g., "user_123", "alice@example.com"\) | | `userId` | string | Yes | User ID to search memories for |
| `query` | string | Yes | Search query to find relevant memories \(e.g., "What are my favorite foods?"\) | | `query` | string | Yes | Search query to find relevant memories |
| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Maximum number of results to return |
| `apiKey` | string | Yes | Your Mem0 API key | | `apiKey` | string | Yes | Your Mem0 API key |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `searchResults` | array | Array of search results with memory data and similarity scores | | `searchResults` | array | Array of search results with memory data, each containing id, data, and score |
| ↳ `id` | string | Unique identifier for the memory |
| ↳ `memory` | string | The content of the memory |
| ↳ `user_id` | string | User ID associated with this memory |
| ↳ `agent_id` | string | Agent ID associated with this memory |
| ↳ `app_id` | string | App ID associated with this memory |
| ↳ `run_id` | string | Run/session ID associated with this memory |
| ↳ `hash` | string | Hash of the memory content |
| ↳ `metadata` | json | Custom metadata associated with the memory |
| ↳ `categories` | json | Auto-assigned categories for the memory |
| ↳ `created_at` | string | ISO 8601 timestamp when the memory was created |
| ↳ `updated_at` | string | ISO 8601 timestamp when the memory was last updated |
| ↳ `score` | number | Similarity score from vector search |
| `ids` | array | Array of memory IDs found in the search results | | `ids` | array | Array of memory IDs found in the search results |
### `mem0_get_memories` ### `mem0_get_memories`
@@ -97,11 +81,11 @@ Retrieve memories from Mem0 by ID or filter criteria
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `userId` | string | Yes | User ID to retrieve memories for \(e.g., "user_123", "alice@example.com"\) | | `userId` | string | Yes | User ID to retrieve memories for |
| `memoryId` | string | No | Specific memory ID to retrieve \(e.g., "mem_abc123"\) | | `memoryId` | string | No | Specific memory ID to retrieve |
| `startDate` | string | No | Start date for filtering by created_at \(e.g., "2024-01-15"\) | | `startDate` | string | No | Start date for filtering by created_at \(format: YYYY-MM-DD\) |
| `endDate` | string | No | End date for filtering by created_at \(e.g., "2024-12-31"\) | | `endDate` | string | No | End date for filtering by created_at \(format: YYYY-MM-DD\) |
| `limit` | number | No | Maximum number of results to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Maximum number of results to return |
| `apiKey` | string | Yes | Your Mem0 API key | | `apiKey` | string | Yes | Your Mem0 API key |
#### Output #### Output
@@ -109,21 +93,6 @@ Retrieve memories from Mem0 by ID or filter criteria
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `memories` | array | Array of retrieved memory objects | | `memories` | array | Array of retrieved memory objects |
| ↳ `id` | string | Unique identifier for the memory |
| ↳ `memory` | string | The content of the memory |
| ↳ `user_id` | string | User ID associated with this memory |
| ↳ `agent_id` | string | Agent ID associated with this memory |
| ↳ `app_id` | string | App ID associated with this memory |
| ↳ `run_id` | string | Run/session ID associated with this memory |
| ↳ `hash` | string | Hash of the memory content |
| ↳ `metadata` | json | Custom metadata associated with the memory |
| ↳ `categories` | json | Auto-assigned categories for the memory |
| ↳ `created_at` | string | ISO 8601 timestamp when the memory was created |
| ↳ `updated_at` | string | ISO 8601 timestamp when the memory was last updated |
| ↳ `owner` | string | Owner of the memory |
| ↳ `organization` | string | Organization associated with the memory |
| ↳ `immutable` | boolean | Whether the memory can be modified |
| ↳ `expiration_date` | string | Expiration date after which memory is not retrieved |
| `ids` | array | Array of memory IDs that were retrieved | | `ids` | array | Array of memory IDs that were retrieved |

View File

@@ -9,11 +9,9 @@
"arxiv", "arxiv",
"asana", "asana",
"browser_use", "browser_use",
"calcom",
"calendly", "calendly",
"circleback", "circleback",
"clay", "clay",
"clerk",
"confluence", "confluence",
"cursor", "cursor",
"datadog", "datadog",
@@ -97,7 +95,6 @@
"sftp", "sftp",
"sharepoint", "sharepoint",
"shopify", "shopify",
"similarweb",
"slack", "slack",
"smtp", "smtp",
"sqs", "sqs",

View File

@@ -44,7 +44,7 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | The ID of the spreadsheet/workbook to read from \(e.g., "01ABC123DEF456"\) | | `spreadsheetId` | string | Yes | The ID of the spreadsheet to read from |
| `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. | | `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 #### Output
@@ -66,9 +66,9 @@ Write data to a specific sheet in a Microsoft Excel spreadsheet
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `spreadsheetId` | string | Yes | The ID of the spreadsheet/workbook to write to \(e.g., "01ABC123DEF456"\) | | `spreadsheetId` | string | Yes | The ID of the spreadsheet to write to |
| `range` | string | No | The range of cells to write to \(e.g., "Sheet1!A1:B2"\) | | `range` | string | No | The range of cells to write to |
| `values` | array | Yes | The data to write as a 2D array \(e.g., \[\["Name", "Age"\], \["Alice", 30\]\]\) or array of objects | | `values` | array | Yes | The data to write to the spreadsheet |
| `valueInputOption` | string | No | The format of the data to write | | `valueInputOption` | string | No | The format of the data to write |
| `includeValuesInResponse` | boolean | No | Whether to include the written values in the response | | `includeValuesInResponse` | boolean | No | Whether to include the written values in the response |

View File

@@ -40,8 +40,8 @@ Read tasks from Microsoft Planner - get all user tasks or all tasks from a speci
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `planId` | string | No | The ID of the plan to get tasks from, if not provided gets all user tasks \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | | `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 \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `taskId` | string | No | The ID of the task to get |
#### Output #### Output
@@ -62,12 +62,12 @@ Create a new task in Microsoft Planner
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan where the task will be created \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | | `planId` | string | Yes | The ID of the plan where the task will be created |
| `title` | string | Yes | The title of the task \(e.g., "Review quarterly report"\) | | `title` | string | Yes | The title of the task |
| `description` | string | No | The description of the task | | `description` | string | No | The description of the task |
| `dueDateTime` | string | No | The due date and time for the task in ISO 8601 format \(e.g., "2025-03-15T17:00:00Z"\) | | `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 \(e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f"\) | | `assigneeUserId` | string | No | The user ID to assign the task to |
| `bucketId` | string | No | The bucket ID to place the task in \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `bucketId` | string | No | The bucket ID to place the task in |
#### Output #### Output
@@ -88,15 +88,15 @@ Update a task in Microsoft Planner
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task to update \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `taskId` | string | Yes | The ID of the task to update |
| `etag` | string | Yes | The ETag value from the task to update \(If-Match header\) | | `etag` | string | Yes | The ETag value from the task to update \(If-Match header\) |
| `title` | string | No | The new title of the task \(e.g., "Review quarterly report"\) | | `title` | string | No | The new title of the task |
| `bucketId` | string | No | The bucket ID to move the task to \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `bucketId` | string | No | The bucket ID to move the task to |
| `dueDateTime` | string | No | The due date and time for the task in ISO 8601 format \(e.g., "2025-03-15T17:00:00Z"\) | | `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) |
| `startDateTime` | string | No | The start date and time for the task \(ISO 8601 format\) | | `startDateTime` | string | No | The start date and time for the task \(ISO 8601 format\) |
| `percentComplete` | number | No | The percentage of task completion \(0-100\) | | `percentComplete` | number | No | The percentage of task completion \(0-100\) |
| `priority` | number | No | The priority of the task \(0-10\) | | `priority` | number | No | The priority of the task \(0-10\) |
| `assigneeUserId` | string | No | The user ID to assign the task to \(e.g., "e82f74c3-4d8a-4b5c-9f1e-2a6b8c9d0e3f"\) | | `assigneeUserId` | string | No | The user ID to assign the task to |
#### Output #### Output
@@ -120,7 +120,7 @@ Delete a task from Microsoft Planner
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task to delete \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `taskId` | string | Yes | The ID of the task to delete |
| `etag` | string | Yes | The ETag value from the task to delete \(If-Match header\) | | `etag` | string | Yes | The ETag value from the task to delete \(If-Match header\) |
#### Output #### Output
@@ -158,7 +158,7 @@ Get details of a specific Microsoft Planner plan
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan to retrieve \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | | `planId` | string | Yes | The ID of the plan to retrieve |
#### Output #### Output
@@ -178,7 +178,7 @@ List all buckets in a Microsoft Planner plan
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | | `planId` | string | Yes | The ID of the plan |
#### Output #### Output
@@ -198,7 +198,7 @@ Get details of a specific bucket
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `bucketId` | string | Yes | The ID of the bucket to retrieve \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `bucketId` | string | Yes | The ID of the bucket to retrieve |
#### Output #### Output
@@ -218,7 +218,7 @@ Create a new bucket in a Microsoft Planner plan
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan where the bucket will be created \(e.g., "xqQg5FS2LkCe54tAMV_v2ZgADW2J"\) | | `planId` | string | Yes | The ID of the plan where the bucket will be created |
| `name` | string | Yes | The name of the bucket | | `name` | string | Yes | The name of the bucket |
#### Output #### Output
@@ -239,7 +239,7 @@ Update a bucket in Microsoft Planner
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `bucketId` | string | Yes | The ID of the bucket to update \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `bucketId` | string | Yes | The ID of the bucket to update |
| `name` | string | No | The new name of the bucket | | `name` | string | No | The new name of the bucket |
| `etag` | string | Yes | The ETag value from the bucket to update \(If-Match header\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `bucketId` | string | Yes | The ID of the bucket to delete \(e.g., "hsOf2dhOJkC6Fey9VjDg1JgAC9Rq"\) | | `bucketId` | string | Yes | The ID of the bucket to delete |
| `etag` | string | Yes | The ETag value from the bucket to delete \(If-Match header\) | | `etag` | string | Yes | The ETag value from the bucket to delete \(If-Match header\) |
#### Output #### Output
@@ -280,7 +280,7 @@ Get detailed information about a task including checklist and references
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `taskId` | string | Yes | The ID of the task |
#### Output #### Output
@@ -300,7 +300,7 @@ Update task details including description, checklist items, and references in Mi
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task \(e.g., "pbT5K2OVkkO1M7r5bfsJ6JgAGD5m"\) | | `taskId` | string | Yes | The ID of the task |
| `etag` | string | Yes | The ETag value from the task details to update \(If-Match header\) | | `etag` | string | Yes | The ETag value from the task details to update \(If-Match header\) |
| `description` | string | No | The description of the task | | `description` | string | No | The description of the task |
| `checklist` | object | No | Checklist items as a JSON object | | `checklist` | object | No | Checklist items as a JSON object |

View File

@@ -43,7 +43,7 @@ Read content from a Microsoft Teams chat
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `chatId` | string | Yes | The ID of the chat to read from \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | | `chatId` | string | Yes | The ID of the chat to read from |
| `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage | | `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage |
#### Output #### Output
@@ -67,8 +67,8 @@ Write or update content in a Microsoft Teams chat
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `chatId` | string | Yes | The ID of the chat to write to \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | | `chatId` | string | Yes | The ID of the chat to write to |
| `content` | string | Yes | The content to write to the message \(plain text or HTML formatted, supports @mentions\) | | `content` | string | Yes | The content to write to the message |
| `files` | file[] | No | Files to attach to the message | | `files` | file[] | No | Files to attach to the message |
#### Output #### Output
@@ -90,8 +90,8 @@ Read content from a Microsoft Teams channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team to read from \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | | `teamId` | string | Yes | The ID of the team to read from |
| `channelId` | string | Yes | The ID of the channel to read from \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `channelId` | string | Yes | The ID of the channel to read from |
| `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage | | `includeAttachments` | boolean | No | Download and include message attachments \(hosted contents\) into storage |
#### Output #### Output
@@ -116,9 +116,9 @@ Write or send a message to a Microsoft Teams channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team to write to \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | | `teamId` | string | Yes | The ID of the team to write to |
| `channelId` | string | Yes | The ID of the channel to write to \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `channelId` | string | Yes | The ID of the channel to write to |
| `content` | string | Yes | The content to write to the channel \(plain text or HTML formatted, supports @mentions\) | | `content` | string | Yes | The content to write to the channel |
| `files` | file[] | No | Files to attach to the message | | `files` | file[] | No | Files to attach to the message |
#### Output #### Output
@@ -141,9 +141,9 @@ Update an existing message in a Microsoft Teams chat
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `chatId` | string | Yes | The ID of the chat containing the message \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | | `chatId` | string | Yes | The ID of the chat containing the message |
| `messageId` | string | Yes | The ID of the message to update \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to update |
| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) | | `content` | string | Yes | The new content for the message |
#### Output #### Output
@@ -161,10 +161,10 @@ Update an existing message in a Microsoft Teams channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) | | `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel containing the message \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `channelId` | string | Yes | The ID of the channel containing the message |
| `messageId` | string | Yes | The ID of the message to update \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to update |
| `content` | string | Yes | The new content for the message \(plain text or HTML formatted\) | | `content` | string | Yes | The new content for the message |
#### Output #### Output
@@ -182,8 +182,8 @@ Soft delete a message in a Microsoft Teams chat
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `chatId` | string | Yes | The ID of the chat containing the message \(e.g., "19:abc123def456@thread.v2" - from chat listings\) | | `chatId` | string | Yes | The ID of the chat containing the message |
| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to delete |
#### Output #### Output
@@ -201,9 +201,9 @@ Soft delete a message in a Microsoft Teams channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) | | `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel containing the message \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `channelId` | string | Yes | The ID of the channel containing the message |
| `messageId` | string | Yes | The ID of the message to delete \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to delete |
#### Output #### Output
@@ -221,10 +221,10 @@ Reply to an existing message in a Microsoft Teams channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings or channel info\) | | `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `channelId` | string | Yes | The ID of the channel |
| `messageId` | string | Yes | The ID of the message to reply to \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to reply to |
| `content` | string | Yes | The reply content \(plain text or HTML formatted message\) | | `content` | string | Yes | The reply content |
#### Output #### Output
@@ -242,10 +242,10 @@ Get a specific message from a Microsoft Teams chat or channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) | | `teamId` | string | No | The ID of the team \(for channel messages\) |
| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) | | `channelId` | string | No | The ID of the channel \(for channel messages\) |
| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) | | `chatId` | string | No | The ID of the chat \(for chat messages\) |
| `messageId` | string | Yes | The ID of the message to retrieve \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to retrieve |
#### Output #### Output
@@ -272,10 +272,10 @@ Add an emoji reaction to a message in Microsoft Teams
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) | | `teamId` | string | No | The ID of the team \(for channel messages\) |
| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) | | `channelId` | string | No | The ID of the channel \(for channel messages\) |
| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) | | `chatId` | string | No | The ID of the chat \(for chat messages\) |
| `messageId` | string | Yes | The ID of the message to react to \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message to react to |
| `reactionType` | string | Yes | The emoji reaction \(e.g., ❤️, 👍, 😊\) | | `reactionType` | string | Yes | The emoji reaction \(e.g., ❤️, 👍, 😊\) |
#### Output #### Output
@@ -294,10 +294,10 @@ Remove an emoji reaction from a message in Microsoft Teams
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | No | The ID of the team for channel messages \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID\) | | `teamId` | string | No | The ID of the team \(for channel messages\) |
| `channelId` | string | No | The ID of the channel for channel messages \(e.g., "19:abc123def456@thread.tacv2"\) | | `channelId` | string | No | The ID of the channel \(for channel messages\) |
| `chatId` | string | No | The ID of the chat for chat messages \(e.g., "19:abc123def456@thread.v2"\) | | `chatId` | string | No | The ID of the chat \(for chat messages\) |
| `messageId` | string | Yes | The ID of the message \(e.g., "1234567890123" - a numeric string from message responses\) | | `messageId` | string | Yes | The ID of the message |
| `reactionType` | string | Yes | The emoji reaction to remove \(e.g., ❤️, 👍, 😊\) | | `reactionType` | string | Yes | The emoji reaction to remove \(e.g., ❤️, 👍, 😊\) |
#### Output #### Output
@@ -316,7 +316,7 @@ List all members of a Microsoft Teams team
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | | `teamId` | string | Yes | The ID of the team |
#### Output #### Output
@@ -334,8 +334,8 @@ List all members of a Microsoft Teams channel
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team \(e.g., "12345678-abcd-1234-efgh-123456789012" - a GUID from team listings\) | | `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel \(e.g., "19:abc123def456@thread.tacv2" - from channel listings\) | | `channelId` | string | Yes | The ID of the channel |
#### Output #### Output

View File

@@ -64,12 +64,21 @@ Parse PDF documents using Mistral OCR API
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels | | ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels | | ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) | | ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) |
| ↳ `top_left_x` | number | Top-left X coordinate in pixels |
| ↳ `top_left_y` | number | Top-left Y coordinate in pixels |
| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels |
| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels |
| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) |
| ↳ `dimensions` | object | Page dimensions | | ↳ `dimensions` | object | Page dimensions |
| ↳ `dpi` | number | Dots per inch | | ↳ `dpi` | number | Dots per inch |
| ↳ `height` | number | Page height in pixels | | ↳ `height` | number | Page height in pixels |
| ↳ `width` | number | Page width in pixels | | ↳ `width` | number | Page width in pixels |
| ↳ `dpi` | number | Dots per inch |
| ↳ `height` | number | Page height in pixels |
| ↳ `width` | number | Page width in pixels |
| ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] | | ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] |
| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \["https://...", "mailto:..."\]\) | | ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \[ |
| ↳ `header` | string | Page header content \(when extract_header=true\) | | ↳ `header` | string | Page header content \(when extract_header=true\) |
| ↳ `footer` | string | Page footer content \(when extract_footer=true\) | | ↳ `footer` | string | Page footer content \(when extract_footer=true\) |
| `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) | | `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) |

View File

@@ -43,7 +43,7 @@ Execute find operation on MongoDB collection
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MongoDB server hostname or IP address | | `host` | string | Yes | MongoDB server hostname or IP address |
| `port` | number | Yes | MongoDB server port \(default: 27017\) | | `port` | number | Yes | MongoDB server port \(default: 27017\) |
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | No | MongoDB username | | `username` | string | No | MongoDB username |
| `password` | string | No | MongoDB password | | `password` | string | No | MongoDB password |
| `authSource` | string | No | Authentication database | | `authSource` | string | No | Authentication database |
@@ -71,7 +71,7 @@ Insert documents into MongoDB collection
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MongoDB server hostname or IP address | | `host` | string | Yes | MongoDB server hostname or IP address |
| `port` | number | Yes | MongoDB server port \(default: 27017\) | | `port` | number | Yes | MongoDB server port \(default: 27017\) |
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | No | MongoDB username | | `username` | string | No | MongoDB username |
| `password` | string | No | MongoDB password | | `password` | string | No | MongoDB password |
| `authSource` | string | No | Authentication database | | `authSource` | string | No | Authentication database |
@@ -98,7 +98,7 @@ Update documents in MongoDB collection
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MongoDB server hostname or IP address | | `host` | string | Yes | MongoDB server hostname or IP address |
| `port` | number | Yes | MongoDB server port \(default: 27017\) | | `port` | number | Yes | MongoDB server port \(default: 27017\) |
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | No | MongoDB username | | `username` | string | No | MongoDB username |
| `password` | string | No | MongoDB password | | `password` | string | No | MongoDB password |
| `authSource` | string | No | Authentication database | | `authSource` | string | No | Authentication database |
@@ -129,7 +129,7 @@ Delete documents from MongoDB collection
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MongoDB server hostname or IP address | | `host` | string | Yes | MongoDB server hostname or IP address |
| `port` | number | Yes | MongoDB server port \(default: 27017\) | | `port` | number | Yes | MongoDB server port \(default: 27017\) |
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | No | MongoDB username | | `username` | string | No | MongoDB username |
| `password` | string | No | MongoDB password | | `password` | string | No | MongoDB password |
| `authSource` | string | No | Authentication database | | `authSource` | string | No | Authentication database |
@@ -156,7 +156,7 @@ Execute MongoDB aggregation pipeline
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MongoDB server hostname or IP address | | `host` | string | Yes | MongoDB server hostname or IP address |
| `port` | number | Yes | MongoDB server port \(default: 27017\) | | `port` | number | Yes | MongoDB server port \(default: 27017\) |
| `database` | string | Yes | Database name to connect to \(e.g., "mydb"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | No | MongoDB username | | `username` | string | No | MongoDB username |
| `password` | string | No | MongoDB password | | `password` | string | No | MongoDB password |
| `authSource` | string | No | Authentication database | | `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 | | `host` | string | Yes | MongoDB server hostname or IP address |
| `port` | number | Yes | MongoDB server port \(default: 27017\) | | `port` | number | Yes | MongoDB server port \(default: 27017\) |
| `database` | string | No | Database name to introspect \(e.g., "mydb"\). If not provided, lists all databases | | `database` | string | No | Database name to introspect \(optional - if not provided, lists all databases\) |
| `username` | string | No | MongoDB username | | `username` | string | No | MongoDB username |
| `password` | string | No | MongoDB password | | `password` | string | No | MongoDB password |
| `authSource` | string | No | Authentication database | | `authSource` | string | No | Authentication database |

View File

@@ -43,11 +43,11 @@ Execute SELECT query on MySQL database
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address | | `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) | | `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username | | `username` | string | Yes | Database username |
| `password` | string | Yes | Database password | | `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE active = 1\) | | `query` | string | Yes | SQL SELECT query to execute |
#### Output #### Output
@@ -67,11 +67,11 @@ Insert new record into MySQL database
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address | | `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) | | `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username | | `username` | string | Yes | Database username |
| `password` | string | Yes | Database password | | `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `table` | string | Yes | Table name to insert into \(e.g., users, orders\) | | `table` | string | Yes | Table name to insert into |
| `data` | object | Yes | Data to insert as key-value pairs | | `data` | object | Yes | Data to insert as key-value pairs |
#### Output #### Output
@@ -92,11 +92,11 @@ Update existing records in MySQL database
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address | | `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) | | `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username | | `username` | string | Yes | Database username |
| `password` | string | Yes | Database password | | `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `table` | string | Yes | Table name to update \(e.g., users, orders\) | | `table` | string | Yes | Table name to update |
| `data` | object | Yes | Data to update as key-value pairs | | `data` | object | Yes | Data to update as key-value pairs |
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) | | `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 | | `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) | | `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username | | `username` | string | Yes | Database username |
| `password` | string | Yes | Database password | | `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `table` | string | Yes | Table name to delete from \(e.g., users, orders\) | | `table` | string | Yes | Table name to delete from |
| `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) | | `where` | string | Yes | WHERE clause condition \(without WHERE keyword\) |
#### Output #### Output
@@ -143,11 +143,11 @@ Execute raw SQL query on MySQL database
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `host` | string | Yes | MySQL server hostname or IP address | | `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) | | `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username | | `username` | string | Yes | Database username |
| `password` | string | Yes | Database password | | `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |
| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id INT PRIMARY KEY, name VARCHAR\(255\)\)\) | | `query` | string | Yes | Raw SQL query to execute |
#### Output #### 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 | | `host` | string | Yes | MySQL server hostname or IP address |
| `port` | number | Yes | MySQL server port \(default: 3306\) | | `port` | number | Yes | MySQL server port \(default: 3306\) |
| `database` | string | Yes | Database name to connect to \(e.g., my_database\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Database username | | `username` | string | Yes | Database username |
| `password` | string | Yes | Database password | | `password` | string | Yes | Database password |
| `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) | | `ssl` | string | No | SSL connection mode \(disabled, required, preferred\) |

View File

@@ -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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
| `cypherQuery` | string | Yes | Cypher query to execute \(e.g., "MATCH \(n:Person\) RETURN n LIMIT 10", "MATCH \(a\)-\[r\]-&gt;\(b\) WHERE a.name = $name RETURN a, r, b"\) | | `cypherQuery` | string | Yes | Cypher query to execute \(typically MATCH statements\) |
| `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` | 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 | | `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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
| `cypherQuery` | string | Yes | Cypher CREATE statement to execute \(e.g., "CREATE \(n:Person \{name: $name, age: $age\}\)", "CREATE \(a\)-\[:KNOWS\]-&gt;\(b\)"\) | | `cypherQuery` | string | Yes | Cypher CREATE statement to execute |
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "age": 30\}\) | | `parameters` | object | No | Parameters for the Cypher query as a JSON object |
#### Output #### 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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
| `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\]-&gt;\(b\)"\) | | `cypherQuery` | string | Yes | Cypher MERGE statement to execute |
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "email": "alice@example.com"\}\) | | `parameters` | object | No | Parameters for the Cypher query as a JSON object |
#### Output #### 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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
| `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"\) | | `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 \(e.g., \{"name": "Alice", "age": 31, "props": \{"city": "NYC"\}\}\) | | `parameters` | object | No | Parameters for the Cypher query as a JSON object |
#### Output #### 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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
| `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"\) | | `cypherQuery` | string | Yes | Cypher query with MATCH and DELETE/DETACH DELETE statements |
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "id": 123\}\) | | `parameters` | object | No | Parameters for the Cypher query as a JSON object |
| `detach` | boolean | No | Whether to use DETACH DELETE to remove relationships before deleting nodes | | `detach` | boolean | No | Whether to use DETACH DELETE to remove relationships before deleting nodes |
#### Output #### 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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |
| `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\)"\) | | `cypherQuery` | string | Yes | Cypher query to execute \(any valid Cypher statement\) |
| `parameters` | object | No | Parameters for the Cypher query as a JSON object \(e.g., \{"name": "Alice", "limit": 100\}\) | | `parameters` | object | No | Parameters for the Cypher query as a JSON object |
#### Output #### 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 | | `host` | string | Yes | Neo4j server hostname or IP address |
| `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) | | `port` | number | Yes | Neo4j server port \(default: 7687 for Bolt protocol\) |
| `database` | string | Yes | Database name to connect to \(e.g., "neo4j", "movies", "social"\) | | `database` | string | Yes | Database name to connect to |
| `username` | string | Yes | Neo4j username | | `username` | string | Yes | Neo4j username |
| `password` | string | Yes | Neo4j password | | `password` | string | Yes | Neo4j password |
| `encryption` | string | No | Connection encryption mode \(enabled, disabled\) | | `encryption` | string | No | Connection encryption mode \(enabled, disabled\) |

View File

@@ -26,17 +26,17 @@ Read content from a Notion page
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `pageId` | string | Yes | The UUID of the Notion page to read | | `pageId` | string | Yes | The ID of the Notion page to read |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `url` | string | Notion page URL |
| `created_time` | string | ISO 8601 creation timestamp |
| `last_edited_time` | string | ISO 8601 last edit timestamp |
| `content` | string | Page content in markdown format | | `content` | string | Page content in markdown format |
| `title` | string | Page title | | `title` | string | Page title |
| `url` | string | Page URL |
| `created_time` | string | Creation timestamp |
| `last_edited_time` | string | Last edit timestamp |
### `notion_read_database` ### `notion_read_database`
@@ -46,18 +46,18 @@ Read database information and structure from Notion
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `databaseId` | string | Yes | The UUID of the Notion database to read | | `databaseId` | string | Yes | The ID of the Notion database to read |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `id` | string | Database UUID | | `id` | string | Database ID |
| `url` | string | Notion database URL |
| `created_time` | string | ISO 8601 creation timestamp |
| `last_edited_time` | string | ISO 8601 last edit timestamp |
| `properties` | object | Database properties schema |
| `title` | string | Database title | | `title` | string | Database title |
| `url` | string | Database URL |
| `created_time` | string | Creation timestamp |
| `last_edited_time` | string | Last edit timestamp |
| `properties` | object | Database properties schema |
### `notion_write` ### `notion_write`
@@ -67,7 +67,7 @@ Append content to a Notion page
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `pageId` | string | Yes | The UUID of the Notion page to append content to | | `pageId` | string | Yes | The ID of the Notion page to append content to |
| `content` | string | Yes | The content to append to the page | | `content` | string | Yes | The content to append to the page |
#### Output #### Output
@@ -84,7 +84,7 @@ Create a new page in Notion
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `parentId` | string | Yes | The UUID of the parent Notion page where this page will be created | | `parentId` | string | Yes | ID of the parent page |
| `title` | string | No | Title of the new page | | `title` | string | No | Title of the new page |
| `content` | string | No | Optional content to add to the page upon creation | | `content` | string | No | Optional content to add to the page upon creation |
@@ -92,11 +92,11 @@ Create a new page in Notion
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `id` | string | Page UUID | | `id` | string | Page ID |
| `url` | string | Notion page URL |
| `created_time` | string | ISO 8601 creation timestamp |
| `last_edited_time` | string | ISO 8601 last edit timestamp |
| `title` | string | Page title | | `title` | string | Page title |
| `url` | string | Page URL |
| `created_time` | string | Creation timestamp |
| `last_edited_time` | string | Last edit timestamp |
### `notion_query_database` ### `notion_query_database`
@@ -106,7 +106,7 @@ Query and filter Notion database entries with advanced filtering
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `databaseId` | string | Yes | The UUID of the Notion database to query | | `databaseId` | string | Yes | The ID of the database to query |
| `filter` | string | No | Filter conditions as JSON \(optional\) | | `filter` | string | No | Filter conditions as JSON \(optional\) |
| `sorts` | string | No | Sort criteria as JSON array \(optional\) | | `sorts` | string | No | Sort criteria as JSON array \(optional\) |
| `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) | | `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
@@ -115,43 +115,13 @@ Query and filter Notion database entries with advanced filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `results` | array | Array of page objects from the database | | `results` | array | Array of Notion page objects from the database |
| ↳ `object` | string | Always "page" | | ↳ `id` | string | Page ID |
| ↳ `id` | string | Page UUID | | ↳ `created_time` | string | Creation timestamp |
| ↳ `created_time` | string | ISO 8601 creation timestamp | | ↳ `last_edited_time` | string | Last edit timestamp |
| ↳ `last_edited_time` | string | ISO 8601 last edit timestamp | | ↳ `url` | string | Page URL |
| ↳ `created_by` | object | Partial user object |
| ↳ `object` | string | Always "user" |
| ↳ `id` | string | User UUID |
| ↳ `last_edited_by` | object | Partial user object |
| ↳ `object` | string | Always "user" |
| ↳ `id` | string | User UUID |
| ↳ `archived` | boolean | Whether the page is archived |
| ↳ `in_trash` | boolean | Whether the page is in trash |
| ↳ `url` | string | Notion page URL |
| ↳ `public_url` | string | Public web URL if shared, null otherwise |
| ↳ `parent` | object | Parent object specifying hierarchical relationship |
| ↳ `type` | string | Parent type: "database_id", "data_source_id", "page_id", "workspace", or "block_id" |
| ↳ `database_id` | string | Parent database UUID \(if type is database_id\) |
| ↳ `data_source_id` | string | Parent data source UUID \(if type is data_source_id\) |
| ↳ `page_id` | string | Parent page UUID \(if type is page_id\) |
| ↳ `workspace` | boolean | True if parent is workspace \(if type is workspace\) |
| ↳ `block_id` | string | Parent block UUID \(if type is block_id\) |
| ↳ `icon` | object | Page/database icon \(emoji, custom_emoji, or file\) |
| ↳ `url` | string | Authenticated URL valid for one hour |
| ↳ `expiry_time` | string | ISO 8601 timestamp when URL expires |
| ↳ `cover` | object | Page/database cover image |
| ↳ `type` | string | File type: "file", "file_upload", or "external" |
| ↳ `file` | object | Notion-hosted file object \(when type is "file"\) |
| ↳ `url` | string | Authenticated URL valid for one hour |
| ↳ `expiry_time` | string | ISO 8601 timestamp when URL expires |
| ↳ `file_upload` | object | API-uploaded file object \(when type is "file_upload"\) |
| ↳ `id` | string | File upload UUID |
| ↳ `external` | object | External file object \(when type is "external"\) |
| ↳ `url` | string | External file URL \(never expires\) |
| ↳ `properties` | object | Page property values \(structure depends on parent type - database properties or title only\) |
| `has_more` | boolean | Whether more results are available | | `has_more` | boolean | Whether more results are available |
| `next_cursor` | string | Cursor for next page of results | | `next_cursor` | string | Cursor for pagination |
| `total_results` | number | Number of results returned | | `total_results` | number | Number of results returned |
### `notion_search` ### `notion_search`
@@ -162,39 +132,22 @@ Search across all pages and databases in Notion workspace
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | No | Search terms to find pages and databases \(leave empty to get all pages\) | | `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 | | `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\) | | `pageSize` | number | No | Number of results to return \(default: 100, max: 100\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `results` | array | Array of search results \(pages and/or databases\) | | `results` | array | Array of search results \(pages and databases\) |
| ↳ `object` | string | Object type: "page" or "database" | | ↳ `id` | string | Object ID |
| ↳ `id` | string | Object UUID | | ↳ `object` | string | Object type \(page or database\) |
| ↳ `created_time` | string | ISO 8601 creation timestamp |
| ↳ `last_edited_time` | string | ISO 8601 last edit timestamp |
| ↳ `created_by` | object | Partial user object |
| ↳ `object` | string | Always "user" |
| ↳ `id` | string | User UUID |
| ↳ `last_edited_by` | object | Partial user object |
| ↳ `object` | string | Always "user" |
| ↳ `id` | string | User UUID |
| ↳ `archived` | boolean | Whether the object is archived |
| ↳ `in_trash` | boolean | Whether the object is in trash |
| ↳ `url` | string | Object URL | | ↳ `url` | string | Object URL |
| ↳ `public_url` | string | Public web URL if shared | | ↳ `created_time` | string | Creation timestamp |
| ↳ `parent` | object | Parent object specifying hierarchical relationship | | ↳ `last_edited_time` | string | Last edit timestamp |
| ↳ `type` | string | Parent type: "database_id", "data_source_id", "page_id", "workspace", or "block_id" |
| ↳ `database_id` | string | Parent database UUID \(if type is database_id\) |
| ↳ `data_source_id` | string | Parent data source UUID \(if type is data_source_id\) |
| ↳ `page_id` | string | Parent page UUID \(if type is page_id\) |
| ↳ `workspace` | boolean | True if parent is workspace \(if type is workspace\) |
| ↳ `block_id` | string | Parent block UUID \(if type is block_id\) |
| ↳ `properties` | object | Object properties |
| `has_more` | boolean | Whether more results are available | | `has_more` | boolean | Whether more results are available |
| `next_cursor` | string | Cursor for next page of results | | `next_cursor` | string | Cursor for pagination |
| `total_results` | number | Number of results returned | | `total_results` | number | Number of results returned |
### `notion_create_database` ### `notion_create_database`
@@ -213,11 +166,11 @@ Create a new database in Notion with custom properties
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `id` | string | Database UUID | | `id` | string | Database ID |
| `url` | string | Notion database URL |
| `created_time` | string | ISO 8601 creation timestamp |
| `properties` | object | Database properties schema |
| `title` | string | Database title | | `title` | string | Database title |
| `url` | string | Database URL |
| `created_time` | string | Creation timestamp |
| `properties` | object | Database properties schema |
### `notion_add_database_row` ### `notion_add_database_row`
@@ -234,10 +187,10 @@ Add a new row to a Notion database with specified properties
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `id` | string | Page UUID | | `id` | string | Page/row ID |
| `url` | string | Notion page URL | | `url` | string | Page/row URL |
| `created_time` | string | ISO 8601 creation timestamp |
| `last_edited_time` | string | ISO 8601 last edit timestamp |
| `title` | string | Row title | | `title` | string | Row title |
| `created_time` | string | Creation timestamp |
| `last_edited_time` | string | Last edit timestamp |

View File

@@ -44,11 +44,11 @@ Upload a file to OneDrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `fileName` | string | Yes | The name of the file to upload \(e.g., "report.pdf", "data.xlsx"\) | | `fileName` | string | Yes | The name of the file to upload |
| `file` | file | No | The file to upload \(binary\) | | `file` | file | No | The file to upload \(binary\) |
| `content` | string | No | The text content to upload \(if no file is provided\) | | `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\) | | `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 | Folder ID to upload the file to \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `folderSelector` | string | No | Select the folder to upload the file to |
| `manualFolderId` | string | No | Manually entered folder ID \(advanced mode\) | | `manualFolderId` | string | No | Manually entered folder ID \(advanced mode\) |
#### Output #### Output
@@ -66,8 +66,8 @@ Create a new folder in OneDrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `folderName` | string | Yes | Name of the folder to create \(e.g., "My Documents", "Project Files"\) | | `folderName` | string | Yes | Name of the folder to create |
| `folderSelector` | string | No | Parent folder ID to create the folder in \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `folderSelector` | string | No | Select the parent folder to create the folder in |
| `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) | | `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) |
#### Output #### Output
@@ -85,8 +85,8 @@ Download a file from OneDrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `fileId` | string | Yes | The ID of the file to download \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `fileId` | string | Yes | The ID of the file to download |
| `fileName` | string | No | Optional filename override \(e.g., "report.pdf", "data.xlsx"\) | | `fileName` | string | No | Optional filename override |
#### Output #### Output
@@ -102,10 +102,10 @@ List files and folders in OneDrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `folderSelector` | string | No | Folder ID to list files from \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `folderSelector` | string | No | Select the folder to list files from |
| `manualFolderId` | string | No | The manually entered folder ID \(advanced mode\) | | `manualFolderId` | string | No | The manually entered folder ID \(advanced mode\) |
| `query` | string | No | Filter files by name prefix \(e.g., "report", "invoice_2024"\) | | `query` | string | No | A query to filter the files |
| `pageSize` | number | No | Maximum number of files to return \(e.g., 10, 50, 100\) | | `pageSize` | number | No | The number of files to return |
#### Output #### Output
@@ -123,7 +123,7 @@ Delete a file or folder from OneDrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `fileId` | string | Yes | The ID of the file or folder to delete \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) | | `fileId` | string | Yes | The ID of the file or folder to delete |
#### Output #### Output

View File

@@ -59,5 +59,7 @@ Generate embeddings from text using OpenAI
| ↳ `usage` | object | Token usage information | | ↳ `usage` | object | Token usage information |
| ↳ `prompt_tokens` | number | Number of tokens in the prompt | | ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `total_tokens` | number | Total number of tokens used | | ↳ `total_tokens` | number | Total number of tokens used |
| ↳ `prompt_tokens` | number | Number of tokens in the prompt |
| ↳ `total_tokens` | number | Total number of tokens used |

View File

@@ -51,7 +51,7 @@ Send emails using Outlook
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `to` | string | Yes | Recipient email address \(comma-separated for multiple recipients\) | | `to` | string | Yes | Recipient email address |
| `subject` | string | Yes | Email subject | | `subject` | string | Yes | Email subject |
| `body` | string | Yes | Email body content | | `body` | string | Yes | Email body content |
| `contentType` | string | No | Content type for the email body \(text or html\) | | `contentType` | string | No | Content type for the email body \(text or html\) |
@@ -105,9 +105,9 @@ Read emails from Outlook
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `folder` | string | No | Folder ID to read emails from \(e.g., "Inbox", "Drafts", or a folder ID\) | | `folder` | string | No | Folder ID to read emails from \(default: Inbox\) |
| `maxResults` | number | No | Maximum number of emails to retrieve \(default: 1, max: 10\) | | `maxResults` | number | No | Maximum number of emails to retrieve \(default: 1, max: 10\) |
| `includeAttachments` | boolean | No | Whether to download and include email attachments | | `includeAttachments` | boolean | No | Download and include email attachments |
#### Output #### Output
@@ -115,29 +115,6 @@ Read emails from Outlook
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Success or status message | | `message` | string | Success or status message |
| `results` | array | Array of email message objects | | `results` | array | Array of email message objects |
| ↳ `id` | string | Unique message identifier |
| ↳ `subject` | string | Email subject |
| ↳ `bodyPreview` | string | Preview of the message body |
| ↳ `body` | object | Message body |
| ↳ `contentType` | string | Body content type \(text or html\) |
| ↳ `content` | string | Body content |
| ↳ `sender` | object | Sender information |
| ↳ `name` | string | Display name of the person or entity |
| ↳ `address` | string | Email address |
| ↳ `from` | object | From address information |
| ↳ `name` | string | Display name of the person or entity |
| ↳ `address` | string | Email address |
| ↳ `toRecipients` | array | To recipients |
| ↳ `name` | string | Display name of the person or entity |
| ↳ `address` | string | Email address |
| ↳ `ccRecipients` | array | CC recipients |
| ↳ `name` | string | Display name of the person or entity |
| ↳ `address` | string | Email address |
| ↳ `receivedDateTime` | string | When the message was received \(ISO 8601\) |
| ↳ `sentDateTime` | string | When the message was sent \(ISO 8601\) |
| ↳ `hasAttachments` | boolean | Whether the message has attachments |
| ↳ `isRead` | boolean | Whether the message has been read |
| ↳ `importance` | string | Message importance \(low, normal, high\) |
| `attachments` | file[] | All email attachments flattened from all emails | | `attachments` | file[] | All email attachments flattened from all emails |
### `outlook_forward` ### `outlook_forward`

View File

@@ -112,6 +112,9 @@ Conduct comprehensive deep research across the web using Parallel AI. Synthesize
| ↳ `url` | string | Source URL | | ↳ `url` | string | Source URL |
| ↳ `title` | string | Source title | | ↳ `title` | string | Source title |
| ↳ `excerpts` | array | Relevant excerpts from the source | | ↳ `excerpts` | array | Relevant excerpts from the source |
| ↳ `url` | string | Source URL |
| ↳ `title` | string | Source title |
| ↳ `excerpts` | array | Relevant excerpts from the source |
| ↳ `confidence` | string | Confidence level indicator | | ↳ `confidence` | string | Confidence level indicator |

View File

@@ -45,9 +45,9 @@ Generate completions using Perplexity AI chat models
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `systemPrompt` | string | No | System prompt to guide the model behavior | | `systemPrompt` | string | No | System prompt to guide the model behavior |
| `content` | string | Yes | The user message content to send to the model | | `content` | string | Yes | The user message content to send to the model |
| `model` | string | Yes | Model to use for chat completions \(e.g., "sonar", "sonar-pro", "sonar-reasoning"\) | | `model` | string | Yes | Model to use for chat completions \(e.g., sonar, mistral\) |
| `max_tokens` | number | No | Maximum number of tokens to generate \(e.g., 1024, 2048, 4096\) | | `max_tokens` | number | No | Maximum number of tokens to generate |
| `temperature` | number | No | Sampling temperature between 0 and 1 \(e.g., 0.0 for deterministic, 0.7 for creative\) | | `temperature` | number | No | Sampling temperature between 0 and 1 |
| `apiKey` | string | Yes | Perplexity API key | | `apiKey` | string | Yes | Perplexity API key |
#### Output #### 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\) | | `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\) | | `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 \(e.g., \["github.com", "stackoverflow.com"\], max 20\) | | `search_domain_filter` | array | No | List of domains/URLs to limit search results to \(max 20\) |
| `max_tokens_per_page` | number | No | Maximum number of tokens retrieved from each webpage \(default: 1024\) | | `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\) | | `country` | string | No | Country code to filter search results \(e.g., US, GB, DE\) |
| `search_recency_filter` | string | No | Filter results by recency \(e.g., "hour", "day", "week", "month", "year"\) | | `search_recency_filter` | string | No | Filter results by recency: hour, day, week, month, or year |
| `search_after_date` | string | No | Include only content published after this date \(format: MM/DD/YYYY\) | | `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\) | | `search_before_date` | string | No | Include only content published before this date \(format: MM/DD/YYYY\) |
| `apiKey` | string | Yes | Perplexity API key | | `apiKey` | string | Yes | Perplexity API key |
@@ -87,7 +87,7 @@ Get ranked search results from Perplexity
| ↳ `title` | string | Title of the search result | | ↳ `title` | string | Title of the search result |
| ↳ `url` | string | URL of the search result | | ↳ `url` | string | URL of the search result |
| ↳ `snippet` | string | Brief excerpt or summary of the content | | ↳ `snippet` | string | Brief excerpt or summary of the content |
| ↳ `date` | string | Date the page was crawled and added to Perplexity's index | | ↳ `date` | string | Date the page was crawled and added to Perplexity |
| ↳ `last_updated` | string | Date the page was last updated in Perplexity's index | | ↳ `last_updated` | string | Date the page was last updated in Perplexity |

View File

@@ -64,8 +64,8 @@ Insert or update text records in a Pinecone index
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | | `indexHost` | string | Yes | Full Pinecone index host URL |
| `namespace` | string | Yes | Namespace to upsert records into \(e.g., "documents", "embeddings"\) | | `namespace` | string | Yes | Namespace to upsert records into |
| `records` | array | Yes | Record or array of records to upsert, each containing _id, text, and optional metadata | | `records` | array | Yes | Record or array of records to upsert, each containing _id, text, and optional metadata |
| `apiKey` | string | Yes | Pinecone API key | | `apiKey` | string | Yes | Pinecone API key |
@@ -83,12 +83,12 @@ Search for similar text in a Pinecone index
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | | `indexHost` | string | Yes | Full Pinecone index host URL |
| `namespace` | string | No | Namespace to search in \(e.g., "documents", "embeddings"\) | | `namespace` | string | No | Namespace to search in |
| `searchQuery` | string | Yes | Text to search for | | `searchQuery` | string | Yes | Text to search for |
| `topK` | string | No | Number of results to return \(e.g., "10", "25"\) | | `topK` | string | No | Number of results to return |
| `fields` | array | No | Fields to return in the results | | `fields` | array | No | Fields to return in the results |
| `filter` | object | No | Filter to apply to the search \(e.g., \{"category": "tech", "year": \{"$gte": 2020\}\}\) | | `filter` | object | No | Filter to apply to the search |
| `rerank` | object | No | Reranking parameters | | `rerank` | object | No | Reranking parameters |
| `apiKey` | string | Yes | Pinecone API key | | `apiKey` | string | Yes | Pinecone API key |
@@ -113,13 +113,13 @@ Search for similar vectors in a Pinecone index
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | | `indexHost` | string | Yes | Full Pinecone index host URL |
| `namespace` | string | No | Namespace to search in \(e.g., "documents", "embeddings"\) | | `namespace` | string | No | Namespace to search in |
| `vector` | array | Yes | Vector to search for | | `vector` | array | Yes | Vector to search for |
| `topK` | number | No | Number of results to return \(e.g., 10, 25\) | | `topK` | number | No | Number of results to return |
| `filter` | object | No | Filter to apply to the search \(e.g., \{"category": "tech", "year": \{"$gte": 2020\}\}\) | | `filter` | object | No | Filter to apply to the search |
| `includeValues` | boolean | No | Include vector values in response | | `includeValues` | boolean | No | Include vector values in response |
| `includeMetadata` | boolean | No | Include metadata in response \(true/false\) | | `includeMetadata` | boolean | No | Include metadata in response |
| `apiKey` | string | Yes | Pinecone API key | | `apiKey` | string | Yes | Pinecone API key |
#### Output #### Output
@@ -137,9 +137,9 @@ Fetch vectors by ID from a Pinecone index
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `indexHost` | string | Yes | Full Pinecone index host URL \(e.g., "https://my-index-abc123.svc.pinecone.io"\) | | `indexHost` | string | Yes | Full Pinecone index host URL |
| `ids` | array | Yes | Array of vector IDs to fetch \(e.g., \["vec-001", "vec-002"\]\) | | `ids` | array | Yes | Array of vector IDs to fetch |
| `namespace` | string | No | Namespace to fetch vectors from \(e.g., "documents", "embeddings"\) | | `namespace` | string | No | Namespace to fetch vectors from |
| `apiKey` | string | Yes | Pinecone API key | | `apiKey` | string | Yes | Pinecone API key |
#### Output #### Output

View File

@@ -44,36 +44,18 @@ Retrieve all deals from Pipedrive with optional filters
| Parameter | Type | Required | Description | | 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 | | `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 \(e.g., "456"\) | | `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 \(e.g., "789"\) | | `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 \(e.g., "1"\) | | `pipeline_id` | string | No | If supplied, only deals in the specified pipeline are returned |
| `updated_since` | string | No | If set, only deals updated after this time are returned. Format: 2025-01-01T10:20:00Z | | `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 \(e.g., "50", default: 100, max: 500\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `deals` | array | Array of deal objects from Pipedrive | | `deals` | array | Array of deal objects from Pipedrive |
| ↳ `id` | number | Deal ID |
| ↳ `title` | string | Deal title |
| ↳ `value` | number | Deal value |
| ↳ `currency` | string | Currency code |
| ↳ `status` | string | Deal status \(open, won, lost, deleted\) |
| ↳ `stage_id` | number | Pipeline stage ID |
| ↳ `pipeline_id` | number | Pipeline ID |
| ↳ `person_id` | number | Associated person ID |
| ↳ `org_id` | number | Associated organization ID |
| ↳ `owner_id` | number | Deal owner user ID |
| ↳ `add_time` | string | When the deal was created \(ISO 8601\) |
| ↳ `update_time` | string | When the deal was last updated \(ISO 8601\) |
| ↳ `won_time` | string | When the deal was won |
| ↳ `lost_time` | string | When the deal was lost |
| ↳ `close_time` | string | When the deal was closed |
| ↳ `expected_close_date` | string | Expected close date |
| `metadata` | object | Pagination metadata for the response | | `metadata` | object | Pagination metadata for the response |
| ↳ `total_items` | number | Total number of items |
| ↳ `has_more` | boolean | Whether more items are available |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
### `pipedrive_get_deal` ### `pipedrive_get_deal`
@@ -84,7 +66,7 @@ Retrieve detailed information about a specific deal
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `deal_id` | string | Yes | The ID of the deal to retrieve \(e.g., "123"\) | | `deal_id` | string | Yes | The ID of the deal to retrieve |
#### Output #### Output
@@ -101,15 +83,15 @@ Create a new deal in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `title` | string | Yes | The title of the deal \(e.g., "Enterprise Software License"\) | | `title` | string | Yes | The title of the deal |
| `value` | string | No | The monetary value of the deal \(e.g., "5000"\) | | `value` | string | No | The monetary value of the deal |
| `currency` | string | No | Currency code \(e.g., "USD", "EUR", "GBP"\) | | `currency` | string | No | Currency code \(e.g., USD, EUR\) |
| `person_id` | string | No | ID of the person this deal is associated with \(e.g., "456"\) | | `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 \(e.g., "789"\) | | `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 \(e.g., "1"\) | | `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 \(e.g., "2"\) | | `stage_id` | string | No | ID of the stage this deal should be placed in |
| `status` | string | No | Status of the deal: open, won, lost | | `status` | string | No | Status of the deal: open, won, lost |
| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format \(e.g., "2025-06-30"\) | | `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format |
#### Output #### Output
@@ -126,12 +108,12 @@ Update an existing deal in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `deal_id` | string | Yes | The ID of the deal to update \(e.g., "123"\) | | `deal_id` | string | Yes | The ID of the deal to update |
| `title` | string | No | New title for the deal \(e.g., "Updated Enterprise License"\) | | `title` | string | No | New title for the deal |
| `value` | string | No | New monetary value for the deal \(e.g., "7500"\) | | `value` | string | No | New monetary value for the deal |
| `status` | string | No | New status: open, won, lost | | `status` | string | No | New status: open, won, lost |
| `stage_id` | string | No | New stage ID for the deal \(e.g., "3"\) | | `stage_id` | string | No | New stage ID for the deal |
| `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format \(e.g., "2025-07-15"\) | | `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format |
#### Output #### Output
@@ -148,26 +130,16 @@ Retrieve files from Pipedrive with optional filters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `deal_id` | string | No | Filter files by deal ID \(e.g., "123"\) | | `deal_id` | string | No | Filter files by deal ID |
| `person_id` | string | No | Filter files by person ID \(e.g., "456"\) | | `person_id` | string | No | Filter files by person ID |
| `org_id` | string | No | Filter files by organization ID \(e.g., "789"\) | | `org_id` | string | No | Filter files by organization ID |
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `files` | array | Array of file objects from Pipedrive | | `files` | array | Array of file objects from Pipedrive |
| ↳ `id` | number | File ID |
| ↳ `name` | string | File name |
| ↳ `file_type` | string | File type/extension |
| ↳ `file_size` | number | File size in bytes |
| ↳ `add_time` | string | When the file was uploaded |
| ↳ `update_time` | string | When the file was last updated |
| ↳ `deal_id` | number | Associated deal ID |
| ↳ `person_id` | number | Associated person ID |
| ↳ `org_id` | number | Associated organization ID |
| ↳ `url` | string | File download URL |
| `total_items` | number | Total number of files returned | | `total_items` | number | Total number of files returned |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -180,7 +152,7 @@ Retrieve mail threads from Pipedrive mailbox
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `folder` | string | No | Filter by folder: inbox, drafts, sent, archive \(default: inbox\) | | `folder` | string | No | Filter by folder: inbox, drafts, sent, archive \(default: inbox\) |
| `limit` | string | No | Number of results to return \(e.g., "25", default: 50\) | | `limit` | string | No | Number of results to return \(default: 50\) |
#### Output #### Output
@@ -198,7 +170,7 @@ Retrieve all messages from a specific mail thread
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `thread_id` | string | Yes | The ID of the mail thread \(e.g., "12345"\) | | `thread_id` | string | Yes | The ID of the mail thread |
#### Output #### Output
@@ -218,7 +190,7 @@ Retrieve all pipelines from Pipedrive
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `sort_by` | string | No | Field to sort by: id, update_time, add_time \(default: id\) | | `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\) | | `sort_direction` | string | No | Sorting direction: asc, desc \(default: asc\) |
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
| `cursor` | string | No | For pagination, the marker representing the first item on the next page | | `cursor` | string | No | For pagination, the marker representing the first item on the next page |
#### Output #### Output
@@ -226,14 +198,6 @@ Retrieve all pipelines from Pipedrive
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `pipelines` | array | Array of pipeline objects from Pipedrive | | `pipelines` | array | Array of pipeline objects from Pipedrive |
| ↳ `id` | number | Pipeline ID |
| ↳ `name` | string | Pipeline name |
| ↳ `url_title` | string | URL-friendly title |
| ↳ `order_nr` | number | Pipeline order number |
| ↳ `active` | boolean | Whether the pipeline is active |
| ↳ `deal_probability` | boolean | Whether deal probability is enabled |
| ↳ `add_time` | string | When the pipeline was created |
| ↳ `update_time` | string | When the pipeline was last updated |
| `total_items` | number | Total number of pipelines returned | | `total_items` | number | Total number of pipelines returned |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -245,10 +209,10 @@ Retrieve all deals in a specific pipeline
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `pipeline_id` | string | Yes | The ID of the pipeline \(e.g., "1"\) | | `pipeline_id` | string | Yes | The ID of the pipeline |
| `stage_id` | string | No | Filter by specific stage within the pipeline \(e.g., "2"\) | | `stage_id` | string | No | Filter by specific stage within the pipeline |
| `status` | string | No | Filter by deal status: open, won, lost | | `status` | string | No | Filter by deal status: open, won, lost |
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
#### Output #### Output
@@ -266,9 +230,9 @@ Retrieve all projects or a specific project from Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `project_id` | string | No | Optional: ID of a specific project to retrieve \(e.g., "123"\) | | `project_id` | string | No | Optional: ID of a specific project to retrieve |
| `status` | string | No | Filter by project status: open, completed, deleted \(only for listing all\) | | `status` | string | No | Filter by project status: open, completed, deleted \(only for listing all\) |
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500, only for listing all\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500, only for listing all\) |
#### Output #### Output
@@ -287,10 +251,10 @@ Create a new project in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `title` | string | Yes | The title of the project \(e.g., "Q2 Marketing Campaign"\) | | `title` | string | Yes | The title of the project |
| `description` | string | No | Description of the project | | `description` | string | No | Description of the project |
| `start_date` | string | No | Project start date in YYYY-MM-DD format \(e.g., "2025-04-01"\) | | `start_date` | string | No | Project start date in YYYY-MM-DD format |
| `end_date` | string | No | Project end date in YYYY-MM-DD format \(e.g., "2025-06-30"\) | | `end_date` | string | No | Project end date in YYYY-MM-DD format |
#### Output #### Output
@@ -307,31 +271,18 @@ Retrieve activities (tasks) from Pipedrive with optional filters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `deal_id` | string | No | Filter activities by deal ID \(e.g., "123"\) | | `deal_id` | string | No | Filter activities by deal ID |
| `person_id` | string | No | Filter activities by person ID \(e.g., "456"\) | | `person_id` | string | No | Filter activities by person ID |
| `org_id` | string | No | Filter activities by organization ID \(e.g., "789"\) | | `org_id` | string | No | Filter activities by organization ID |
| `type` | string | No | Filter by activity type \(call, meeting, task, deadline, email, lunch\) | | `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 | | `done` | string | No | Filter by completion status: 0 for not done, 1 for done |
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `activities` | array | Array of activity objects from Pipedrive | | `activities` | array | Array of activity objects from Pipedrive |
| ↳ `id` | number | Activity ID |
| ↳ `subject` | string | Activity subject |
| ↳ `type` | string | Activity type \(call, meeting, task, etc.\) |
| ↳ `due_date` | string | Due date \(YYYY-MM-DD\) |
| ↳ `due_time` | string | Due time \(HH:MM\) |
| ↳ `duration` | string | Duration \(HH:MM\) |
| ↳ `deal_id` | number | Associated deal ID |
| ↳ `person_id` | number | Associated person ID |
| ↳ `org_id` | number | Associated organization ID |
| ↳ `done` | boolean | Whether the activity is done |
| ↳ `note` | string | Activity note |
| ↳ `add_time` | string | When the activity was created |
| ↳ `update_time` | string | When the activity was last updated |
| `total_items` | number | Total number of activities returned | | `total_items` | number | Total number of activities returned |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -343,14 +294,14 @@ Create a new activity (task) in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `subject` | string | Yes | The subject/title of the activity \(e.g., "Follow up call with John"\) | | `subject` | string | Yes | The subject/title of the activity |
| `type` | string | Yes | Activity type: call, meeting, task, deadline, email, lunch | | `type` | string | Yes | Activity type: call, meeting, task, deadline, email, lunch |
| `due_date` | string | Yes | Due date in YYYY-MM-DD format \(e.g., "2025-03-15"\) | | `due_date` | string | Yes | Due date in YYYY-MM-DD format |
| `due_time` | string | No | Due time in HH:MM format \(e.g., "14:30"\) | | `due_time` | string | No | Due time in HH:MM format |
| `duration` | string | No | Duration in HH:MM format \(e.g., "01:00" for 1 hour\) | | `duration` | string | No | Duration in HH:MM format |
| `deal_id` | string | No | ID of the deal to associate with \(e.g., "123"\) | | `deal_id` | string | No | ID of the deal to associate with |
| `person_id` | string | No | ID of the person to associate with \(e.g., "456"\) | | `person_id` | string | No | ID of the person to associate with |
| `org_id` | string | No | ID of the organization to associate with \(e.g., "789"\) | | `org_id` | string | No | ID of the organization to associate with |
| `note` | string | No | Notes for the activity | | `note` | string | No | Notes for the activity |
#### Output #### Output
@@ -368,11 +319,11 @@ Update an existing activity (task) in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `activity_id` | string | Yes | The ID of the activity to update \(e.g., "12345"\) | | `activity_id` | string | Yes | The ID of the activity to update |
| `subject` | string | No | New subject/title for the activity \(e.g., "Updated meeting with client"\) | | `subject` | string | No | New subject/title for the activity |
| `due_date` | string | No | New due date in YYYY-MM-DD format \(e.g., "2025-03-20"\) | | `due_date` | string | No | New due date in YYYY-MM-DD format |
| `due_time` | string | No | New due time in HH:MM format \(e.g., "15:00"\) | | `due_time` | string | No | New due time in HH:MM format |
| `duration` | string | No | New duration in HH:MM format \(e.g., "00:30" for 30 minutes\) | | `duration` | string | No | New duration in HH:MM format |
| `done` | string | No | Mark as done: 0 for not done, 1 for done | | `done` | string | No | Mark as done: 0 for not done, 1 for done |
| `note` | string | No | New notes for the activity | | `note` | string | No | New notes for the activity |
@@ -391,45 +342,19 @@ Retrieve all leads or a specific lead from Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `lead_id` | string | No | Optional: ID of a specific lead to retrieve \(e.g., "abc123-def456-ghi789"\) | | `lead_id` | string | No | Optional: ID of a specific lead to retrieve |
| `archived` | string | No | Get archived leads instead of active ones \(e.g., "true" or "false"\) | | `archived` | string | No | Get archived leads instead of active ones |
| `owner_id` | string | No | Filter by owner user ID \(e.g., "123"\) | | `owner_id` | string | No | Filter by owner user ID |
| `person_id` | string | No | Filter by person ID \(e.g., "456"\) | | `person_id` | string | No | Filter by person ID |
| `organization_id` | string | No | Filter by organization ID \(e.g., "789"\) | | `organization_id` | string | No | Filter by organization ID |
| `limit` | string | No | Number of results to return \(e.g., "50", default: 100, max: 500\) | | `limit` | string | No | Number of results to return \(default: 100, max: 500\) |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `leads` | array | Array of lead objects \(when listing all\) | | `leads` | array | Array of lead objects \(when listing all\) |
| ↳ `id` | string | Lead ID \(UUID\) |
| ↳ `title` | string | Lead title |
| ↳ `person_id` | number | ID of the associated person |
| ↳ `organization_id` | number | ID of the associated organization |
| ↳ `owner_id` | number | ID of the lead owner |
| ↳ `value` | object | Lead value |
| ↳ `amount` | number | Value amount |
| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) |
| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) |
| ↳ `is_archived` | boolean | Whether the lead is archived |
| ↳ `was_seen` | boolean | Whether the lead was seen |
| ↳ `add_time` | string | When the lead was created \(ISO 8601\) |
| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) |
| `lead` | object | Single lead object \(when lead_id is provided\) | | `lead` | object | Single lead object \(when lead_id is provided\) |
| ↳ `id` | string | Lead ID \(UUID\) |
| ↳ `title` | string | Lead title |
| ↳ `person_id` | number | ID of the associated person |
| ↳ `organization_id` | number | ID of the associated organization |
| ↳ `owner_id` | number | ID of the lead owner |
| ↳ `value` | object | Lead value |
| ↳ `amount` | number | Value amount |
| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) |
| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) |
| ↳ `is_archived` | boolean | Whether the lead is archived |
| ↳ `was_seen` | boolean | Whether the lead was seen |
| ↳ `add_time` | string | When the lead was created \(ISO 8601\) |
| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) |
| `total_items` | number | Total number of leads returned | | `total_items` | number | Total number of leads returned |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
@@ -441,13 +366,13 @@ Create a new lead in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `title` | string | Yes | The name of the lead \(e.g., "Acme Corp - Website Redesign"\) | | `title` | string | Yes | The name of the lead |
| `person_id` | string | No | ID of the person \(REQUIRED unless organization_id is provided\) \(e.g., "456"\) | | `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\) \(e.g., "789"\) | | `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 \(e.g., "123"\) | | `owner_id` | string | No | ID of the user who will own the lead |
| `value_amount` | string | No | Potential value amount \(e.g., "10000"\) | | `value_amount` | string | No | Potential value amount |
| `value_currency` | string | No | Currency code \(e.g., "USD", "EUR", "GBP"\) | | `value_currency` | string | No | Currency code \(e.g., USD, EUR\) |
| `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format \(e.g., "2025-04-15"\) | | `expected_close_date` | string | No | Expected close date in YYYY-MM-DD format |
| `visible_to` | string | No | Visibility: 1 \(Owner & followers\), 3 \(Entire company\) | | `visible_to` | string | No | Visibility: 1 \(Owner & followers\), 3 \(Entire company\) |
#### Output #### Output
@@ -465,14 +390,14 @@ Update an existing lead in Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `lead_id` | string | Yes | The ID of the lead to update \(e.g., "abc123-def456-ghi789"\) | | `lead_id` | string | Yes | The ID of the lead to update |
| `title` | string | No | New name for the lead \(e.g., "Updated Lead - Premium Package"\) | | `title` | string | No | New name for the lead |
| `person_id` | string | No | New person ID \(e.g., "456"\) | | `person_id` | string | No | New person ID |
| `organization_id` | string | No | New organization ID \(e.g., "789"\) | | `organization_id` | string | No | New organization ID |
| `owner_id` | string | No | New owner user ID \(e.g., "123"\) | | `owner_id` | string | No | New owner user ID |
| `value_amount` | string | No | New value amount \(e.g., "15000"\) | | `value_amount` | string | No | New value amount |
| `value_currency` | string | No | New currency code \(e.g., "USD", "EUR", "GBP"\) | | `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 \(e.g., "2025-05-01"\) | | `expected_close_date` | string | No | New expected close date in YYYY-MM-DD format |
| `is_archived` | string | No | Archive the lead: true or false | | `is_archived` | string | No | Archive the lead: true or false |
#### Output #### Output
@@ -490,7 +415,7 @@ Delete a specific lead from Pipedrive
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `lead_id` | string | Yes | The ID of the lead to delete \(e.g., "abc123-def456-ghi789"\) | | `lead_id` | string | Yes | The ID of the lead to delete |
#### Output #### Output

View File

@@ -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\) | | `order` | string | No | Sort field \(e.g., volumeNum, liquidityNum, startDate, endDate, createdAt\) |
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) | | `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
| `tagId` | string | No | Filter by tag ID | | `tagId` | string | No | Filter by tag ID |
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | | `limit` | string | No | Number of results per page \(max 50\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | | `offset` | string | No | Pagination offset \(skip this many results\) |
#### Output #### Output
@@ -79,8 +79,8 @@ Retrieve details of a specific prediction market by ID or slug
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `marketId` | string | No | The market ID \(e.g., "0x1234...abcd" condition ID format\). Required if slug is not provided. | | `marketId` | string | No | The market ID. 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. | | `slug` | string | No | The market slug \(e.g., "will-trump-win"\). Required if marketId is not provided. |
#### Output #### 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\) | | `order` | string | No | Sort field \(e.g., volume, liquidity, startDate, endDate, createdAt\) |
| `ascending` | string | No | Sort direction \(true for ascending, false for descending\) | | `ascending` | string | No | Sort direction \(true for ascending, false for descending\) |
| `tagId` | string | No | Filter by tag ID | | `tagId` | string | No | Filter by tag ID |
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | | `limit` | string | No | Number of results per page \(max 50\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | | `offset` | string | No | Pagination offset \(skip this many results\) |
#### Output #### Output
@@ -154,8 +154,8 @@ Retrieve details of a specific event by ID or slug
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `eventId` | string | No | The event ID \(e.g., "12345" or UUID format\). Required if slug is not provided. | | `eventId` | string | No | The event ID. 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. | | `slug` | string | No | The event slug \(e.g., "2024-presidential-election"\). Required if eventId is not provided. |
#### Output #### Output
@@ -189,8 +189,8 @@ Retrieve available tags for filtering markets from Polymarket
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | | `limit` | string | No | Number of results per page \(max 50\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | | `offset` | string | No | Pagination offset \(skip this many results\) |
#### Output #### Output
@@ -211,9 +211,9 @@ Search for markets, events, and profiles on Polymarket
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query term \(e.g., "presidential election", "bitcoin price"\). | | `query` | string | Yes | Search query term |
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | | `limit` | string | No | Number of results per page \(max 50\) |
| `page` | string | No | Page number for pagination \(e.g., "2"\). 1-indexed. | | `page` | string | No | Page number for pagination \(1-indexed\) |
| `cache` | string | No | Enable caching \(true/false\) | | `cache` | string | No | Enable caching \(true/false\) |
| `eventsStatus` | string | No | Filter events by status | | `eventsStatus` | string | No | Filter events by status |
| `limitPerType` | string | No | Limit results per type \(markets, events, profiles\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `limit` | string | No | Number of results per page \(e.g., "25"\). Max: 50. | | `limit` | string | No | Number of results per page \(max 50\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | | `offset` | string | No | Pagination offset \(skip this many results\) |
#### Output #### Output
@@ -276,7 +276,7 @@ Retrieve a specific series (related market group) by ID from Polymarket
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `seriesId` | string | Yes | The series ID \(e.g., "12345" or UUID format\). | | `seriesId` | string | Yes | The series ID |
#### Output #### Output
@@ -309,7 +309,7 @@ Retrieve the order book summary for a specific token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
#### Output #### Output
@@ -323,6 +323,8 @@ Retrieve the order book summary for a specific token
| ↳ `bids` | array | Bid orders | | ↳ `bids` | array | Bid orders |
| ↳ `price` | string | Bid price | | ↳ `price` | string | Bid price |
| ↳ `size` | string | Bid size | | ↳ `size` | string | Bid size |
| ↳ `price` | string | Ask price |
| ↳ `size` | string | Ask size |
| ↳ `asks` | array | Ask orders | | ↳ `asks` | array | Ask orders |
| ↳ `price` | string | Ask price | | ↳ `price` | string | Ask price |
| ↳ `size` | string | Ask size | | ↳ `size` | string | Ask size |
@@ -338,8 +340,8 @@ Retrieve the market price for a specific token and side
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
| `side` | string | Yes | Order side: "buy" or "sell". | | `side` | string | Yes | Order side: buy or sell |
#### Output #### Output
@@ -355,7 +357,7 @@ Retrieve the midpoint price for a specific token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
#### Output #### Output
@@ -371,7 +373,7 @@ Retrieve historical price data for a specific market token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
| `interval` | string | No | Duration ending at current time \(1m, 1h, 6h, 1d, 1w, max\). Mutually exclusive with startTs/endTs. | | `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\) | | `fidelity` | number | No | Data resolution in minutes \(e.g., 60 for hourly\) |
| `startTs` | number | No | Start timestamp \(Unix seconds UTC\) | | `startTs` | number | No | Start timestamp \(Unix seconds UTC\) |
@@ -393,7 +395,7 @@ Retrieve the last trade price for a specific token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
#### Output #### Output
@@ -410,7 +412,7 @@ Retrieve the bid-ask spread for a specific token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
#### Output #### Output
@@ -427,7 +429,7 @@ Retrieve the minimum tick size for a specific token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `tokenId` | string | Yes | The CLOB token ID from market clobTokenIds array \(e.g., "71321045679252212594626385532706912750332728571942532289631379312455583992563"\). | | `tokenId` | string | Yes | The CLOB token ID \(from market clobTokenIds\) |
#### Output #### Output
@@ -444,16 +446,16 @@ Retrieve user positions from Polymarket
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `user` | string | Yes | User wallet address | | `user` | string | Yes | User wallet address |
| `market` | string | No | Condition IDs to filter positions \(e.g., "0x1234...abcd,0x5678...efgh"\). Mutually exclusive with eventId. | | `market` | string | No | Condition IDs to filter positions \(comma-separated, mutually exclusive with eventId\) |
| `eventId` | string | No | Event ID to filter positions \(e.g., "12345"\). Mutually exclusive with market. | | `eventId` | string | No | Event ID to filter positions \(mutually exclusive with market\) |
| `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) | | `sizeThreshold` | string | No | Minimum position size threshold \(default: 1\) |
| `redeemable` | string | No | Filter for redeemable positions only \(true/false\) | | `redeemable` | string | No | Filter for redeemable positions only \(true/false\) |
| `mergeable` | string | No | Filter for mergeable 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\) | | `sortBy` | string | No | Sort field \(TOKENS, CURRENT, INITIAL, CASHPNL, PERCENTPNL, TITLE, RESOLVING, PRICE, AVGPRICE\) |
| `sortDirection` | string | No | Sort direction \(ASC or DESC\) | | `sortDirection` | string | No | Sort direction \(ASC or DESC\) |
| `title` | string | No | Search filter by title | | `title` | string | No | Search filter by title |
| `limit` | string | No | Number of results per page \(e.g., "25"\). | | `limit` | string | No | Number of results per page |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "50"\). | | `offset` | string | No | Pagination offset |
#### Output #### Output
@@ -495,14 +497,14 @@ Retrieve trade history from Polymarket
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `user` | string | No | User wallet address to filter trades | | `user` | string | No | User wallet address to filter trades |
| `market` | string | No | Market/condition ID to filter trades \(e.g., "0x1234...abcd"\). Mutually exclusive with eventId. | | `market` | string | No | Market/condition ID to filter trades \(mutually exclusive with eventId\) |
| `eventId` | string | No | Event ID to filter trades \(e.g., "12345"\). Mutually exclusive with market. | | `eventId` | string | No | Event ID to filter trades \(mutually exclusive with market\) |
| `side` | string | No | Trade direction filter \(BUY or SELL\) | | `side` | string | No | Trade direction filter \(BUY or SELL\) |
| `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) | | `takerOnly` | string | No | Filter for taker trades only \(true/false, default: true\) |
| `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount | | `filterType` | string | No | Filter type \(CASH or TOKENS\) - requires filterAmount |
| `filterAmount` | string | No | Filter amount threshold - requires filterType | | `filterAmount` | string | No | Filter amount threshold - requires filterType |
| `limit` | string | No | Number of results per page \(e.g., "50"\). Default: 100, max: 10000. | | `limit` | string | No | Number of results per page \(default: 100, max: 10000\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "100"\). | | `offset` | string | No | Pagination offset \(skip this many results\) |
#### Output #### Output
@@ -538,10 +540,10 @@ Retrieve on-chain activity for a user including trades, splits, merges, redempti
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `user` | string | Yes | User wallet address \(0x-prefixed\) | | `user` | string | Yes | User wallet address \(0x-prefixed\) |
| `limit` | string | No | Maximum results to return \(e.g., "50"\). Default: 100, max: 500. | | `limit` | string | No | Maximum results \(default: 100, max: 500\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "100"\). Default: 0, max: 10000. | | `offset` | string | No | Pagination offset \(default: 0, max: 10000\) |
| `market` | string | No | Comma-separated condition IDs \(e.g., "0x1234...abcd,0x5678...efgh"\). Mutually exclusive with eventId. | | `market` | string | No | Comma-separated condition IDs \(mutually exclusive with eventId\) |
| `eventId` | string | No | Comma-separated event IDs \(e.g., "12345,67890"\). Mutually exclusive with market. | | `eventId` | string | No | Comma-separated event IDs \(mutually exclusive with market\) |
| `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE | | `type` | string | No | Activity type filter: TRADE, SPLIT, MERGE, REDEEM, REWARD, CONVERSION, MAKER_REBATE |
| `start` | number | No | Start timestamp \(Unix seconds\) | | `start` | number | No | Start timestamp \(Unix seconds\) |
| `end` | number | No | End timestamp \(Unix seconds\) | | `end` | number | No | End timestamp \(Unix seconds\) |
@@ -587,8 +589,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\) | | `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\) | | `timePeriod` | string | No | Time period: DAY, WEEK, MONTH, ALL \(default: DAY\) |
| `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) | | `orderBy` | string | No | Order by: PNL or VOL \(default: PNL\) |
| `limit` | string | No | Number of results to return \(e.g., "10"\). Range: 1-50, default: 25. | | `limit` | string | No | Number of results \(1-50, default: 25\) |
| `offset` | string | No | Number of results to skip for pagination \(e.g., "25"\). Range: 0-1000, default: 0. | | `offset` | string | No | Pagination offset \(0-1000, default: 0\) |
| `user` | string | No | Filter by specific user wallet address | | `user` | string | No | Filter by specific user wallet address |
| `userName` | string | No | Filter by username | | `userName` | string | No | Filter by username |
@@ -614,8 +616,8 @@ Retrieve top holders of a specific market token
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `market` | string | Yes | Comma-separated list of condition IDs \(e.g., "0x1234...abcd" or "0x1234...abcd,0x5678...efgh"\). | | `market` | string | Yes | Comma-separated list of condition IDs |
| `limit` | string | No | Number of holders to return \(e.g., "10"\). Range: 0-20, default: 20. | | `limit` | string | No | Number of holders to return \(0-20, default: 20\) |
| `minBalance` | string | No | Minimum balance threshold \(default: 1\) | | `minBalance` | string | No | Minimum balance threshold \(default: 1\) |
#### Output #### Output
@@ -635,5 +637,15 @@ Retrieve top holders of a specific market token
| ↳ `name` | string | Holder display name | | ↳ `name` | string | Holder display name |
| ↳ `profileImage` | string | Profile image URL | | ↳ `profileImage` | string | Profile image URL |
| ↳ `profileImageOptimized` | string | Optimized profile image URL | | ↳ `profileImageOptimized` | string | Optimized profile image URL |
| ↳ `proxyWallet` | string | Holder wallet address |
| ↳ `bio` | string | Holder bio |
| ↳ `asset` | string | Asset ID |
| ↳ `pseudonym` | string | Holder pseudonym |
| ↳ `amount` | number | Amount held |
| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed |
| ↳ `outcomeIndex` | number | Outcome index |
| ↳ `name` | string | Holder display name |
| ↳ `profileImage` | string | Profile image URL |
| ↳ `profileImageOptimized` | string | Optimized profile image URL |

View File

@@ -179,27 +179,6 @@ Introspect PostgreSQL database schema to retrieve table structures, columns, and
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `tables` | array | Array of table schemas with columns, keys, and indexes | | `tables` | array | Array of table schemas with columns, keys, and indexes |
| ↳ `name` | string | Table name |
| ↳ `schema` | string | Schema name \(e.g., public\) |
| ↳ `columns` | array | Table columns |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Data type \(e.g., integer, varchar, timestamp\) |
| ↳ `nullable` | boolean | Whether the column allows NULL values |
| ↳ `default` | string | Default value expression |
| ↳ `isPrimaryKey` | boolean | Whether the column is part of the primary key |
| ↳ `isForeignKey` | boolean | Whether the column is a foreign key |
| ↳ `references` | object | Foreign key reference information |
| ↳ `table` | string | Referenced table name |
| ↳ `column` | string | Referenced column name |
| ↳ `primaryKey` | array | Primary key column names |
| ↳ `foreignKeys` | array | Foreign key constraints |
| ↳ `column` | string | Local column name |
| ↳ `referencesTable` | string | Referenced table name |
| ↳ `referencesColumn` | string | Referenced column name |
| ↳ `indexes` | array | Table indexes |
| ↳ `name` | string | Index name |
| ↳ `columns` | array | Columns included in the index |
| ↳ `unique` | boolean | Whether the index enforces uniqueness |
| `schemas` | array | List of available schemas in the database | | `schemas` | array | List of available schemas in the database |

View File

@@ -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\) | | `projectApiKey` | string | Yes | PostHog Project API Key \(public token for event ingestion\) |
| `region` | string | No | PostHog region: us \(default\) or eu | | `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"\) | | `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 \(e.g., "user123", email, or device UUID\) | | `distinctId` | string | Yes | Unique identifier for the user or device. Can be user ID, device ID, or anonymous ID |
| `properties` | string | No | JSON string of event properties \(e.g., \{"button_name": "signup", "page": "homepage"\}\) | | `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 | | `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\) | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
| `region` | string | No | PostHog region: us \(default\) or eu | | `region` | string | No | PostHog region: us \(default\) or eu |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `limit` | number | No | Number of persons to return \(default: 100, max: 100\) | | `limit` | number | No | Number of persons to return \(default: 100, max: 100\) |
| `offset` | number | No | Number of persons to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of persons to skip for pagination |
| `search` | string | No | Search persons by email, name, or distinct ID | | `search` | string | No | Search persons by email, name, or distinct ID |
| `distinctId` | string | No | Filter by specific 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\) | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
| `region` | string | No | PostHog region: us \(default\) or eu | | `region` | string | No | PostHog region: us \(default\) or eu |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `personId` | string | Yes | Person ID or UUID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `personId` | string | Yes | Person ID or UUID to retrieve |
#### Output #### 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\) | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
| `region` | string | No | PostHog region: us \(default\) or eu | | `region` | string | No | PostHog region: us \(default\) or eu |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `personId` | string | Yes | Person ID or UUID to delete \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `personId` | string | Yes | Person ID or UUID to delete |
#### Output #### 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\) | | `personalApiKey` | string | Yes | PostHog Personal API Key \(for authenticated API access\) |
| `region` | string | No | PostHog region: us \(default\) or eu | | `region` | string | No | PostHog region: us \(default\) or eu |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `query` | string | Yes | HogQL query to execute. Example: \{"kind": "HogQLQuery", "query": "SELECT event, count\(\) FROM events WHERE timestamp &gt; now\(\) - INTERVAL 1 DAY GROUP BY event"\} | | `query` | string | Yes | HogQL query to execute. Example: \{"kind": "HogQLQuery", "query": "SELECT event, count\(\) FROM events WHERE timestamp &gt; now\(\) - INTERVAL 1 DAY GROUP BY event"\} |
| `Example` | string | No | No description | | `Example` | string | No | No description |
| `values` | string | No | Optional JSON string of parameter values for parameterized queries. Example: \{"user_id": "123"\} | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -219,8 +219,8 @@ Get a specific insight by ID from PostHog. Returns detailed insight configuratio
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `insightId` | string | Yes | The insight ID to retrieve \(e.g., "42" or short ID like "abc123"\) | | `insightId` | string | Yes | The insight ID to retrieve |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
#### Output #### Output
@@ -250,7 +250,7 @@ Create a new insight in PostHog. Requires insight name and configuration filters
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `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\) | | `name` | string | No | Name for the insight \(optional - PostHog will generate a derived name if not provided\) |
| `description` | string | No | Description of the insight | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -318,8 +318,8 @@ Get a specific dashboard by ID from PostHog. Returns detailed dashboard configur
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `dashboardId` | string | Yes | The dashboard ID to retrieve \(e.g., "42"\) | | `dashboardId` | string | Yes | The dashboard ID to retrieve |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
#### Output #### Output
@@ -348,10 +348,10 @@ List all actions in a PostHog project. Returns action definitions, steps, and me
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -383,10 +383,10 @@ List all cohorts in a PostHog project. Returns cohort definitions, filters, and
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -420,8 +420,8 @@ Get a specific cohort by ID from PostHog. Returns detailed cohort definition, fi
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `cohortId` | string | Yes | The cohort ID to retrieve \(e.g., "42"\) | | `cohortId` | string | Yes | The cohort ID to retrieve |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
#### Output #### Output
@@ -453,7 +453,7 @@ Create a new cohort in PostHog. Requires cohort name and filter or query configu
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `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\) | | `name` | string | No | Name for the cohort \(optional - PostHog will use "Untitled cohort" if not provided\) |
| `description` | string | No | Description of the cohort | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -523,7 +523,7 @@ Create a new annotation in PostHog. Mark important events on your graphs with da
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) | | `region` | string | No | PostHog cloud region: "us" or "eu" \(default: "us"\) |
| `content` | string | Yes | Content/text of the annotation | | `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"\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `limit` | number | No | Number of results to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip |
#### Output #### Output
@@ -589,8 +589,8 @@ Get details of a specific feature flag
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `flagId` | string | Yes | The feature flag ID \(e.g., "42"\) | | `flagId` | string | Yes | The feature flag ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
@@ -621,7 +621,7 @@ Create a new feature flag in PostHog
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `name` | string | No | Feature flag name \(optional - can be empty\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `flagId` | string | Yes | The feature flag ID \(e.g., "42"\) | | `flagId` | string | Yes | The feature flag ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `name` | string | No | Feature flag name | | `name` | string | No | Feature flag name |
@@ -692,8 +692,8 @@ Delete a feature flag from PostHog
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `flagId` | string | Yes | The feature flag ID to delete \(e.g., "42"\) | | `flagId` | string | Yes | The feature flag ID to delete |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `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 | | `region` | string | Yes | PostHog cloud region: us or eu |
| `projectApiKey` | string | Yes | PostHog Project API Key \(not personal API key\) | | `projectApiKey` | string | Yes | PostHog Project API Key \(not personal API key\) |
| `distinctId` | string | Yes | The distinct ID of the user to evaluate flags for \(e.g., "user123" or email\) | | `distinctId` | string | Yes | The distinct ID of the user to evaluate flags for |
| `groups` | string | No | Groups as JSON string \(e.g., \{"company": "company_id_in_your_db"\}\) | | `groups` | string | No | Groups as JSON string \(e.g., \{"company": "company_id_in_your_db"\}\) |
| `personProperties` | string | No | Person properties as JSON string | | `personProperties` | string | No | Person properties as JSON string |
| `groupProperties` | string | No | Group 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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `limit` | number | No | Number of results to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip |
#### Output #### Output
@@ -771,8 +771,8 @@ Get details of a specific experiment
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `experimentId` | string | Yes | The experiment ID \(e.g., "42"\) | | `experimentId` | string | Yes | The experiment ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
@@ -805,7 +805,7 @@ Create a new experiment in PostHog
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | The PostHog project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | The PostHog project ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `name` | string | No | Experiment name \(optional\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
| `limit` | number | No | Number of results to return \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -877,8 +877,8 @@ Get details of a specific survey in PostHog by ID.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `surveyId` | string | Yes | Survey ID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `surveyId` | string | Yes | Survey ID to retrieve |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
#### Output #### Output
@@ -909,7 +909,7 @@ Create a new survey in PostHog. Supports question types: Basic (open), Link, Rat
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
| `name` | string | No | Survey name \(optional\) | | `name` | string | No | Survey name \(optional\) |
| `description` | string | No | Survey description | | `description` | string | No | Survey description |
@@ -946,8 +946,8 @@ Update an existing survey in PostHog. Can modify questions, appearance, conditio
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `surveyId` | string | Yes | Survey ID to update \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `surveyId` | string | Yes | Survey ID to update |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
| `name` | string | No | Survey name | | `name` | string | No | Survey name |
| `description` | string | No | Survey description | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
| `limit` | number | No | Number of results to return \(default: 50, e.g., 10, 25, 50\) | | `limit` | number | No | Number of results to return \(default: 50\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 50, 100\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -1023,8 +1023,8 @@ Get details of a specific session recording in PostHog by ID.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `recordingId` | string | Yes | Session recording ID to retrieve \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `recordingId` | string | Yes | Session recording ID to retrieve |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
#### Output #### Output
@@ -1058,10 +1058,10 @@ List session recording playlists in a PostHog project. Playlists allow you to or
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `region` | string | No | PostHog cloud region: us or eu \(default: us\) | | `region` | string | No | PostHog cloud region: us or eu \(default: us\) |
| `limit` | number | No | Number of results to return \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return \(default: 100\) |
| `offset` | number | No | Number of results to skip for pagination \(e.g., 0, 100, 200\) | | `offset` | number | No | Number of results to skip for pagination |
#### Output #### Output
@@ -1091,11 +1091,11 @@ List all event definitions in a PostHog project. Event definitions represent tra
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | The initial index from which to return results \(e.g., 0, 100, 200\) | | `offset` | number | No | The initial index from which to return results |
| `search` | string | No | Search term to filter event definitions by name | | `search` | string | No | Search term to filter event definitions by name |
#### Output #### Output
@@ -1125,7 +1125,7 @@ Get details of a specific event definition in PostHog. Returns comprehensive inf
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `eventDefinitionId` | string | Yes | Event Definition ID to retrieve | | `eventDefinitionId` | string | Yes | Event Definition ID to retrieve |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `eventDefinitionId` | string | Yes | Event Definition ID to update | | `eventDefinitionId` | string | Yes | Event Definition ID to update |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `limit` | number | No | Number of results to return per page \(default: 100, e.g., 10, 50, 100\) | | `limit` | number | No | Number of results to return per page \(default: 100\) |
| `offset` | number | No | The initial index from which to return results \(e.g., 0, 100, 200\) | | `offset` | number | No | The initial index from which to return results |
| `search` | string | No | Search term to filter property definitions by name | | `search` | string | No | Search term to filter property definitions by name |
| `type` | string | No | Filter by property type: event, person, or group | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `propertyDefinitionId` | string | Yes | Property Definition ID to retrieve | | `propertyDefinitionId` | string | Yes | Property Definition ID to retrieve |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | PostHog Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | PostHog Project ID |
| `propertyDefinitionId` | string | Yes | Property Definition ID to update | | `propertyDefinitionId` | string | Yes | Property Definition ID to update |
| `region` | string | Yes | PostHog cloud region: us or eu | | `region` | string | Yes | PostHog cloud region: us or eu |
| `apiKey` | string | Yes | PostHog Personal API Key | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Project ID \(e.g., "12345" or project UUID\) | | `projectId` | string | Yes | Project ID \(numeric ID or UUID\) |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `region` | string | No | Cloud region: us or eu \(default: us\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `organizationId` | string | Yes | Organization ID \(e.g., "01234567-89ab-cdef-0123-456789abcdef"\) | | `organizationId` | string | Yes | Organization ID \(UUID\) |
| `apiKey` | string | Yes | PostHog Personal API Key | | `apiKey` | string | Yes | PostHog Personal API Key |
| `region` | string | No | Cloud region: us or eu \(default: us\) | | `region` | string | No | Cloud region: us or eu \(default: us\) |

View File

@@ -47,19 +47,17 @@ Insert or update points in a Qdrant collection
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) | | `url` | string | Yes | Qdrant base URL |
| `apiKey` | string | No | Qdrant API key for authentication | | `apiKey` | string | No | Qdrant API key \(optional\) |
| `collection` | string | Yes | Collection name for upsert \(e.g., "my_collection"\) | | `collection` | string | Yes | Collection name |
| `points` | array | Yes | Array of points to upsert | | `points` | array | Yes | Array of points to upsert |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `status` | string | Operation status \(ok, error\) | | `status` | string | Status of the upsert operation |
| `data` | object | Result data from the upsert operation | | `data` | object | Result data from the upsert operation |
| ↳ `operation_id` | number | Operation ID for async tracking |
| ↳ `status` | string | Operation status \(acknowledged, completed\) |
### `qdrant_search_vector` ### `qdrant_search_vector`
@@ -69,12 +67,12 @@ Search for similar vectors in a Qdrant collection
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) | | `url` | string | Yes | Qdrant base URL |
| `apiKey` | string | No | Qdrant API key for authentication | | `apiKey` | string | No | Qdrant API key \(optional\) |
| `collection` | string | Yes | Collection name to search \(e.g., "my_collection"\) | | `collection` | string | Yes | Collection name |
| `vector` | array | Yes | Query vector for similarity search \(e.g., \[0.1, 0.2, 0.3, ...\]\) | | `vector` | array | Yes | Vector to search for |
| `limit` | number | No | Maximum number of results to return \(e.g., 10\) | | `limit` | number | No | Number of results to return |
| `filter` | object | No | Qdrant filter object \(e.g., \{"must": \[\{"key": "field", "match": \{"value": "val"\}\}\]\}\) | | `filter` | object | No | Filter to apply to the search |
| `search_return_data` | string | No | Data to return from search | | `search_return_data` | string | No | Data to return from search |
| `with_payload` | boolean | No | Include payload in response | | `with_payload` | boolean | No | Include payload in response |
| `with_vector` | boolean | No | Include vector in response | | `with_vector` | boolean | No | Include vector in response |
@@ -83,15 +81,8 @@ Search for similar vectors in a Qdrant collection
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `status` | string | Operation status \(ok, error\) |
| `data` | array | Vector search results with ID, score, payload, and optional vector data | | `data` | array | Vector search results with ID, score, payload, and optional vector data |
| ↳ `id` | string | Point ID \(integer or UUID string\) | | `status` | string | Status of the search operation |
| ↳ `version` | number | Point version number |
| ↳ `score` | number | Similarity score |
| ↳ `payload` | json | Point payload data \(key-value pairs\) |
| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object |
| ↳ `shard_key` | string | Shard key for routing |
| ↳ `order_value` | number | Order value for sorting |
### `qdrant_fetch_points` ### `qdrant_fetch_points`
@@ -101,10 +92,10 @@ Fetch points by ID from a Qdrant collection
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `url` | string | Yes | Qdrant instance URL \(e.g., https://your-cluster.qdrant.io\) | | `url` | string | Yes | Qdrant base URL |
| `apiKey` | string | No | Qdrant API key for authentication | | `apiKey` | string | No | Qdrant API key \(optional\) |
| `collection` | string | Yes | Collection name to fetch from \(e.g., "my_collection"\) | | `collection` | string | Yes | Collection name |
| `ids` | array | Yes | Array of point IDs to fetch \(e.g., \["id1", "id2"\] or \[1, 2\]\) | | `ids` | array | Yes | Array of point IDs to fetch |
| `fetch_return_data` | string | No | Data to return from fetch | | `fetch_return_data` | string | No | Data to return from fetch |
| `with_payload` | boolean | No | Include payload in response | | `with_payload` | boolean | No | Include payload in response |
| `with_vector` | boolean | No | Include vector in response | | `with_vector` | boolean | No | Include vector in response |
@@ -113,12 +104,7 @@ Fetch points by ID from a Qdrant collection
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `status` | string | Operation status \(ok, error\) |
| `data` | array | Fetched points with ID, payload, and optional vector data | | `data` | array | Fetched points with ID, payload, and optional vector data |
| ↳ `id` | string | Point ID \(integer or UUID string\) | | `status` | string | Status of the fetch operation |
| ↳ `payload` | json | Point payload data \(key-value pairs\) |
| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object |
| ↳ `shard_key` | string | Shard key for routing |
| ↳ `order_value` | number | Order value for sorting |

View File

@@ -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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `database` | string | No | Database name \(optional\) |
| `query` | string | Yes | SQL SELECT query to execute \(e.g., SELECT * FROM users WHERE status = :status\) | | `query` | string | Yes | SQL SELECT query to execute |
#### Output #### 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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `database` | string | No | Database name \(optional\) |
| `table` | string | Yes | Table name to insert into | | `table` | string | Yes | Table name to insert into |
| `data` | object | Yes | Data to insert as key-value pairs | | `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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `database` | string | No | Database name \(optional\) |
| `table` | string | Yes | Table name to update | | `table` | string | Yes | Table name to update |
| `data` | object | Yes | Data to update as key-value pairs | | `data` | object | Yes | Data to update as key-value pairs |
| `conditions` | object | Yes | Conditions for the update \(e.g., \{"id": 1\}\) | | `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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `database` | string | No | Database name \(optional\) |
| `table` | string | Yes | Table name to delete from | | `table` | string | Yes | Table name to delete from |
| `conditions` | object | Yes | Conditions for the delete \(e.g., \{"id": 1\}\) | | `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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `database` | string | No | Database name \(optional\) |
| `query` | string | Yes | Raw SQL query to execute \(e.g., CREATE TABLE users \(id SERIAL PRIMARY KEY, name VARCHAR\(255\)\)\) | | `query` | string | Yes | Raw SQL query to execute |
#### Output #### 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\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `resourceArn` | string | Yes | ARN of the Aurora DB cluster \(e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster\) | | `resourceArn` | string | Yes | ARN of the Aurora DB cluster |
| `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials | | `secretArn` | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
| `database` | string | No | Database name to connect to \(e.g., mydb, production_db\) | | `database` | string | No | Database name \(optional\) |
| `schema` | string | No | Schema to introspect \(default: public for PostgreSQL, database name for MySQL\) | | `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. | | `engine` | string | No | Database engine \(aurora-postgresql or aurora-mysql\). Auto-detected if not provided. |

View File

@@ -38,9 +38,9 @@ Fetch posts from a subreddit with different sorting options
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The subreddit to fetch posts from \(e.g., "technology", "news"\) | | `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) |
| `sort` | string | No | Sort method for posts \(e.g., "hot", "new", "top", "rising"\). Default: "hot" | | `sort` | string | No | Sort method for posts: "hot", "new", "top", or "rising" \(default: "hot"\) |
| `limit` | number | No | Maximum number of posts to return \(e.g., 25\). Default: 10, max: 100 | | `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `time` | string | No | Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" \(default: "day"\) | | `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\) | | `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\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `postId` | string | Yes | The ID of the Reddit post to fetch comments from \(e.g., "abc123"\) | | `postId` | string | Yes | The ID of the Reddit post to fetch comments from |
| `subreddit` | string | Yes | The subreddit where the post is located \(e.g., "technology", "programming"\) | | `subreddit` | string | Yes | The subreddit where the post is located \(without the r/ prefix\) |
| `sort` | string | No | Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" \(default: "confidence"\) | | `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 \(e.g., 25\). Default: 50, max: 100 | | `limit` | number | No | Maximum number of comments to return \(default: 50, max: 100\) |
| `depth` | number | No | Maximum depth of subtrees in the thread \(controls nested comment levels\) | | `depth` | number | No | Maximum depth of subtrees in the thread \(controls nested comment levels\) |
| `context` | number | No | Number of parent comments to include | | `context` | number | No | Number of parent comments to include |
| `showedits` | boolean | No | Show edit information for comments | | `showedits` | boolean | No | Show edit information for comments |
@@ -119,9 +119,9 @@ Fetch controversial posts from a subreddit
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The subreddit to fetch posts from \(e.g., "technology", "news"\) | | `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) |
| `time` | string | No | Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) | | `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 \(e.g., 25\). Default: 10, max: 100 | | `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) | | `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\) | | `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\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The subreddit to search in \(e.g., "technology", "programming"\) | | `subreddit` | string | Yes | The name of the subreddit to search in \(without the r/ prefix\) |
| `query` | string | Yes | Search query text \(e.g., "artificial intelligence", "machine learning tutorial"\) | | `query` | string | Yes | Search query text |
| `sort` | string | No | Sort method for search results \(e.g., "relevance", "hot", "top", "new", "comments"\). Default: "relevance" | | `sort` | string | No | Sort method for search results: "relevance", "hot", "top", "new", or "comments" \(default: "relevance"\) |
| `time` | string | No | Time filter for search results: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) | | `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 \(e.g., 25\). Default: 10, max: 100 | | `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `restrict_sr` | boolean | No | Restrict search to the specified subreddit only \(default: true\) | | `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\) | | `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\) | | `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 | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The subreddit to post to \(e.g., "technology", "programming"\) | | `subreddit` | string | Yes | The name of the subreddit to post to \(without the r/ prefix\) |
| `title` | string | Yes | Title of the submission \(e.g., "Check out this new AI tool"\). Max 300 characters | | `title` | string | Yes | Title of the submission \(max 300 characters\) |
| `text` | string | No | Text content for a self post in markdown format \(e.g., "This is the **body** of my post"\) | | `text` | string | No | Text content for a self post \(markdown supported\) |
| `url` | string | No | URL for a link post \(cannot be used with text\) | | `url` | string | No | URL for a link post \(cannot be used with text\) |
| `nsfw` | boolean | No | Mark post as NSFW | | `nsfw` | boolean | No | Mark post as NSFW |
| `spoiler` | boolean | No | Mark post as spoiler | | `spoiler` | boolean | No | Mark post as spoiler |
@@ -208,10 +208,6 @@ Submit a new post to a subreddit (text or link)
| `success` | boolean | Whether the post was submitted successfully | | `success` | boolean | Whether the post was submitted successfully |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Post data including ID, name, URL, and permalink | | `data` | object | Post data including ID, name, URL, and permalink |
| ↳ `id` | string | New post ID |
| ↳ `name` | string | Thing fullname \(t3_xxxxx\) |
| ↳ `url` | string | Post URL from API response |
| ↳ `permalink` | string | Full Reddit permalink |
### `reddit_vote` ### `reddit_vote`
@@ -221,7 +217,7 @@ Upvote, downvote, or unvote a Reddit post or comment
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Thing fullname to vote on \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `id` | string | Yes | Thing fullname to vote on \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
| `dir` | number | Yes | Vote direction: 1 \(upvote\), 0 \(unvote\), or -1 \(downvote\) | | `dir` | number | Yes | Vote direction: 1 \(upvote\), 0 \(unvote\), or -1 \(downvote\) |
#### Output #### Output
@@ -239,7 +235,7 @@ Save a Reddit post or comment to your saved items
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Thing fullname to save \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `id` | string | Yes | Thing fullname to save \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
| `category` | string | No | Category to save under \(Reddit Gold feature\) | | `category` | string | No | Category to save under \(Reddit Gold feature\) |
#### Output #### Output
@@ -273,8 +269,8 @@ Add a comment reply to a Reddit post or comment
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `parent_id` | string | Yes | Thing fullname to reply to \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `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 \(e.g., "Great post! Here is my **reply**"\) | | `text` | string | Yes | Comment text in markdown format |
#### Output #### Output
@@ -283,10 +279,6 @@ Add a comment reply to a Reddit post or comment
| `success` | boolean | Whether the reply was posted successfully | | `success` | boolean | Whether the reply was posted successfully |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Comment data including ID, name, permalink, and body | | `data` | object | Comment data including ID, name, permalink, and body |
| ↳ `id` | string | New comment ID |
| ↳ `name` | string | Thing fullname \(t1_xxxxx\) |
| ↳ `permalink` | string | Comment permalink |
| ↳ `body` | string | Comment body text |
### `reddit_edit` ### `reddit_edit`
@@ -296,8 +288,8 @@ Edit the text of your own Reddit post or comment
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `thing_id` | string | Yes | Thing fullname to edit \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `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 \(e.g., "Updated **content** here"\) | | `text` | string | Yes | New text content in markdown format |
#### Output #### Output
@@ -306,9 +298,6 @@ Edit the text of your own Reddit post or comment
| `success` | boolean | Whether the edit was successful | | `success` | boolean | Whether the edit was successful |
| `message` | string | Success or error message | | `message` | string | Success or error message |
| `data` | object | Updated content data | | `data` | object | Updated content data |
| ↳ `id` | string | Edited thing ID |
| ↳ `body` | string | Updated comment body \(for comments\) |
| ↳ `selftext` | string | Updated post text \(for self posts\) |
### `reddit_delete` ### `reddit_delete`
@@ -318,7 +307,7 @@ Delete your own Reddit post or comment
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Thing fullname to delete \(e.g., "t3_abc123" for post, "t1_def456" for comment\) | | `id` | string | Yes | Thing fullname to delete \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
#### Output #### Output
@@ -335,7 +324,7 @@ Subscribe or unsubscribe from a subreddit
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The subreddit to subscribe to or unsubscribe from \(e.g., "technology", "programming"\) | | `subreddit` | string | Yes | The name of the subreddit \(without the r/ prefix\) |
| `action` | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe | | `action` | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe |
#### Output #### Output

View File

@@ -41,11 +41,11 @@ Send an email using your own Resend API key and from address
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `fromAddress` | string | Yes | Email address to send from \(e.g., "sender@example.com" or "Sender Name &lt;sender@example.com&gt;"\) | | `fromAddress` | string | Yes | Email address to send from |
| `to` | string | Yes | Recipient email address \(e.g., "recipient@example.com" or "Recipient Name &lt;recipient@example.com&gt;"\) | | `to` | string | Yes | Recipient email address |
| `subject` | string | Yes | Email subject line | | `subject` | string | Yes | Email subject |
| `body` | string | Yes | Email body content \(plain text or HTML based on contentType\) | | `body` | string | Yes | Email body content |
| `contentType` | string | No | Content type for the email body: "text" for plain text or "html" for HTML content | | `contentType` | string | No | Content type for the email body \(text or html\) |
| `resendApiKey` | string | Yes | Resend API key for sending emails | | `resendApiKey` | string | Yes | Resend API key for sending emails |
#### Output #### Output

View File

@@ -46,7 +46,7 @@ Upload a file to an AWS S3 bucket
| `accessKeyId` | string | Yes | Your AWS Access Key ID | | `accessKeyId` | string | Yes | Your AWS Access Key ID |
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `bucketName` | string | Yes | S3 bucket name |
| `objectKey` | string | Yes | Object key/path in S3 \(e.g., folder/filename.ext\) | | `objectKey` | string | Yes | Object key/path in S3 \(e.g., folder/filename.ext\) |
| `file` | file | No | File to upload | | `file` | file | No | File to upload |
| `content` | string | No | Text content to upload \(alternative to file\) | | `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 | | `accessKeyId` | string | Yes | Your AWS Access Key ID |
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
| `s3Uri` | string | Yes | S3 Object URL \(e.g., https://bucket.s3.region.amazonaws.com/path/to/file\) | | `s3Uri` | string | Yes | S3 Object URL |
#### Output #### Output
@@ -91,10 +91,10 @@ List objects in an AWS S3 bucket
| `accessKeyId` | string | Yes | Your AWS Access Key ID | | `accessKeyId` | string | Yes | Your AWS Access Key ID |
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `bucketName` | string | Yes | S3 bucket name |
| `prefix` | string | No | Prefix to filter objects \(e.g., folder/, images/2024/\) | | `prefix` | string | No | Prefix to filter objects \(e.g., folder/\) |
| `maxKeys` | number | No | Maximum number of objects to return \(default: 1000\) | | `maxKeys` | number | No | Maximum number of objects to return \(default: 1000\) |
| `continuationToken` | string | No | Token for pagination from previous list response | | `continuationToken` | string | No | Token for pagination |
#### Output #### Output
@@ -118,8 +118,8 @@ Delete an object from an AWS S3 bucket
| `accessKeyId` | string | Yes | Your AWS Access Key ID | | `accessKeyId` | string | Yes | Your AWS Access Key ID |
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `bucketName` | string | Yes | S3 bucket name \(e.g., my-bucket\) | | `bucketName` | string | Yes | S3 bucket name |
| `objectKey` | string | Yes | Object key/path to delete \(e.g., folder/file.txt\) | | `objectKey` | string | Yes | Object key/path to delete |
#### Output #### Output
@@ -139,10 +139,10 @@ Copy an object within or between AWS S3 buckets
| `accessKeyId` | string | Yes | Your AWS Access Key ID | | `accessKeyId` | string | Yes | Your AWS Access Key ID |
| `secretAccessKey` | string | Yes | Your AWS Secret Access Key | | `secretAccessKey` | string | Yes | Your AWS Secret Access Key |
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `sourceBucket` | string | Yes | Source bucket name \(e.g., my-bucket\) | | `sourceBucket` | string | Yes | Source bucket name |
| `sourceKey` | string | Yes | Source object key/path \(e.g., folder/file.txt\) | | `sourceKey` | string | Yes | Source object key/path |
| `destinationBucket` | string | Yes | Destination bucket name \(e.g., my-other-bucket\) | | `destinationBucket` | string | Yes | Destination bucket name |
| `destinationKey` | string | Yes | Destination object key/path \(e.g., backup/file.txt\) | | `destinationKey` | string | Yes | Destination object key/path |
| `acl` | string | No | Access control list for the copied object \(e.g., private, public-read\) | | `acl` | string | No | Access control list for the copied object \(e.g., private, public-read\) |
#### Output #### Output

View File

@@ -43,9 +43,9 @@ Retrieve accounts from Salesforce CRM
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | The ID token from Salesforce OAuth \(contains instance URL\) | | `idToken` | string | No | The ID token from Salesforce OAuth \(contains instance URL\) |
| `instanceUrl` | string | No | The Salesforce instance URL | | `instanceUrl` | string | No | The Salesforce instance URL |
| `limit` | string | No | Maximum number of results \(default: 100, max: 2000\) | | `limit` | string | No | Number of results to return \(default: 100, max: 2000\) |
| `fields` | string | No | Comma-separated field API names \(e.g., "Id,Name,Industry,Phone"\) | | `fields` | string | No | Comma-separated list of fields to return \(e.g., "Id,Name,Industry,Phone"\) |
| `orderBy` | string | No | Field and direction for sorting \(e.g., "Name ASC" or "CreatedDate DESC"\) | | `orderBy` | string | No | Field to order by \(e.g., "Name ASC" or "CreatedDate DESC"\) |
#### Output #### Output
@@ -53,14 +53,19 @@ Retrieve accounts from Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Accounts data | | `output` | object | Accounts data |
| ↳ `paging` | object | Pagination information from Salesforce API |
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `accounts` | array | Array of account objects | | ↳ `accounts` | array | Array of account objects |
| ↳ `paging` | object | Pagination information |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of accounts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of accounts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_create_account` ### `salesforce_create_account`
@@ -84,8 +89,8 @@ Create a new account in Salesforce CRM
| `billingPostalCode` | string | No | Billing postal code | | `billingPostalCode` | string | No | Billing postal code |
| `billingCountry` | string | No | Billing country | | `billingCountry` | string | No | Billing country |
| `description` | string | No | Account description | | `description` | string | No | Account description |
| `annualRevenue` | string | No | Annual revenue as a number | | `annualRevenue` | string | No | Annual revenue \(number\) |
| `numberOfEmployees` | string | No | Number of employees as an integer | | `numberOfEmployees` | string | No | Number of employees \(number\) |
#### Output #### Output
@@ -93,9 +98,9 @@ Create a new account in Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created account data | | `output` | object | Created account data |
| ↳ `id` | string | The Salesforce ID of the newly created record | | ↳ `id` | string | Created account ID |
| ↳ `success` | boolean | Whether the create operation was successful | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `created` | boolean | Whether the record was created \(always true on success\) | | ↳ `created` | boolean | Whether account was created |
### `salesforce_update_account` ### `salesforce_update_account`
@@ -107,10 +112,10 @@ Update an existing account in Salesforce CRM
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `accountId` | string | Yes | Salesforce Account ID to update \(18-character string starting with 001\) | | `accountId` | string | Yes | Account ID to update \(required\) |
| `name` | string | No | Account name | | `name` | string | No | Account name |
| `type` | string | No | Account type \(e.g., Customer, Partner, Prospect\) | | `type` | string | No | Account type |
| `industry` | string | No | Industry \(e.g., Technology, Healthcare, Finance\) | | `industry` | string | No | Industry |
| `phone` | string | No | Phone number | | `phone` | string | No | Phone number |
| `website` | string | No | Website URL | | `website` | string | No | Website URL |
| `billingStreet` | string | No | Billing street address | | `billingStreet` | string | No | Billing street address |
@@ -119,8 +124,8 @@ Update an existing account in Salesforce CRM
| `billingPostalCode` | string | No | Billing postal code | | `billingPostalCode` | string | No | Billing postal code |
| `billingCountry` | string | No | Billing country | | `billingCountry` | string | No | Billing country |
| `description` | string | No | Account description | | `description` | string | No | Account description |
| `annualRevenue` | string | No | Annual revenue as a number | | `annualRevenue` | string | No | Annual revenue \(number\) |
| `numberOfEmployees` | string | No | Number of employees as an integer | | `numberOfEmployees` | string | No | Number of employees \(number\) |
#### Output #### Output
@@ -128,8 +133,8 @@ Update an existing account in Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated account data | | `output` | object | Updated account data |
| ↳ `id` | string | The Salesforce ID of the updated record | | ↳ `id` | string | Updated account ID |
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | | ↳ `updated` | boolean | Whether account was updated |
### `salesforce_delete_account` ### `salesforce_delete_account`
@@ -141,7 +146,7 @@ Delete an account from Salesforce CRM
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `accountId` | string | Yes | Salesforce Account ID to delete \(18-character string starting with 001\) | | `accountId` | string | Yes | Account ID to delete \(required\) |
#### Output #### Output
@@ -149,8 +154,8 @@ Delete an account from Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Deleted account data | | `output` | object | Deleted account data |
| ↳ `id` | string | The Salesforce ID of the deleted record | | ↳ `id` | string | Deleted account ID |
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | | ↳ `deleted` | boolean | Whether account was deleted |
### `salesforce_get_contacts` ### `salesforce_get_contacts`
@@ -162,10 +167,10 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `contactId` | string | No | Salesforce Contact ID \(18-character string starting with 003\) to get a single contact | | `contactId` | string | No | Contact ID \(if provided, returns single contact\) |
| `limit` | string | No | Maximum number of results \(default: 100, max: 2000\). Only for list query. | | `limit` | string | No | 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"\) | | `fields` | string | No | Comma-separated fields \(e.g., "Id,FirstName,LastName,Email,Phone"\) |
| `orderBy` | string | No | Field and direction for sorting \(e.g., "LastName ASC"\). Only for list query. | | `orderBy` | string | No | Order by field \(e.g., "LastName ASC"\). Only for list query. |
#### Output #### Output
@@ -173,15 +178,20 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Contact\(s\) data | | `output` | object | Contact\(s\) data |
| ↳ `paging` | object | Pagination information from Salesforce API |
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `contacts` | array | Array of contacts \(list query\) | | ↳ `contacts` | array | Array of contacts \(list query\) |
| ↳ `contact` | object | Single contact \(by ID\) | | ↳ `contact` | object | Single contact \(by ID\) |
| ↳ `paging` | object | Pagination information |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of contacts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of contacts returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `singleContact` | boolean | Whether single contact was returned | | ↳ `singleContact` | boolean | Whether single contact was returned |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
@@ -199,7 +209,7 @@ Create a new contact in Salesforce CRM
| `firstName` | string | No | First name | | `firstName` | string | No | First name |
| `email` | string | No | Email address | | `email` | string | No | Email address |
| `phone` | string | No | Phone number | | `phone` | string | No | Phone number |
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `accountId` | string | No | Account ID to associate contact with |
| `title` | string | No | No description | | `title` | string | No | No description |
| `department` | string | No | Department | | `department` | string | No | Department |
| `mailingStreet` | string | No | Mailing street | | `mailingStreet` | string | No | Mailing street |
@@ -215,9 +225,9 @@ Create a new contact in Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created contact data | | `output` | object | Created contact data |
| ↳ `id` | string | The Salesforce ID of the newly created record | | ↳ `id` | string | Created contact ID |
| ↳ `success` | boolean | Whether the create operation was successful | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `created` | boolean | Whether the record was created \(always true on success\) | | ↳ `created` | boolean | Whether contact was created |
### `salesforce_update_contact` ### `salesforce_update_contact`
@@ -229,12 +239,12 @@ Update an existing contact in Salesforce CRM
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `contactId` | string | Yes | Salesforce Contact ID to update \(18-character string starting with 003\) | | `contactId` | string | Yes | Contact ID to update \(required\) |
| `lastName` | string | No | Last name | | `lastName` | string | No | Last name |
| `firstName` | string | No | First name | | `firstName` | string | No | First name |
| `email` | string | No | Email address | | `email` | string | No | Email address |
| `phone` | string | No | Phone number | | `phone` | string | No | Phone number |
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `accountId` | string | No | Account ID to associate with |
| `title` | string | No | No description | | `title` | string | No | No description |
| `department` | string | No | Department | | `department` | string | No | Department |
| `mailingStreet` | string | No | Mailing street | | `mailingStreet` | string | No | Mailing street |
@@ -242,7 +252,7 @@ Update an existing contact in Salesforce CRM
| `mailingState` | string | No | Mailing state | | `mailingState` | string | No | Mailing state |
| `mailingPostalCode` | string | No | Mailing postal code | | `mailingPostalCode` | string | No | Mailing postal code |
| `mailingCountry` | string | No | Mailing country | | `mailingCountry` | string | No | Mailing country |
| `description` | string | No | Contact description | | `description` | string | No | Description |
#### Output #### Output
@@ -250,8 +260,8 @@ Update an existing contact in Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated contact data | | `output` | object | Updated contact data |
| ↳ `id` | string | The Salesforce ID of the updated record | | ↳ `id` | string | Updated contact ID |
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | | ↳ `updated` | boolean | Whether contact was updated |
### `salesforce_delete_contact` ### `salesforce_delete_contact`
@@ -263,7 +273,7 @@ Delete a contact from Salesforce CRM
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `contactId` | string | Yes | Salesforce Contact ID to delete \(18-character string starting with 003\) | | `contactId` | string | Yes | Contact ID to delete \(required\) |
#### Output #### Output
@@ -271,8 +281,8 @@ Delete a contact from Salesforce CRM
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Deleted contact data | | `output` | object | Deleted contact data |
| ↳ `id` | string | The Salesforce ID of the deleted record | | ↳ `id` | string | Deleted contact ID |
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | | ↳ `deleted` | boolean | Whether contact was deleted |
### `salesforce_get_leads` ### `salesforce_get_leads`
@@ -284,10 +294,10 @@ Get lead(s) from Salesforce
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `leadId` | string | No | Salesforce Lead ID \(18-character string starting with 00Q\) to get a single lead | | `leadId` | string | No | Lead ID \(optional\) |
| `limit` | string | No | Maximum number of results to return \(default: 100\) | | `limit` | string | No | Max results \(default: 100\) |
| `fields` | string | No | Comma-separated list of field API names to return | | `fields` | string | No | Comma-separated fields |
| `orderBy` | string | No | Field and direction for sorting \(e.g., LastName ASC\) | | `orderBy` | string | No | Order by field |
#### Output #### Output
@@ -295,15 +305,20 @@ Get lead(s) from Salesforce
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Lead data | | `output` | object | Lead data |
| ↳ `paging` | object | Pagination information from Salesforce API |
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `lead` | object | Single lead object \(when leadId provided\) | | ↳ `lead` | object | Single lead object \(when leadId provided\) |
| ↳ `leads` | array | Array of lead objects \(when listing\) | | ↳ `leads` | array | Array of lead objects \(when listing\) |
| ↳ `paging` | object | Pagination information |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of leads returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of leads returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `singleLead` | boolean | Whether single lead was returned | | ↳ `singleLead` | boolean | Whether single lead was returned |
| ↳ `success` | boolean | Operation success status | | ↳ `success` | boolean | Operation success status |
@@ -318,14 +333,14 @@ Create a new lead
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `lastName` | string | Yes | Last name \(required\) | | `lastName` | string | Yes | Last name \(required\) |
| `company` | string | Yes | Company name \(required\) | | `company` | string | Yes | Company \(required\) |
| `firstName` | string | No | First name | | `firstName` | string | No | First name |
| `email` | string | No | Email address | | `email` | string | No | No description |
| `phone` | string | No | Phone number | | `phone` | string | No | No description |
| `status` | string | No | Lead status \(e.g., Open, Working, Closed\) | | `status` | string | No | Lead status |
| `leadSource` | string | No | Lead source \(e.g., Web, Referral, Campaign\) | | `leadSource` | string | No | Lead source |
| `title` | string | No | No description | | `title` | string | No | No description |
| `description` | string | No | Lead description | | `description` | string | No | Description |
#### Output #### Output
@@ -333,9 +348,9 @@ Create a new lead
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created lead data | | `output` | object | Created lead data |
| ↳ `id` | string | The Salesforce ID of the newly created record | | ↳ `id` | string | Created lead ID |
| ↳ `success` | boolean | Whether the create operation was successful | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `created` | boolean | Whether the record was created \(always true on success\) | | ↳ `created` | boolean | Whether lead was created |
### `salesforce_update_lead` ### `salesforce_update_lead`
@@ -347,16 +362,16 @@ Update an existing lead
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `leadId` | string | Yes | Salesforce Lead ID to update \(18-character string starting with 00Q\) | | `leadId` | string | Yes | Lead ID \(required\) |
| `lastName` | string | No | Last name | | `lastName` | string | No | Last name |
| `company` | string | No | Company name | | `company` | string | No | No description |
| `firstName` | string | No | First name | | `firstName` | string | No | First name |
| `email` | string | No | Email address | | `email` | string | No | No description |
| `phone` | string | No | Phone number | | `phone` | string | No | No description |
| `status` | string | No | Lead status \(e.g., Open, Working, Closed\) | | `status` | string | No | Lead status |
| `leadSource` | string | No | Lead source \(e.g., Web, Referral, Campaign\) | | `leadSource` | string | No | Lead source |
| `title` | string | No | No description | | `title` | string | No | No description |
| `description` | string | No | Lead description | | `description` | string | No | Description |
#### Output #### Output
@@ -364,8 +379,8 @@ Update an existing lead
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated lead data | | `output` | object | Updated lead data |
| ↳ `id` | string | The Salesforce ID of the updated record | | ↳ `id` | string | Updated lead ID |
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | | ↳ `updated` | boolean | Whether lead was updated |
### `salesforce_delete_lead` ### `salesforce_delete_lead`
@@ -377,7 +392,7 @@ Delete a lead
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `leadId` | string | Yes | Salesforce Lead ID to delete \(18-character string starting with 00Q\) | | `leadId` | string | Yes | Lead ID \(required\) |
#### Output #### Output
@@ -385,8 +400,8 @@ Delete a lead
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Deleted lead data | | `output` | object | Deleted lead data |
| ↳ `id` | string | The Salesforce ID of the deleted record | | ↳ `id` | string | Deleted lead ID |
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | | ↳ `deleted` | boolean | Whether lead was deleted |
### `salesforce_get_opportunities` ### `salesforce_get_opportunities`
@@ -398,10 +413,10 @@ Get opportunity(ies) from Salesforce
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `opportunityId` | string | No | Salesforce Opportunity ID \(18-character string starting with 006\) to get a single opportunity | | `opportunityId` | string | No | Opportunity ID \(optional\) |
| `limit` | string | No | Maximum number of results to return \(default: 100\) | | `limit` | string | No | Max results \(default: 100\) |
| `fields` | string | No | Comma-separated list of field API names to return | | `fields` | string | No | Comma-separated fields |
| `orderBy` | string | No | Field and direction for sorting \(e.g., CloseDate DESC\) | | `orderBy` | string | No | Order by field |
#### Output #### Output
@@ -409,15 +424,20 @@ Get opportunity(ies) from Salesforce
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Opportunity data | | `output` | object | Opportunity data |
| ↳ `paging` | object | Pagination information from Salesforce API |
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) | | ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) |
| ↳ `opportunities` | array | Array of opportunity objects \(when listing\) | | ↳ `opportunities` | array | Array of opportunity objects \(when listing\) |
| ↳ `paging` | object | Pagination information |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of opportunities returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of opportunities returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Operation success status | | ↳ `success` | boolean | Operation success status |
### `salesforce_create_opportunity` ### `salesforce_create_opportunity`
@@ -431,12 +451,12 @@ Create a new opportunity
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `name` | string | Yes | Opportunity name \(required\) | | `name` | string | Yes | Opportunity name \(required\) |
| `stageName` | string | Yes | Stage name \(required, e.g., Prospecting, Qualification, Closed Won\) | | `stageName` | string | Yes | Stage name \(required\) |
| `closeDate` | string | Yes | Close date in YYYY-MM-DD format \(required\) | | `closeDate` | string | Yes | Close date YYYY-MM-DD \(required\) |
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `accountId` | string | No | Account ID |
| `amount` | string | No | Deal amount as a number | | `amount` | string | No | Amount \(number\) |
| `probability` | string | No | Win probability as integer \(0-100\) | | `probability` | string | No | Probability \(0-100\) |
| `description` | string | No | Opportunity description | | `description` | string | No | Description |
#### Output #### Output
@@ -444,9 +464,9 @@ Create a new opportunity
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created opportunity data | | `output` | object | Created opportunity data |
| ↳ `id` | string | The Salesforce ID of the newly created record | | ↳ `id` | string | Created opportunity ID |
| ↳ `success` | boolean | Whether the create operation was successful | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `created` | boolean | Whether the record was created \(always true on success\) | | ↳ `created` | boolean | Whether opportunity was created |
### `salesforce_update_opportunity` ### `salesforce_update_opportunity`
@@ -458,14 +478,14 @@ Update an existing opportunity
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `opportunityId` | string | Yes | Salesforce Opportunity ID to update \(18-character string starting with 006\) | | `opportunityId` | string | Yes | Opportunity ID \(required\) |
| `name` | string | No | Opportunity name | | `name` | string | No | Opportunity name |
| `stageName` | string | No | Stage name \(e.g., Prospecting, Qualification, Closed Won\) | | `stageName` | string | No | Stage name |
| `closeDate` | string | No | Close date in YYYY-MM-DD format | | `closeDate` | string | No | Close date YYYY-MM-DD |
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `accountId` | string | No | Account ID |
| `amount` | string | No | Deal amount as a number | | `amount` | string | No | No description |
| `probability` | string | No | Win probability as integer \(0-100\) | | `probability` | string | No | Probability \(0-100\) |
| `description` | string | No | Opportunity description | | `description` | string | No | Description |
#### Output #### Output
@@ -473,8 +493,8 @@ Update an existing opportunity
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated opportunity data | | `output` | object | Updated opportunity data |
| ↳ `id` | string | The Salesforce ID of the updated record | | ↳ `id` | string | Updated opportunity ID |
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | | ↳ `updated` | boolean | Whether opportunity was updated |
### `salesforce_delete_opportunity` ### `salesforce_delete_opportunity`
@@ -486,7 +506,7 @@ Delete an opportunity
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `opportunityId` | string | Yes | Salesforce Opportunity ID to delete \(18-character string starting with 006\) | | `opportunityId` | string | Yes | Opportunity ID \(required\) |
#### Output #### Output
@@ -494,8 +514,8 @@ Delete an opportunity
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Deleted opportunity data | | `output` | object | Deleted opportunity data |
| ↳ `id` | string | The Salesforce ID of the deleted record | | ↳ `id` | string | Deleted opportunity ID |
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | | ↳ `deleted` | boolean | Whether opportunity was deleted |
### `salesforce_get_cases` ### `salesforce_get_cases`
@@ -507,10 +527,10 @@ Get case(s) from Salesforce
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `caseId` | string | No | Salesforce Case ID \(18-character string starting with 500\) to get a single case | | `caseId` | string | No | Case ID \(optional\) |
| `limit` | string | No | Maximum number of results to return \(default: 100\) | | `limit` | string | No | Max results \(default: 100\) |
| `fields` | string | No | Comma-separated list of field API names to return | | `fields` | string | No | Comma-separated fields |
| `orderBy` | string | No | Field and direction for sorting \(e.g., CreatedDate DESC\) | | `orderBy` | string | No | Order by field |
#### Output #### Output
@@ -518,15 +538,20 @@ Get case(s) from Salesforce
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Case data | | `output` | object | Case data |
| ↳ `paging` | object | Pagination information from Salesforce API |
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `case` | object | Single case object \(when caseId provided\) | | ↳ `case` | object | Single case object \(when caseId provided\) |
| ↳ `cases` | array | Array of case objects \(when listing\) | | ↳ `cases` | array | Array of case objects \(when listing\) |
| ↳ `paging` | object | Pagination information |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of cases returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of cases returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Operation success status | | ↳ `success` | boolean | Operation success status |
### `salesforce_create_case` ### `salesforce_create_case`
@@ -543,9 +568,9 @@ Create a new case
| `status` | string | No | Status \(e.g., New, Working, Escalated\) | | `status` | string | No | Status \(e.g., New, Working, Escalated\) |
| `priority` | string | No | Priority \(e.g., Low, Medium, High\) | | `priority` | string | No | Priority \(e.g., Low, Medium, High\) |
| `origin` | string | No | Origin \(e.g., Phone, Email, Web\) | | `origin` | string | No | Origin \(e.g., Phone, Email, Web\) |
| `contactId` | string | No | Salesforce Contact ID \(18-character string starting with 003\) | | `contactId` | string | No | Contact ID |
| `accountId` | string | No | Salesforce Account ID \(18-character string starting with 001\) | | `accountId` | string | No | Account ID |
| `description` | string | No | Case description | | `description` | string | No | Description |
#### Output #### Output
@@ -553,9 +578,9 @@ Create a new case
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created case data | | `output` | object | Created case data |
| ↳ `id` | string | The Salesforce ID of the newly created record | | ↳ `id` | string | Created case ID |
| ↳ `success` | boolean | Whether the create operation was successful | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `created` | boolean | Whether the record was created \(always true on success\) | | ↳ `created` | boolean | Whether case was created |
### `salesforce_update_case` ### `salesforce_update_case`
@@ -567,11 +592,11 @@ Update an existing case
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `caseId` | string | Yes | Salesforce Case ID to update \(18-character string starting with 500\) | | `caseId` | string | Yes | Case ID \(required\) |
| `subject` | string | No | Case subject | | `subject` | string | No | Case subject |
| `status` | string | No | Status \(e.g., New, Working, Escalated, Closed\) | | `status` | string | No | Status |
| `priority` | string | No | Priority \(e.g., Low, Medium, High\) | | `priority` | string | No | Priority |
| `description` | string | No | Case description | | `description` | string | No | Description |
#### Output #### Output
@@ -579,8 +604,8 @@ Update an existing case
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated case data | | `output` | object | Updated case data |
| ↳ `id` | string | The Salesforce ID of the updated record | | ↳ `id` | string | Updated case ID |
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | | ↳ `updated` | boolean | Whether case was updated |
### `salesforce_delete_case` ### `salesforce_delete_case`
@@ -592,7 +617,7 @@ Delete a case
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `caseId` | string | Yes | Salesforce Case ID to delete \(18-character string starting with 500\) | | `caseId` | string | Yes | Case ID \(required\) |
#### Output #### Output
@@ -600,8 +625,8 @@ Delete a case
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Deleted case data | | `output` | object | Deleted case data |
| ↳ `id` | string | The Salesforce ID of the deleted record | | ↳ `id` | string | Deleted case ID |
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | | ↳ `deleted` | boolean | Whether case was deleted |
### `salesforce_get_tasks` ### `salesforce_get_tasks`
@@ -613,10 +638,10 @@ Get task(s) from Salesforce
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `taskId` | string | No | Salesforce Task ID \(18-character string starting with 00T\) to get a single task | | `taskId` | string | No | Task ID \(optional\) |
| `limit` | string | No | Maximum number of results to return \(default: 100\) | | `limit` | string | No | Max results \(default: 100\) |
| `fields` | string | No | Comma-separated list of field API names to return | | `fields` | string | No | Comma-separated fields |
| `orderBy` | string | No | Field and direction for sorting \(e.g., ActivityDate DESC\) | | `orderBy` | string | No | Order by field |
#### Output #### Output
@@ -624,15 +649,20 @@ Get task(s) from Salesforce
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Task data | | `output` | object | Task data |
| ↳ `paging` | object | Pagination information from Salesforce API |
| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) |
| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) |
| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) |
| ↳ `task` | object | Single task object \(when taskId provided\) | | ↳ `task` | object | Single task object \(when taskId provided\) |
| ↳ `tasks` | array | Array of task objects \(when listing\) | | ↳ `tasks` | array | Array of task objects \(when listing\) |
| ↳ `paging` | object | Pagination information |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `nextRecordsUrl` | string | URL for next page of results |
| ↳ `totalSize` | number | Total number of records |
| ↳ `done` | boolean | Whether all records returned |
| ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of tasks returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of tasks returned |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Operation success status | | ↳ `success` | boolean | Operation success status |
### `salesforce_create_task` ### `salesforce_create_task`
@@ -648,10 +678,10 @@ Create a new task
| `subject` | string | Yes | Task subject \(required\) | | `subject` | string | Yes | Task subject \(required\) |
| `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) | | `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) |
| `priority` | string | No | Priority \(e.g., Low, Normal, High\) | | `priority` | string | No | Priority \(e.g., Low, Normal, High\) |
| `activityDate` | string | No | Due date in YYYY-MM-DD format | | `activityDate` | string | No | Due date YYYY-MM-DD |
| `whoId` | string | No | Related Contact ID \(003...\) or Lead ID \(00Q...\) | | `whoId` | string | No | Related Contact/Lead ID |
| `whatId` | string | No | Related Account ID \(001...\) or Opportunity ID \(006...\) | | `whatId` | string | No | Related Account/Opportunity ID |
| `description` | string | No | Task description | | `description` | string | No | Description |
#### Output #### Output
@@ -659,9 +689,9 @@ Create a new task
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Created task data | | `output` | object | Created task data |
| ↳ `id` | string | The Salesforce ID of the newly created record | | ↳ `id` | string | Created task ID |
| ↳ `success` | boolean | Whether the create operation was successful | | ↳ `success` | boolean | Salesforce operation success |
| ↳ `created` | boolean | Whether the record was created \(always true on success\) | | ↳ `created` | boolean | Whether task was created |
### `salesforce_update_task` ### `salesforce_update_task`
@@ -673,12 +703,12 @@ Update an existing task
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `taskId` | string | Yes | Salesforce Task ID to update \(18-character string starting with 00T\) | | `taskId` | string | Yes | Task ID \(required\) |
| `subject` | string | No | Task subject | | `subject` | string | No | Task subject |
| `status` | string | No | Status \(e.g., Not Started, In Progress, Completed\) | | `status` | string | No | Status |
| `priority` | string | No | Priority \(e.g., Low, Normal, High\) | | `priority` | string | No | Priority |
| `activityDate` | string | No | Due date in YYYY-MM-DD format | | `activityDate` | string | No | Due date YYYY-MM-DD |
| `description` | string | No | Task description | | `description` | string | No | Description |
#### Output #### Output
@@ -686,8 +716,8 @@ Update an existing task
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Updated task data | | `output` | object | Updated task data |
| ↳ `id` | string | The Salesforce ID of the updated record | | ↳ `id` | string | Updated task ID |
| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | | ↳ `updated` | boolean | Whether task was updated |
### `salesforce_delete_task` ### `salesforce_delete_task`
@@ -699,7 +729,7 @@ Delete a task
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `taskId` | string | Yes | Salesforce Task ID to delete \(18-character string starting with 00T\) | | `taskId` | string | Yes | Task ID \(required\) |
#### Output #### Output
@@ -707,8 +737,8 @@ Delete a task
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Deleted task data | | `output` | object | Deleted task data |
| ↳ `id` | string | The Salesforce ID of the deleted record | | ↳ `id` | string | Deleted task ID |
| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | | ↳ `deleted` | boolean | Whether task was deleted |
### `salesforce_list_reports` ### `salesforce_list_reports`
@@ -720,8 +750,8 @@ Get a list of reports accessible by the current user
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `folderName` | string | No | Filter reports by folder name \(case-insensitive partial match\) | | `folderName` | string | No | Filter by folder name |
| `searchTerm` | string | No | Search term to filter reports by name or description | | `searchTerm` | string | No | Search term to filter reports by name |
#### Output #### Output
@@ -729,9 +759,9 @@ Get a list of reports accessible by the current user
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Reports data | | `output` | object | Reports data |
| ↳ `totalReturned` | number | Number of items returned |
| ↳ `success` | boolean | Salesforce operation success |
| ↳ `reports` | array | Array of report objects | | ↳ `reports` | array | Array of report objects |
| ↳ `totalReturned` | number | Number of reports returned |
| ↳ `success` | boolean | Salesforce operation success |
### `salesforce_get_report` ### `salesforce_get_report`
@@ -743,7 +773,7 @@ Get metadata and describe information for a specific report
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `reportId` | string | Yes | Salesforce Report ID \(18-character string starting with 00O\) | | `reportId` | string | Yes | Report ID \(required\) |
#### Output #### Output
@@ -765,9 +795,9 @@ Execute a report and retrieve the results
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `reportId` | string | Yes | Salesforce Report ID \(18-character string starting with 00O\) | | `reportId` | string | Yes | Report ID \(required\) |
| `includeDetails` | string | No | Include detail rows \(true/false, default: true\) | | `includeDetails` | string | No | Include detail rows \(true/false, default: true\) |
| `filters` | string | No | JSON array of report filter objects to apply | | `filters` | string | No | JSON string of report filters to apply |
#### Output #### Output
@@ -776,15 +806,15 @@ Execute a report and retrieve the results
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Report results | | `output` | object | Report results |
| ↳ `reportId` | string | Report ID | | ↳ `reportId` | string | Report ID |
| ↳ `reportMetadata` | object | Report metadata including name, format, and filter definitions | | ↳ `reportMetadata` | object | Report metadata |
| ↳ `reportExtendedMetadata` | object | Extended metadata for aggregate columns and groupings | | ↳ `reportExtendedMetadata` | object | Extended metadata |
| ↳ `factMap` | object | Report data organized by groupings with aggregates and row data | | ↳ `factMap` | object | Report data organized by groupings |
| ↳ `groupingsDown` | object | Row grouping hierarchy and values | | ↳ `groupingsDown` | object | Row groupings |
| ↳ `groupingsAcross` | object | Column grouping hierarchy and values | | ↳ `groupingsAcross` | object | Column groupings |
| ↳ `hasDetailRows` | boolean | Whether the report includes detail-level row data | | ↳ `hasDetailRows` | boolean | Whether report has detail rows |
| ↳ `allData` | boolean | Whether all data is returned \(false if truncated due to size limits\) | | ↳ `allData` | boolean | Whether all data is returned |
| ↳ `reportName` | string | Display name of the report | | ↳ `reportName` | string | Report name |
| ↳ `reportFormat` | string | Report format type \(TABULAR, SUMMARY, MATRIX, JOINED\) | | ↳ `reportFormat` | string | Report format type |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_list_report_types` ### `salesforce_list_report_types`
@@ -804,9 +834,9 @@ Get a list of available report types
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Report types data | | `output` | object | Report types data |
| ↳ `totalReturned` | number | Number of items returned |
| ↳ `success` | boolean | Salesforce operation success |
| ↳ `reportTypes` | array | Array of report type objects | | ↳ `reportTypes` | array | Array of report type objects |
| ↳ `totalReturned` | number | Number of report types returned |
| ↳ `success` | boolean | Salesforce operation success |
### `salesforce_list_dashboards` ### `salesforce_list_dashboards`
@@ -818,7 +848,7 @@ Get a list of dashboards accessible by the current user
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `folderName` | string | No | Filter dashboards by folder name \(case-insensitive partial match\) | | `folderName` | string | No | Filter by folder name |
#### Output #### Output
@@ -826,9 +856,9 @@ Get a list of dashboards accessible by the current user
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Dashboards data | | `output` | object | Dashboards data |
| ↳ `totalReturned` | number | Number of items returned |
| ↳ `success` | boolean | Salesforce operation success |
| ↳ `dashboards` | array | Array of dashboard objects | | ↳ `dashboards` | array | Array of dashboard objects |
| ↳ `totalReturned` | number | Number of dashboards returned |
| ↳ `success` | boolean | Salesforce operation success |
### `salesforce_get_dashboard` ### `salesforce_get_dashboard`
@@ -840,7 +870,7 @@ Get details and results for a specific dashboard
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `dashboardId` | string | Yes | Salesforce Dashboard ID \(18-character string starting with 01Z\) | | `dashboardId` | string | Yes | Dashboard ID \(required\) |
#### Output #### Output
@@ -848,12 +878,12 @@ Get details and results for a specific dashboard
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Dashboard data | | `output` | object | Dashboard data |
| ↳ `dashboard` | object | Full dashboard details object | | ↳ `dashboard` | object | Dashboard details |
| ↳ `dashboardId` | string | Dashboard ID | | ↳ `dashboardId` | string | Dashboard ID |
| ↳ `components` | array | Array of dashboard component data with visualizations and filters | | ↳ `components` | array | Dashboard component data |
| ↳ `dashboardName` | string | Display name of the dashboard | | ↳ `dashboardName` | string | Dashboard name |
| ↳ `folderId` | string | ID of the folder containing the dashboard | | ↳ `folderId` | string | Folder ID containing the dashboard |
| ↳ `runningUser` | object | User context under which the dashboard data was retrieved | | ↳ `runningUser` | object | Running user information |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_refresh_dashboard` ### `salesforce_refresh_dashboard`
@@ -866,7 +896,7 @@ Refresh a dashboard to get the latest data
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `dashboardId` | string | Yes | Salesforce Dashboard ID \(18-character string starting with 01Z\) | | `dashboardId` | string | Yes | Dashboard ID \(required\) |
#### Output #### Output
@@ -874,12 +904,12 @@ Refresh a dashboard to get the latest data
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Refreshed dashboard data | | `output` | object | Refreshed dashboard data |
| ↳ `dashboard` | object | Full dashboard details object | | ↳ `dashboard` | object | Dashboard details |
| ↳ `dashboardId` | string | Dashboard ID | | ↳ `dashboardId` | string | Dashboard ID |
| ↳ `components` | array | Array of dashboard component data with fresh visualizations | | ↳ `components` | array | Dashboard component data |
| ↳ `status` | object | Dashboard refresh status information | | ↳ `status` | object | Dashboard status |
| ↳ `dashboardName` | string | Display name of the dashboard | | ↳ `dashboardName` | string | Dashboard name |
| ↳ `refreshDate` | string | ISO 8601 timestamp when the dashboard was last refreshed | | ↳ `refreshDate` | string | Date when dashboard was refreshed |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_query` ### `salesforce_query`
@@ -900,11 +930,16 @@ Execute a custom SOQL query to retrieve data from Salesforce
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Query results | | `output` | object | Query results |
| ↳ `records` | array | Array of sObject records matching the query | | ↳ `records` | array | Array of record objects |
| ↳ `totalSize` | number | Total number of records matching query |
| ↳ `done` | boolean | Whether all records have been returned |
| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records |
| ↳ `query` | string | The executed SOQL query | | ↳ `query` | string | The executed SOQL query |
| ↳ `metadata` | object | Response metadata | | ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response | | ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | | ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_query_more` ### `salesforce_query_more`
@@ -917,7 +952,7 @@ Retrieve additional query results using the nextRecordsUrl from a previous query
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `nextRecordsUrl` | string | Yes | The nextRecordsUrl value from a previous query response \(e.g., /services/data/v59.0/query/01g...\) | | `nextRecordsUrl` | string | Yes | The nextRecordsUrl from a previous query response |
#### Output #### Output
@@ -925,10 +960,15 @@ Retrieve additional query results using the nextRecordsUrl from a previous query
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Query results | | `output` | object | Query results |
| ↳ `records` | array | Array of sObject records matching the query | | ↳ `records` | array | Array of record objects |
| ↳ `totalSize` | number | Total number of records matching query |
| ↳ `done` | boolean | Whether all records have been returned |
| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records |
| ↳ `metadata` | object | Response metadata | | ↳ `metadata` | object | Response metadata |
| ↳ `totalReturned` | number | Number of records returned in this response | | ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | | ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `totalReturned` | number | Number of records returned in this response |
| ↳ `hasMore` | boolean | Whether more records exist |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_describe_object` ### `salesforce_describe_object`
@@ -941,7 +981,7 @@ Get metadata and field information for a Salesforce object
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `idToken` | string | No | No description | | `idToken` | string | No | No description |
| `instanceUrl` | string | No | No description | | `instanceUrl` | string | No | No description |
| `objectName` | string | Yes | Salesforce object API name \(e.g., Account, Contact, Lead, Custom_Object__c\) | | `objectName` | string | Yes | API name of the object \(e.g., Account, Contact, Lead, Custom_Object__c\) |
#### Output #### Output
@@ -949,41 +989,18 @@ Get metadata and field information for a Salesforce object
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Object metadata | | `output` | object | Object metadata |
| ↳ `objectName` | string | API name of the object \(e.g., Account, Contact\) | | ↳ `objectName` | string | API name of the object |
| ↳ `label` | string | Human-readable singular label for the object | | ↳ `label` | string | Display label |
| ↳ `labelPlural` | string | Human-readable plural label for the object | | ↳ `labelPlural` | string | Plural display label |
| ↳ `fields` | array | Array of field metadata objects | | ↳ `fields` | array | Array of field definitions |
| ↳ `name` | string | API name of the field | | ↳ `keyPrefix` | string | ID prefix for this object type |
| ↳ `label` | string | Display label of the field | | ↳ `queryable` | boolean | Whether object can be queried |
| ↳ `type` | string | Field data type \(string, boolean, int, double, date, etc.\) | | ↳ `createable` | boolean | Whether records can be created |
| ↳ `length` | number | Maximum length for text fields | | ↳ `updateable` | boolean | Whether records can be updated |
| ↳ `precision` | number | Precision for numeric fields | | ↳ `deletable` | boolean | Whether records can be deleted |
| ↳ `scale` | number | Scale for numeric fields | | ↳ `childRelationships` | array | Child relationship definitions |
| ↳ `nillable` | boolean | Whether the field can be null | | ↳ `recordTypeInfos` | array | Record type information |
| ↳ `unique` | boolean | Whether values must be unique | | ↳ `fieldCount` | number | Number of fields in the object |
| ↳ `createable` | boolean | Whether field can be set on create |
| ↳ `updateable` | boolean | Whether field can be updated |
| ↳ `defaultedOnCreate` | boolean | Whether field has default value on create |
| ↳ `calculated` | boolean | Whether field is a formula field |
| ↳ `autoNumber` | boolean | Whether field is auto-number |
| ↳ `externalId` | boolean | Whether field is an external ID |
| ↳ `idLookup` | boolean | Whether field can be used in ID lookup |
| ↳ `inlineHelpText` | string | Help text for the field |
| ↳ `picklistValues` | array | Available picklist values for picklist fields |
| ↳ `referenceTo` | array | Objects this field can reference \(for lookup fields\) |
| ↳ `relationshipName` | string | Relationship name for lookup fields |
| ↳ `custom` | boolean | Whether this is a custom field |
| ↳ `filterable` | boolean | Whether field can be used in SOQL filter |
| ↳ `groupable` | boolean | Whether field can be used in GROUP BY |
| ↳ `sortable` | boolean | Whether field can be used in ORDER BY |
| ↳ `keyPrefix` | string | Three-character prefix used in record IDs \(e.g., "001" for Account\) |
| ↳ `queryable` | boolean | Whether the object can be queried via SOQL |
| ↳ `createable` | boolean | Whether records can be created for this object |
| ↳ `updateable` | boolean | Whether records can be updated for this object |
| ↳ `deletable` | boolean | Whether records can be deleted for this object |
| ↳ `childRelationships` | array | Array of child relationship metadata for related objects |
| ↳ `recordTypeInfos` | array | Array of record type information for the object |
| ↳ `fieldCount` | number | Total number of fields on the object |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |
### `salesforce_list_objects` ### `salesforce_list_objects`
@@ -1003,25 +1020,9 @@ Get a list of all available Salesforce objects
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `success` | boolean | Operation success status | | `success` | boolean | Operation success status |
| `output` | object | Objects list | | `output` | object | Objects list |
| ↳ `objects` | array | Array of sObject metadata | | ↳ `objects` | array | Array of available Salesforce objects |
| ↳ `name` | string | API name of the object | | ↳ `encoding` | string | Encoding used |
| ↳ `label` | string | Display label of the object | | ↳ `maxBatchSize` | number | Maximum batch size |
| ↳ `labelPlural` | string | Plural display label |
| ↳ `keyPrefix` | string | Three-character ID prefix |
| ↳ `custom` | boolean | Whether this is a custom object |
| ↳ `queryable` | boolean | Whether object can be queried |
| ↳ `createable` | boolean | Whether records can be created |
| ↳ `updateable` | boolean | Whether records can be updated |
| ↳ `deletable` | boolean | Whether records can be deleted |
| ↳ `searchable` | boolean | Whether object is searchable |
| ↳ `triggerable` | boolean | Whether triggers are supported |
| ↳ `layoutable` | boolean | Whether page layouts are supported |
| ↳ `replicateable` | boolean | Whether object can be replicated |
| ↳ `retrieveable` | boolean | Whether records can be retrieved |
| ↳ `undeletable` | boolean | Whether records can be undeleted |
| ↳ `urls` | object | URLs for accessing object resources |
| ↳ `encoding` | string | Character encoding for the organization \(e.g., UTF-8\) |
| ↳ `maxBatchSize` | number | Maximum number of records that can be returned in a single query batch \(typically 200\) |
| ↳ `totalReturned` | number | Number of objects returned | | ↳ `totalReturned` | number | Number of objects returned |
| ↳ `success` | boolean | Salesforce operation success | | ↳ `success` | boolean | Salesforce operation success |

View File

@@ -62,7 +62,7 @@ Send an email using SendGrid API
| `bcc` | string | No | BCC email address | | `bcc` | string | No | BCC email address |
| `replyTo` | string | No | Reply-to email address | | `replyTo` | string | No | Reply-to email address |
| `replyToName` | string | No | Reply-to name | | `replyToName` | string | No | Reply-to name |
| `attachments` | file[] | No | Files to attach to the email as an array of attachment objects | | `attachments` | file[] | No | Files to attach to the email |
| `templateId` | string | No | SendGrid template ID to use | | `templateId` | string | No | SendGrid template ID to use |
| `dynamicTemplateData` | json | No | JSON object of dynamic template data | | `dynamicTemplateData` | json | No | JSON object of dynamic template data |

View File

@@ -54,8 +54,8 @@ List issues from Sentry for a specific organization and optionally a specific pr
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `projectSlug` | string | No | Filter issues by specific project slug \(e.g., "my-project"\) | | `projectSlug` | string | No | Filter issues by specific project slug \(optional\) |
| `query` | string | No | Search query to filter issues. Supports Sentry search syntax \(e.g., "is:unresolved", "level:error"\) | | `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. | | `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 | | `cursor` | string | No | Pagination cursor for retrieving next page of results |
@@ -68,7 +68,7 @@ List issues from Sentry for a specific organization and optionally a specific pr
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issues` | array | List of Sentry issues | | `issues` | array | List of Sentry issues |
| ↳ `id` | string | Unique issue ID | | ↳ `id` | string | User ID |
| ↳ `shortId` | string | Short issue identifier | | ↳ `shortId` | string | Short issue identifier |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `culprit` | string | Function or location that caused the issue | | ↳ `culprit` | string | Function or location that caused the issue |
@@ -78,22 +78,27 @@ List issues from Sentry for a specific organization and optionally a specific pr
| ↳ `status` | string | Current issue status | | ↳ `status` | string | Current issue status |
| ↳ `statusDetails` | object | Additional details about the status | | ↳ `statusDetails` | object | Additional details about the status |
| ↳ `isPublic` | boolean | Whether the issue is publicly visible | | ↳ `isPublic` | boolean | Whether the issue is publicly visible |
| ↳ `platform` | string | Platform where the issue occurred | | ↳ `platform` | string | Project platform |
| ↳ `project` | object | Project information | | ↳ `project` | object | Project information |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `slug` | string | Project slug | | ↳ `slug` | string | Project slug |
| ↳ `platform` | string | Project platform | | ↳ `platform` | string | Project platform |
| ↳ `type` | string | Issue type | | ↳ `name` | string | User name |
| ↳ `slug` | string | Project slug |
| ↳ `type` | string | Type of error \(e.g., TypeError\) |
| ↳ `metadata` | object | Error metadata | | ↳ `metadata` | object | Error metadata |
| ↳ `type` | string | Type of error \(e.g., TypeError\) | | ↳ `type` | string | Type of error \(e.g., TypeError\) |
| ↳ `value` | string | Error message or value | | ↳ `value` | string | Error message or value |
| ↳ `function` | string | Function where the error occurred | | ↳ `function` | string | Function where the error occurred |
| ↳ `value` | string | Error message or value |
| ↳ `function` | string | Function where the error occurred |
| ↳ `numComments` | number | Number of comments on the issue | | ↳ `numComments` | number | Number of comments on the issue |
| ↳ `assignedTo` | object | User assigned to the issue | | ↳ `assignedTo` | object | User assigned to the issue |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `email` | string | User email |
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | | ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
| ↳ `isSubscribed` | boolean | Whether subscribed to updates | | ↳ `isSubscribed` | boolean | Whether subscribed to updates |
| ↳ `hasSeen` | boolean | Whether the user has seen this issue | | ↳ `hasSeen` | boolean | Whether the user has seen this issue |
@@ -117,15 +122,15 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `issueId` | string | Yes | The unique ID of the issue to retrieve \(e.g., "12345"\) | | `issueId` | string | Yes | The unique ID of the issue to retrieve |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issue` | object | Detailed information about the Sentry issue | | `issue` | object | Detailed information about the Sentry issue |
| ↳ `id` | string | Unique issue ID | | ↳ `id` | string | User ID |
| ↳ `shortId` | string | Short issue identifier | | ↳ `shortId` | string | Short issue identifier |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `culprit` | string | Function or location that caused the issue | | ↳ `culprit` | string | Function or location that caused the issue |
@@ -135,22 +140,27 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c
| ↳ `status` | string | Current issue status | | ↳ `status` | string | Current issue status |
| ↳ `statusDetails` | object | Additional details about the status | | ↳ `statusDetails` | object | Additional details about the status |
| ↳ `isPublic` | boolean | Whether the issue is publicly visible | | ↳ `isPublic` | boolean | Whether the issue is publicly visible |
| ↳ `platform` | string | Platform where the issue occurred | | ↳ `platform` | string | Project platform |
| ↳ `project` | object | Project information | | ↳ `project` | object | Project information |
| ↳ `id` | string | Project ID | | ↳ `id` | string | Project ID |
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `slug` | string | Project slug | | ↳ `slug` | string | Project slug |
| ↳ `platform` | string | Project platform | | ↳ `platform` | string | Project platform |
| ↳ `type` | string | Issue type | | ↳ `name` | string | User name |
| ↳ `slug` | string | Project slug |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
| ↳ `metadata` | object | Error metadata | | ↳ `metadata` | object | Error metadata |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | | ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
| ↳ `value` | string | Error message or value | | ↳ `value` | string | Error message or value |
| ↳ `function` | string | Function where the error occurred | | ↳ `function` | string | Function where the error occurred |
| ↳ `value` | string | Error message or value |
| ↳ `function` | string | Function where the error occurred |
| ↳ `numComments` | number | Number of comments on the issue | | ↳ `numComments` | number | Number of comments on the issue |
| ↳ `assignedTo` | object | User assigned to the issue \(if any\) | | ↳ `assignedTo` | object | User assigned to the issue \(if any\) |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `email` | string | User email |
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | | ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | | ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
| ↳ `hasSeen` | boolean | Whether the user has seen this issue | | ↳ `hasSeen` | boolean | Whether the user has seen this issue |
@@ -171,8 +181,8 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `issueId` | string | Yes | The unique ID of the issue to update \(e.g., "12345"\) | | `issueId` | string | Yes | The unique ID of the issue to update |
| `status` | string | No | New status for the issue: resolved, unresolved, ignored, or resolvedInNextRelease | | `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. | | `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 | | `isBookmarked` | boolean | No | Whether to bookmark the issue |
@@ -184,7 +194,7 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `issue` | object | The updated Sentry issue | | `issue` | object | The updated Sentry issue |
| ↳ `id` | string | Unique issue ID | | ↳ `id` | string | User ID |
| ↳ `shortId` | string | Short issue identifier | | ↳ `shortId` | string | Short issue identifier |
| ↳ `title` | string | Issue title | | ↳ `title` | string | Issue title |
| ↳ `status` | string | Updated issue status | | ↳ `status` | string | Updated issue status |
@@ -192,6 +202,8 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | User name |
| ↳ `email` | string | User email |
| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | | ↳ `isBookmarked` | boolean | Whether the issue is bookmarked |
| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | | ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates |
| ↳ `isPublic` | boolean | Whether the issue is publicly visible | | ↳ `isPublic` | boolean | Whether the issue is publicly visible |
@@ -206,7 +218,7 @@ List all projects in a Sentry organization. Returns project details including na
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `cursor` | string | No | Pagination cursor for retrieving next page of results | | `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\) | | `limit` | number | No | Number of projects to return per page \(default: 25, max: 100\) |
@@ -215,9 +227,9 @@ List all projects in a Sentry organization. Returns project details including na
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `projects` | array | List of Sentry projects | | `projects` | array | List of Sentry projects |
| ↳ `id` | string | Unique project ID | | ↳ `id` | string | Team ID |
| ↳ `slug` | string | URL-friendly project identifier | | ↳ `slug` | string | Team slug |
| ↳ `name` | string | Project name | | ↳ `name` | string | Team name |
| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) | | ↳ `platform` | string | Platform/language \(e.g., javascript, python\) |
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | | ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | | ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
@@ -246,17 +258,17 @@ Retrieve detailed information about a specific Sentry project by its slug. Retur
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `projectSlug` | string | Yes | The slug of the project to retrieve \(e.g., "my-project"\) | | `projectSlug` | string | Yes | The ID or slug of the project to retrieve |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | Detailed information about the Sentry project | | `project` | object | Detailed information about the Sentry project |
| ↳ `id` | string | Unique project ID | | ↳ `id` | string | Team ID |
| ↳ `slug` | string | URL-friendly project identifier | | ↳ `slug` | string | Team slug |
| ↳ `name` | string | Project name | | ↳ `name` | string | Team name |
| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) | | ↳ `platform` | string | Platform/language \(e.g., javascript, python\) |
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | | ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | | ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
@@ -297,7 +309,7 @@ Create a new Sentry project in an organization. Requires a team to associate the
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `name` | string | Yes | The name of the project | | `name` | string | Yes | The name of the project |
| `teamSlug` | string | Yes | The slug of the team that will own this 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\) | | `slug` | string | No | URL-friendly project identifier \(auto-generated from name if not provided\) |
@@ -309,9 +321,9 @@ Create a new Sentry project in an organization. Requires a team to associate the
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | The newly created Sentry project | | `project` | object | The newly created Sentry project |
| ↳ `id` | string | Unique project ID | | ↳ `id` | string | Team ID |
| ↳ `slug` | string | URL-friendly project identifier | | ↳ `slug` | string | Team slug |
| ↳ `name` | string | Project name | | ↳ `name` | string | Team name |
| ↳ `platform` | string | Platform/language | | ↳ `platform` | string | Platform/language |
| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | | ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) |
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | | ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
@@ -344,8 +356,8 @@ Update a Sentry project by changing its name, slug, platform, or other settings.
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `projectSlug` | string | Yes | The slug of the project to update \(e.g., "my-project"\) | | `projectSlug` | string | Yes | The slug of the project to update |
| `name` | string | No | New name for the project | | `name` | string | No | New name for the project |
| `slug` | string | No | New URL-friendly project identifier | | `slug` | string | No | New URL-friendly project identifier |
| `platform` | string | No | New platform/language for the project \(e.g., javascript, python, node\) | | `platform` | string | No | New platform/language for the project \(e.g., javascript, python, node\) |
@@ -358,9 +370,9 @@ Update a Sentry project by changing its name, slug, platform, or other settings.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `project` | object | The updated Sentry project | | `project` | object | The updated Sentry project |
| ↳ `id` | string | Unique project ID | | ↳ `id` | string | Team ID |
| ↳ `slug` | string | URL-friendly project identifier | | ↳ `slug` | string | Team slug |
| ↳ `name` | string | Project name | | ↳ `name` | string | Team name |
| ↳ `platform` | string | Platform/language | | ↳ `platform` | string | Platform/language |
| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | | ↳ `isBookmarked` | boolean | Whether the project is bookmarked |
| ↳ `organization` | object | Organization information | | ↳ `organization` | object | Organization information |
@@ -381,9 +393,9 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `projectSlug` | string | Yes | The slug of the project to list events from \(e.g., "my-project"\) | | `projectSlug` | string | Yes | The slug of the project to list events from |
| `issueId` | string | No | Filter events by a specific issue ID \(e.g., "12345"\) | | `issueId` | string | No | Filter events by a specific issue ID |
| `query` | string | No | Search query to filter events. Supports Sentry search syntax \(e.g., "user.email:*@example.com"\) | | `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 | | `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\) | | `limit` | number | No | Number of events to return per page \(default: 50, max: 100\) |
@@ -394,7 +406,7 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `events` | array | List of Sentry events | | `events` | array | List of Sentry events |
| ↳ `id` | string | Unique event ID | | ↳ `id` | string | User ID |
| ↳ `eventID` | string | Event identifier | | ↳ `eventID` | string | Event identifier |
| ↳ `projectID` | string | Project ID | | ↳ `projectID` | string | Project ID |
| ↳ `groupID` | string | Issue group ID | | ↳ `groupID` | string | Issue group ID |
@@ -410,16 +422,23 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
| ↳ `username` | string | Username | | ↳ `username` | string | Username |
| ↳ `ipAddress` | string | IP address | | ↳ `ipAddress` | string | IP address |
| ↳ `name` | string | User display name | | ↳ `name` | string | User display name |
| ↳ `email` | string | User email |
| ↳ `username` | string | Username |
| ↳ `ipAddress` | string | IP address |
| ↳ `name` | string | SDK name |
| ↳ `tags` | array | Tags associated with the event | | ↳ `tags` | array | Tags associated with the event |
| ↳ `key` | string | Tag key | | ↳ `key` | string | Tag key |
| ↳ `value` | string | Tag value | | ↳ `value` | string | Tag value |
| ↳ `key` | string | Tag key |
| ↳ `value` | string | Error message or value |
| ↳ `contexts` | object | Additional context data \(device, OS, etc.\) | | ↳ `contexts` | object | Additional context data \(device, OS, etc.\) |
| ↳ `platform` | string | Platform where the event occurred | | ↳ `platform` | string | Platform where the event occurred |
| ↳ `type` | string | Event type | | ↳ `type` | string | Type of error \(e.g., TypeError\) |
| ↳ `metadata` | object | Error metadata | | ↳ `metadata` | object | Error metadata |
| ↳ `type` | string | Type of error \(e.g., TypeError\) | | ↳ `type` | string | Type of error \(e.g., TypeError\) |
| ↳ `value` | string | Error message or value | | ↳ `value` | string | Error message or value |
| ↳ `function` | string | Function where the error occurred | | ↳ `function` | string | Function where the error occurred |
| ↳ `function` | string | Function where the error occurred |
| ↳ `entries` | array | Event entries \(exception, breadcrumbs, etc.\) | | ↳ `entries` | array | Event entries \(exception, breadcrumbs, etc.\) |
| ↳ `errors` | array | Processing errors | | ↳ `errors` | array | Processing errors |
| ↳ `dist` | string | Distribution identifier | | ↳ `dist` | string | Distribution identifier |
@@ -427,6 +446,7 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p
| ↳ `sdk` | object | SDK information | | ↳ `sdk` | object | SDK information |
| ↳ `name` | string | SDK name | | ↳ `name` | string | SDK name |
| ↳ `version` | string | SDK version | | ↳ `version` | string | SDK version |
| ↳ `version` | string | SDK version |
| `metadata` | object | Pagination metadata | | `metadata` | object | Pagination metadata |
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | | ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
| ↳ `hasMore` | boolean | Whether there are more results available | | ↳ `hasMore` | boolean | Whether there are more results available |
@@ -440,16 +460,16 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `projectSlug` | string | Yes | The slug of the project \(e.g., "my-project"\) | | `projectSlug` | string | Yes | The slug of the project |
| `eventId` | string | Yes | The unique ID of the event to retrieve \(e.g., "abc123def456"\) | | `eventId` | string | Yes | The unique ID of the event to retrieve |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `event` | object | Detailed information about the Sentry event | | `event` | object | Detailed information about the Sentry event |
| ↳ `id` | string | Unique event ID | | ↳ `id` | string | User ID |
| ↳ `eventID` | string | Event identifier | | ↳ `eventID` | string | Event identifier |
| ↳ `projectID` | string | Project ID | | ↳ `projectID` | string | Project ID |
| ↳ `groupID` | string | Issue group ID this event belongs to | | ↳ `groupID` | string | Issue group ID this event belongs to |
@@ -465,16 +485,23 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
| ↳ `username` | string | Username | | ↳ `username` | string | Username |
| ↳ `ipAddress` | string | IP address | | ↳ `ipAddress` | string | IP address |
| ↳ `name` | string | User display name | | ↳ `name` | string | User display name |
| ↳ `email` | string | User email |
| ↳ `username` | string | Username |
| ↳ `ipAddress` | string | IP address |
| ↳ `name` | string | SDK name |
| ↳ `tags` | array | Tags associated with the event | | ↳ `tags` | array | Tags associated with the event |
| ↳ `key` | string | Tag key | | ↳ `key` | string | Tag key |
| ↳ `value` | string | Tag value | | ↳ `value` | string | Tag value |
| ↳ `key` | string | Tag key |
| ↳ `value` | string | Error message or value |
| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) | | ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) |
| ↳ `platform` | string | Platform where the event occurred | | ↳ `platform` | string | Platform where the event occurred |
| ↳ `type` | string | Event type \(error, transaction, etc.\) | | ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
| ↳ `metadata` | object | Error metadata | | ↳ `metadata` | object | Error metadata |
| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | | ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) |
| ↳ `value` | string | Error message or value | | ↳ `value` | string | Error message or value |
| ↳ `function` | string | Function where the error occurred | | ↳ `function` | string | Function where the error occurred |
| ↳ `function` | string | Function where the error occurred |
| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data | | ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data |
| ↳ `errors` | array | Processing errors that occurred | | ↳ `errors` | array | Processing errors that occurred |
| ↳ `dist` | string | Distribution identifier | | ↳ `dist` | string | Distribution identifier |
@@ -482,6 +509,7 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c
| ↳ `sdk` | object | SDK information | | ↳ `sdk` | object | SDK information |
| ↳ `name` | string | SDK name | | ↳ `name` | string | SDK name |
| ↳ `version` | string | SDK version | | ↳ `version` | string | SDK version |
| ↳ `version` | string | SDK version |
### `sentry_releases_list` ### `sentry_releases_list`
@@ -492,9 +520,9 @@ List releases for a Sentry organization or project. Returns release details incl
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `projectSlug` | string | No | Filter releases by specific project slug \(e.g., "my-project"\) | | `projectSlug` | string | No | Filter releases by specific project slug \(optional\) |
| `query` | string | No | Search query to filter releases \(e.g., "1.0" to match version patterns\) | | `query` | string | No | Search query to filter releases \(e.g., version name pattern\) |
| `cursor` | string | No | Pagination cursor for retrieving next page of results | | `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\) | | `limit` | number | No | Number of releases to return per page \(default: 25, max: 100\) |
@@ -503,30 +531,36 @@ List releases for a Sentry organization or project. Returns release details incl
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `releases` | array | List of Sentry releases | | `releases` | array | List of Sentry releases |
| ↳ `id` | string | Unique release ID | | ↳ `id` | string | Project ID |
| ↳ `version` | string | Release version identifier | | ↳ `version` | object | Version details |
| ↳ `raw` | string | Raw version string |
| ↳ `shortVersion` | string | Shortened version identifier | | ↳ `shortVersion` | string | Shortened version identifier |
| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) | | ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) |
| ↳ `url` | string | URL to the release \(e.g., GitHub release page\) | | ↳ `url` | string | URL to the release \(e.g., GitHub release page\) |
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) | | ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) | | ↳ `dateCreated` | string | Commit timestamp |
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) | | ↳ `dateStarted` | string | Deploy start timestamp |
| ↳ `newGroups` | number | Number of new issues introduced in this release | | ↳ `newGroups` | number | Number of new issues introduced in this release |
| ↳ `owner` | object | Owner of the release | | ↳ `owner` | object | Owner of the release |
| ↳ `id` | string | User ID | | ↳ `id` | string | User ID |
| ↳ `name` | string | User name | | ↳ `name` | string | User name |
| ↳ `email` | string | User email | | ↳ `email` | string | User email |
| ↳ `name` | string | Project name |
| ↳ `email` | string | Author email |
| ↳ `commitCount` | number | Number of commits in this release | | ↳ `commitCount` | number | Number of commits in this release |
| ↳ `deployCount` | number | Number of deploys for this release | | ↳ `deployCount` | number | Number of deploys for this release |
| ↳ `lastCommit` | object | Last commit in the release | | ↳ `lastCommit` | object | Last commit in the release |
| ↳ `id` | string | Commit SHA | | ↳ `id` | string | Commit SHA |
| ↳ `message` | string | Commit message | | ↳ `message` | string | Commit message |
| ↳ `dateCreated` | string | Commit timestamp | | ↳ `dateCreated` | string | Commit timestamp |
| ↳ `message` | string | Commit message |
| ↳ `lastDeploy` | object | Last deploy of the release | | ↳ `lastDeploy` | object | Last deploy of the release |
| ↳ `id` | string | Deploy ID | | ↳ `id` | string | Deploy ID |
| ↳ `environment` | string | Deploy environment | | ↳ `environment` | string | Deploy environment |
| ↳ `dateStarted` | string | Deploy start timestamp | | ↳ `dateStarted` | string | Deploy start timestamp |
| ↳ `dateFinished` | string | Deploy finish timestamp | | ↳ `dateFinished` | string | Deploy finish timestamp |
| ↳ `environment` | string | Deploy environment |
| ↳ `dateFinished` | string | Deploy finish timestamp |
| ↳ `authors` | array | Authors of commits in the release | | ↳ `authors` | array | Authors of commits in the release |
| ↳ `id` | string | Author ID | | ↳ `id` | string | Author ID |
| ↳ `name` | string | Author name | | ↳ `name` | string | Author name |
@@ -536,12 +570,18 @@ List releases for a Sentry organization or project. Returns release details incl
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `slug` | string | Project slug | | ↳ `slug` | string | Project slug |
| ↳ `platform` | string | Project platform | | ↳ `platform` | string | Project platform |
| ↳ `slug` | string | Project slug |
| ↳ `platform` | string | Project platform |
| ↳ `firstEvent` | string | First event timestamp | | ↳ `firstEvent` | string | First event timestamp |
| ↳ `lastEvent` | string | Last event timestamp | | ↳ `lastEvent` | string | Last event timestamp |
| ↳ `versionInfo` | object | Version metadata | | ↳ `versionInfo` | object | Version metadata |
| ↳ `buildHash` | string | Build hash | | ↳ `buildHash` | string | Build hash |
| ↳ `version` | object | Version details | | ↳ `version` | object | Version details |
| ↳ `raw` | string | Raw version string | | ↳ `raw` | string | Raw version string |
| ↳ `raw` | string | Raw version string |
| ↳ `package` | string | Package name |
| ↳ `buildHash` | string | Build hash |
| ↳ `raw` | string | Raw version string |
| ↳ `package` | string | Package name | | ↳ `package` | string | Package name |
| `metadata` | object | Pagination metadata | | `metadata` | object | Pagination metadata |
| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | | ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) |
@@ -556,7 +596,7 @@ Create a new release in Sentry. A release is a version of your code deployed to
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `version` | string | Yes | Version identifier for the release \(e.g., "2.0.0", "my-app@1.0.0", or a git commit SHA\) | | `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 | | `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 | | `ref` | string | No | Git reference \(commit SHA, tag, or branch\) for this release |
@@ -569,14 +609,15 @@ Create a new release in Sentry. A release is a version of your code deployed to
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `release` | object | The newly created Sentry release | | `release` | object | The newly created Sentry release |
| ↳ `id` | string | Unique release ID | | ↳ `id` | string | Project ID |
| ↳ `version` | string | Release version identifier | | ↳ `version` | object | Version details |
| ↳ `raw` | string | Raw version string |
| ↳ `shortVersion` | string | Shortened version identifier | | ↳ `shortVersion` | string | Shortened version identifier |
| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) | | ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) |
| ↳ `url` | string | URL to the release | | ↳ `url` | string | URL to the release |
| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) | | ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) |
| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) | | ↳ `dateCreated` | string | Commit timestamp |
| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) | | ↳ `dateStarted` | string | Deploy start timestamp |
| ↳ `newGroups` | number | Number of new issues introduced | | ↳ `newGroups` | number | Number of new issues introduced |
| ↳ `commitCount` | number | Number of commits in this release | | ↳ `commitCount` | number | Number of commits in this release |
| ↳ `deployCount` | number | Number of deploys for this release | | ↳ `deployCount` | number | Number of deploys for this release |
@@ -584,15 +625,20 @@ Create a new release in Sentry. A release is a version of your code deployed to
| ↳ `id` | string | Owner ID | | ↳ `id` | string | Owner ID |
| ↳ `name` | string | Owner name | | ↳ `name` | string | Owner name |
| ↳ `email` | string | Owner email | | ↳ `email` | string | Owner email |
| ↳ `name` | string | Project name |
| ↳ `email` | string | Author email |
| ↳ `lastCommit` | object | Last commit in the release | | ↳ `lastCommit` | object | Last commit in the release |
| ↳ `id` | string | Commit SHA | | ↳ `id` | string | Commit SHA |
| ↳ `message` | string | Commit message | | ↳ `message` | string | Commit message |
| ↳ `dateCreated` | string | Commit timestamp | | ↳ `dateCreated` | string | Commit timestamp |
| ↳ `message` | string | Commit message |
| ↳ `lastDeploy` | object | Last deploy of the release | | ↳ `lastDeploy` | object | Last deploy of the release |
| ↳ `id` | string | Deploy ID | | ↳ `id` | string | Deploy ID |
| ↳ `environment` | string | Deploy environment | | ↳ `environment` | string | Deploy environment |
| ↳ `dateStarted` | string | Deploy start timestamp | | ↳ `dateStarted` | string | Deploy start timestamp |
| ↳ `dateFinished` | string | Deploy finish timestamp | | ↳ `dateFinished` | string | Deploy finish timestamp |
| ↳ `environment` | string | Deploy environment |
| ↳ `dateFinished` | string | Deploy finish timestamp |
| ↳ `authors` | array | Authors of commits in the release | | ↳ `authors` | array | Authors of commits in the release |
| ↳ `id` | string | Author ID | | ↳ `id` | string | Author ID |
| ↳ `name` | string | Author name | | ↳ `name` | string | Author name |
@@ -602,12 +648,18 @@ Create a new release in Sentry. A release is a version of your code deployed to
| ↳ `name` | string | Project name | | ↳ `name` | string | Project name |
| ↳ `slug` | string | Project slug | | ↳ `slug` | string | Project slug |
| ↳ `platform` | string | Project platform | | ↳ `platform` | string | Project platform |
| ↳ `slug` | string | Project slug |
| ↳ `platform` | string | Project platform |
| ↳ `firstEvent` | string | First event timestamp | | ↳ `firstEvent` | string | First event timestamp |
| ↳ `lastEvent` | string | Last event timestamp | | ↳ `lastEvent` | string | Last event timestamp |
| ↳ `versionInfo` | object | Version metadata | | ↳ `versionInfo` | object | Version metadata |
| ↳ `buildHash` | string | Build hash | | ↳ `buildHash` | string | Build hash |
| ↳ `version` | object | Version details | | ↳ `version` | object | Version details |
| ↳ `raw` | string | Raw version string | | ↳ `raw` | string | Raw version string |
| ↳ `raw` | string | Raw version string |
| ↳ `package` | string | Package name |
| ↳ `buildHash` | string | Build hash |
| ↳ `raw` | string | Raw version string |
| ↳ `package` | string | Package name | | ↳ `package` | string | Package name |
### `sentry_releases_deploy` ### `sentry_releases_deploy`
@@ -619,8 +671,8 @@ Create a deploy record for a Sentry release in a specific environment. Deploys t
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | Sentry API authentication token | | `apiKey` | string | Yes | Sentry API authentication token |
| `organizationSlug` | string | Yes | The slug of the organization \(e.g., "my-org"\) | | `organizationSlug` | string | Yes | The slug of the organization |
| `version` | string | Yes | Version identifier of the release being deployed \(e.g., "1.0.0" or "abc123"\) | | `version` | string | Yes | Version identifier of the release being deployed |
| `environment` | string | Yes | Environment name where the release is being deployed \(e.g., "production", "staging"\) | | `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"\) | | `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\) | | `url` | string | No | URL pointing to the deploy \(e.g., CI/CD pipeline URL\) |

View File

@@ -35,17 +35,17 @@ Integrate Serper into the workflow. Can search the web.
### `serper_search` ### `serper_search`
A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, images, videos, and shopping. Returns comprehensive results including organic results, knowledge graph, answer box, people also ask, related searches, and top stories. A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, and images, with each result containing relevant metadata like titles, URLs, snippets, and type-specific information.
#### Input #### Input
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `query` | string | Yes | The search query \(e.g., "latest AI news", "best restaurants in NYC"\) | | `query` | string | Yes | The search query |
| `num` | number | No | Number of results to return \(e.g., 10, 20, 50\) | | `num` | number | No | Number of results to return |
| `gl` | string | No | Country code for search results \(e.g., "us", "uk", "de", "fr"\) | | `gl` | string | No | Country code for search results |
| `hl` | string | No | Language code for search results \(e.g., "en", "es", "de", "fr"\) | | `hl` | string | No | Language code for search results |
| `type` | string | No | Type of search to perform \(e.g., "search", "news", "images", "videos", "places", "shopping"\) | | `type` | string | No | Type of search to perform |
| `apiKey` | string | Yes | Serper API Key | | `apiKey` | string | Yes | Serper API Key |
#### Output #### Output
@@ -53,17 +53,5 @@ A powerful web search tool that provides access to Google search results through
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `searchResults` | array | Search results with titles, links, snippets, and type-specific metadata \(date for news, rating for places, imageUrl for images\) | | `searchResults` | array | Search results with titles, links, snippets, and type-specific metadata \(date for news, rating for places, imageUrl for images\) |
| ↳ `title` | string | Result title |
| ↳ `link` | string | Result URL |
| ↳ `snippet` | string | Result description/snippet |
| ↳ `position` | number | Position in search results |
| ↳ `date` | string | Publication date \(news/videos\) |
| ↳ `imageUrl` | string | Image URL \(images/news/shopping\) |
| ↳ `source` | string | Source name \(news/videos/shopping\) |
| ↳ `rating` | number | Rating \(places\) |
| ↳ `ratingCount` | number | Number of reviews \(places\) |
| ↳ `address` | string | Address \(places\) |
| ↳ `price` | string | Price \(shopping\) |
| ↳ `duration` | string | Duration \(videos\) |

View File

@@ -44,7 +44,7 @@ Create a new record in a ServiceNow table
| `username` | string | Yes | ServiceNow username | | `username` | string | Yes | ServiceNow username |
| `password` | string | Yes | ServiceNow password | | `password` | string | Yes | ServiceNow password |
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user\) | | `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user\) |
| `fields` | json | Yes | Fields to set on the record as JSON object \(e.g., \{"short_description": "Issue title", "priority": "1"\}\) | | `fields` | json | Yes | Fields to set on the record \(JSON object\) |
#### Output #### Output
@@ -64,12 +64,12 @@ Read records from a ServiceNow table
| `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) | | `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
| `username` | string | Yes | ServiceNow username | | `username` | string | Yes | ServiceNow username |
| `password` | string | Yes | ServiceNow password | | `password` | string | Yes | ServiceNow password |
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) | | `tableName` | string | Yes | Table name |
| `sysId` | string | No | Specific record sys_id \(e.g., 6816f79cc0a8016401c5a33be04be441\) | | `sysId` | string | No | Specific record sys_id |
| `number` | string | No | Record number \(e.g., INC0010001\) | | `number` | string | No | Record number \(e.g., INC0010001\) |
| `query` | string | No | Encoded query string \(e.g., "active=true^priority=1"\) | | `query` | string | No | Encoded query string \(e.g., "active=true^priority=1"\) |
| `limit` | number | No | Maximum number of records to return \(e.g., 10, 50, 100\) | | `limit` | number | No | Maximum number of records to return |
| `fields` | string | No | Comma-separated list of fields to return \(e.g., sys_id,number,short_description,state\) | | `fields` | string | No | Comma-separated list of fields to return |
#### Output #### 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\) | | `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
| `username` | string | Yes | ServiceNow username | | `username` | string | Yes | ServiceNow username |
| `password` | string | Yes | ServiceNow password | | `password` | string | Yes | ServiceNow password |
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) | | `tableName` | string | Yes | Table name |
| `sysId` | string | Yes | Record sys_id to update \(e.g., 6816f79cc0a8016401c5a33be04be441\) | | `sysId` | string | Yes | Record sys_id to update |
| `fields` | json | Yes | Fields to update as JSON object \(e.g., \{"state": "2", "priority": "1"\}\) | | `fields` | json | Yes | Fields to update \(JSON object\) |
#### Output #### 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\) | | `instanceUrl` | string | Yes | ServiceNow instance URL \(e.g., https://instance.service-now.com\) |
| `username` | string | Yes | ServiceNow username | | `username` | string | Yes | ServiceNow username |
| `password` | string | Yes | ServiceNow password | | `password` | string | Yes | ServiceNow password |
| `tableName` | string | Yes | Table name \(e.g., incident, task, sys_user, change_request\) | | `tableName` | string | Yes | Table name |
| `sysId` | string | Yes | Record sys_id to delete \(e.g., 6816f79cc0a8016401c5a33be04be441\) | | `sysId` | string | Yes | Record sys_id to delete |
#### Output #### Output

View File

@@ -43,7 +43,7 @@ Create a new page in a SharePoint site
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
| `siteSelector` | string | No | Select the SharePoint site | | `siteSelector` | string | No | Select the SharePoint site |
| `pageName` | string | Yes | The name of the page to create. Example: My-New-Page.aspx or Report-2024.aspx | | `pageName` | string | Yes | The name of the page to create |
| `pageTitle` | string | No | The title of the page \(defaults to page name if not provided\) | | `pageTitle` | string | No | The title of the page \(defaults to page name if not provided\) |
| `pageContent` | string | No | The content of the page | | `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 | | `siteSelector` | string | No | Select the SharePoint site |
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
| `pageId` | string | No | The ID of the page to read. Example: a GUID like 12345678-1234-1234-1234-123456789012 | | `pageId` | string | No | The ID of the page to read |
| `pageName` | string | No | The name of the page to read \(alternative to pageId\). Example: Home.aspx or About-Us.aspx | | `pageName` | string | No | The name of the page to read \(alternative to pageId\) |
| `maxPages` | number | No | Maximum number of pages to return when listing all pages \(default: 10, max: 50\) | | `maxPages` | number | No | Maximum number of pages to return when listing all pages \(default: 10, max: 50\) |
#### Output #### Output
@@ -95,7 +95,13 @@ Read a specific page from a SharePoint site
| ↳ `pageLayout` | string | The layout type of the page | | ↳ `pageLayout` | string | The layout type of the page |
| ↳ `createdDateTime` | string | When the page was created | | ↳ `createdDateTime` | string | When the page was created |
| ↳ `lastModifiedDateTime` | string | When the page was last modified | | ↳ `lastModifiedDateTime` | string | When the page was last modified |
| ↳ `content` | object | Extracted text content from the page | | ↳ `id` | string | The unique ID of the page |
| ↳ `name` | string | The name of the page |
| ↳ `title` | string | The title of the page |
| ↳ `webUrl` | string | The URL to access the page |
| ↳ `pageLayout` | string | The layout type of the page |
| ↳ `createdDateTime` | string | When the page was created |
| ↳ `lastModifiedDateTime` | string | When the page was last modified |
| ↳ `content` | string | Extracted text content from the page | | ↳ `content` | string | Extracted text content from the page |
| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure | | ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure |
| `content` | object | Content of the SharePoint page | | `content` | object | Content of the SharePoint page |
@@ -112,7 +118,7 @@ List details of all SharePoint sites
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteSelector` | string | No | Select the SharePoint site | | `siteSelector` | string | No | Select the SharePoint site |
| `groupId` | string | No | The group ID for accessing a group team site. Example: a GUID like 12345678-1234-1234-1234-123456789012 | | `groupId` | string | No | The group ID for accessing a group team site |
#### Output #### Output
@@ -129,8 +135,10 @@ List details of all SharePoint sites
| ↳ `isPersonalSite` | boolean | Whether this is a personal site | | ↳ `isPersonalSite` | boolean | Whether this is a personal site |
| ↳ `root` | object | Server relative URL | | ↳ `root` | object | Server relative URL |
| ↳ `serverRelativeUrl` | string | Server relative URL | | ↳ `serverRelativeUrl` | string | Server relative URL |
| ↳ `serverRelativeUrl` | string | Server relative URL |
| ↳ `siteCollection` | object | Site collection hostname | | ↳ `siteCollection` | object | Site collection hostname |
| ↳ `hostname` | string | Site collection hostname | | ↳ `hostname` | string | Site collection hostname |
| ↳ `hostname` | string | Site collection hostname |
| `sites` | array | List of all accessible SharePoint sites | | `sites` | array | List of all accessible SharePoint sites |
| ↳ `id` | string | The unique ID of the site | | ↳ `id` | string | The unique ID of the site |
| ↳ `name` | string | The name of the site | | ↳ `name` | string | The name of the site |
@@ -150,7 +158,7 @@ Create a new list in a SharePoint site
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
| `siteSelector` | string | No | Select the SharePoint site | | `siteSelector` | string | No | Select the SharePoint site |
| `listDisplayName` | string | Yes | Display name of the list to create. Example: Project Tasks or Customer Contacts | | `listDisplayName` | string | Yes | Display name of the list to create |
| `listDescription` | string | No | Description of the list | | `listDescription` | string | No | Description of the list |
| `listTemplate` | string | No | List template name \(e.g., 'genericList'\) | | `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: \[...\] \}. | | `pageContent` | string | No | Optional JSON of columns. Either a top-level array of column definitions or an object with \{ columns: \[...\] \}. |
@@ -178,14 +186,14 @@ Get metadata (and optionally columns/items) for a SharePoint list
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteSelector` | string | No | Select the SharePoint site | | `siteSelector` | string | No | Select the SharePoint site |
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
| `listId` | string | No | The ID of the list to retrieve. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 | | `listId` | string | No | The ID of the list to retrieve |
#### Output #### Output
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `list` | object | Information about the SharePoint list | | `list` | object | Information about the SharePoint list |
| ↳ `id` | string | The unique ID of the list | | ↳ `id` | string | Item ID |
| ↳ `displayName` | string | The display name of the list | | ↳ `displayName` | string | The display name of the list |
| ↳ `name` | string | The internal name of the list | | ↳ `name` | string | The internal name of the list |
| ↳ `webUrl` | string | The web URL of the list | | ↳ `webUrl` | string | The web URL of the list |
@@ -193,6 +201,7 @@ Get metadata (and optionally columns/items) for a SharePoint list
| ↳ `lastModifiedDateTime` | string | When the list was last modified | | ↳ `lastModifiedDateTime` | string | When the list was last modified |
| ↳ `list` | object | List properties \(e.g., template\) | | ↳ `list` | object | List properties \(e.g., template\) |
| ↳ `columns` | array | List column definitions | | ↳ `columns` | array | List column definitions |
| ↳ `fields` | object | Field values for the item |
| `lists` | array | All lists in the site when no listId/title provided | | `lists` | array | All lists in the site when no listId/title provided |
### `sharepoint_update_list` ### `sharepoint_update_list`
@@ -205,8 +214,8 @@ Update the properties (fields) on a SharePoint list item
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteSelector` | string | No | Select the SharePoint site | | `siteSelector` | string | No | Select the SharePoint site |
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
| `listId` | string | No | The ID of the list containing the item. Example: b!abc123def456 or a GUID like 12345678-1234-1234-1234-123456789012 | | `listId` | string | No | The ID of the list containing the item |
| `itemId` | string | Yes | The ID of the list item to update. Example: 1, 42, or 123 | | `itemId` | string | Yes | The ID of the list item to update |
| `listItemFields` | object | Yes | Field values to update on the list item | | `listItemFields` | object | Yes | Field values to update on the list item |
#### Output #### Output
@@ -227,7 +236,7 @@ Add a new item to a SharePoint list
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteSelector` | string | No | Select the SharePoint site | | `siteSelector` | string | No | Select the SharePoint site |
| `siteId` | string | No | The ID of the SharePoint site \(internal use\) | | `siteId` | string | No | The ID of the SharePoint site \(internal use\) |
| `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 | | `listId` | string | Yes | The ID of the list to add the item to |
| `listItemFields` | object | Yes | Field values for the new list item | | `listItemFields` | object | Yes | Field values for the new list item |
#### Output #### Output
@@ -247,9 +256,9 @@ Upload files to a SharePoint document library
| Parameter | Type | Required | Description | | Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `siteId` | string | No | The ID of the SharePoint site | | `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. Example: b!abc123def456 | | `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. Example: /Documents/Subfolder or /Shared Documents/Reports | | `folderPath` | string | No | Optional folder path within the document library \(e.g., /Documents/Subfolder\) |
| `fileName` | string | No | Optional: override the uploaded file name. Example: report-2024.pdf | | `fileName` | string | No | Optional: override the uploaded file name |
| `files` | file[] | No | Files to upload to SharePoint | | `files` | file[] | No | Files to upload to SharePoint |
#### Output #### Output

View File

@@ -53,18 +53,6 @@ Create a new product in your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `product` | object | The created product | | `product` | object | The created product |
| ↳ `id` | string | Unique product identifier \(GID\) |
| ↳ `title` | string | Product title |
| ↳ `handle` | string | URL-friendly product identifier |
| ↳ `descriptionHtml` | string | Product description in HTML format |
| ↳ `vendor` | string | Product vendor or manufacturer |
| ↳ `productType` | string | Product type classification |
| ↳ `tags` | array | Product tags for categorization |
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `variants` | object | Product variants with edges/nodes structure |
| ↳ `images` | object | Product images with edges/nodes structure |
### `shopify_get_product` ### `shopify_get_product`
@@ -82,18 +70,6 @@ Get a single product by ID from your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `product` | object | The product details | | `product` | object | The product details |
| ↳ `id` | string | Unique product identifier \(GID\) |
| ↳ `title` | string | Product title |
| ↳ `handle` | string | URL-friendly product identifier |
| ↳ `descriptionHtml` | string | Product description in HTML format |
| ↳ `vendor` | string | Product vendor or manufacturer |
| ↳ `productType` | string | Product type classification |
| ↳ `tags` | array | Product tags for categorization |
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `variants` | object | Product variants with edges/nodes structure |
| ↳ `images` | object | Product images with edges/nodes structure |
### `shopify_list_products` ### `shopify_list_products`
@@ -112,21 +88,7 @@ List products from your Shopify store with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `products` | array | List of products | | `products` | array | List of products |
| ↳ `id` | string | Unique product identifier \(GID\) |
| ↳ `title` | string | Product title |
| ↳ `handle` | string | URL-friendly product identifier |
| ↳ `descriptionHtml` | string | Product description in HTML format |
| ↳ `vendor` | string | Product vendor or manufacturer |
| ↳ `productType` | string | Product type classification |
| ↳ `tags` | array | Product tags for categorization |
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `variants` | object | Product variants with edges/nodes structure |
| ↳ `images` | object | Product images with edges/nodes structure |
| `pageInfo` | object | Pagination information | | `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
### `shopify_update_product` ### `shopify_update_product`
@@ -150,18 +112,6 @@ Update an existing product in your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `product` | object | The updated product | | `product` | object | The updated product |
| ↳ `id` | string | Unique product identifier \(GID\) |
| ↳ `title` | string | Product title |
| ↳ `handle` | string | URL-friendly product identifier |
| ↳ `descriptionHtml` | string | Product description in HTML format |
| ↳ `vendor` | string | Product vendor or manufacturer |
| ↳ `productType` | string | Product type classification |
| ↳ `tags` | array | Product tags for categorization |
| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `variants` | object | Product variants with edges/nodes structure |
| ↳ `images` | object | Product images with edges/nodes structure |
### `shopify_delete_product` ### `shopify_delete_product`
@@ -196,27 +146,6 @@ Get a single order by ID from your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | The order details | | `order` | object | The order details |
| ↳ `id` | string | Unique order identifier \(GID\) |
| ↳ `name` | string | Order name \(e.g., #1001\) |
| ↳ `email` | string | Customer email for the order |
| ↳ `phone` | string | Customer phone for the order |
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
| ↳ `totalPriceSet` | object | Total order price |
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
| ↳ `totalTaxSet` | object | Total tax amount |
| ↳ `totalShippingPriceSet` | object | Total shipping price |
| ↳ `note` | string | Order note |
| ↳ `tags` | array | Order tags |
| ↳ `customer` | object | Customer who placed the order |
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
| ↳ `shippingAddress` | object | Shipping address |
| ↳ `billingAddress` | object | Billing address |
| ↳ `fulfillments` | array | Order fulfillments |
### `shopify_list_orders` ### `shopify_list_orders`
@@ -236,30 +165,7 @@ List orders from your Shopify store with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `orders` | array | List of orders | | `orders` | array | List of orders |
| ↳ `id` | string | Unique order identifier \(GID\) |
| ↳ `name` | string | Order name \(e.g., #1001\) |
| ↳ `email` | string | Customer email for the order |
| ↳ `phone` | string | Customer phone for the order |
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
| ↳ `totalPriceSet` | object | Total order price |
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
| ↳ `totalTaxSet` | object | Total tax amount |
| ↳ `totalShippingPriceSet` | object | Total shipping price |
| ↳ `note` | string | Order note |
| ↳ `tags` | array | Order tags |
| ↳ `customer` | object | Customer who placed the order |
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
| ↳ `shippingAddress` | object | Shipping address |
| ↳ `billingAddress` | object | Billing address |
| ↳ `fulfillments` | array | Order fulfillments |
| `pageInfo` | object | Pagination information | | `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
### `shopify_update_order` ### `shopify_update_order`
@@ -280,27 +186,6 @@ Update an existing order in your Shopify store (note, tags, email)
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | The updated order | | `order` | object | The updated order |
| ↳ `id` | string | Unique order identifier \(GID\) |
| ↳ `name` | string | Order name \(e.g., #1001\) |
| ↳ `email` | string | Customer email for the order |
| ↳ `phone` | string | Customer phone for the order |
| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) |
| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) |
| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) |
| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) |
| ↳ `totalPriceSet` | object | Total order price |
| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) |
| ↳ `totalTaxSet` | object | Total tax amount |
| ↳ `totalShippingPriceSet` | object | Total shipping price |
| ↳ `note` | string | Order note |
| ↳ `tags` | array | Order tags |
| ↳ `customer` | object | Customer who placed the order |
| ↳ `lineItems` | object | Order line items with edges/nodes structure |
| ↳ `shippingAddress` | object | Shipping address |
| ↳ `billingAddress` | object | Billing address |
| ↳ `fulfillments` | array | Order fulfillments |
### `shopify_cancel_order` ### `shopify_cancel_order`
@@ -323,9 +208,6 @@ Cancel an order in your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `order` | object | The cancellation result | | `order` | object | The cancellation result |
| ↳ `id` | string | Job identifier for the cancellation |
| ↳ `cancelled` | boolean | Whether the cancellation completed |
| ↳ `message` | string | Status message |
### `shopify_create_customer` ### `shopify_create_customer`
@@ -349,18 +231,6 @@ Create a new customer in your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The created customer | | `customer` | object | The created customer |
| ↳ `id` | string | Unique customer identifier \(GID\) |
| ↳ `email` | string | Customer email address |
| ↳ `firstName` | string | Customer first name |
| ↳ `lastName` | string | Customer last name |
| ↳ `phone` | string | Customer phone number |
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `note` | string | Internal notes about the customer |
| ↳ `tags` | array | Customer tags for categorization |
| ↳ `amountSpent` | object | Total amount spent by customer |
| ↳ `addresses` | array | Customer addresses |
| ↳ `defaultAddress` | object | Customer default address |
### `shopify_get_customer` ### `shopify_get_customer`
@@ -378,18 +248,6 @@ Get a single customer by ID from your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The customer details | | `customer` | object | The customer details |
| ↳ `id` | string | Unique customer identifier \(GID\) |
| ↳ `email` | string | Customer email address |
| ↳ `firstName` | string | Customer first name |
| ↳ `lastName` | string | Customer last name |
| ↳ `phone` | string | Customer phone number |
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `note` | string | Internal notes about the customer |
| ↳ `tags` | array | Customer tags for categorization |
| ↳ `amountSpent` | object | Total amount spent by customer |
| ↳ `addresses` | array | Customer addresses |
| ↳ `defaultAddress` | object | Customer default address |
### `shopify_list_customers` ### `shopify_list_customers`
@@ -408,21 +266,7 @@ List customers from your Shopify store with optional filtering
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customers` | array | List of customers | | `customers` | array | List of customers |
| ↳ `id` | string | Unique customer identifier \(GID\) |
| ↳ `email` | string | Customer email address |
| ↳ `firstName` | string | Customer first name |
| ↳ `lastName` | string | Customer last name |
| ↳ `phone` | string | Customer phone number |
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `note` | string | Internal notes about the customer |
| ↳ `tags` | array | Customer tags for categorization |
| ↳ `amountSpent` | object | Total amount spent by customer |
| ↳ `addresses` | array | Customer addresses |
| ↳ `defaultAddress` | object | Customer default address |
| `pageInfo` | object | Pagination information | | `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
### `shopify_update_customer` ### `shopify_update_customer`
@@ -446,18 +290,6 @@ Update an existing customer in your Shopify store
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `customer` | object | The updated customer | | `customer` | object | The updated customer |
| ↳ `id` | string | Unique customer identifier \(GID\) |
| ↳ `email` | string | Customer email address |
| ↳ `firstName` | string | Customer first name |
| ↳ `lastName` | string | Customer last name |
| ↳ `phone` | string | Customer phone number |
| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `note` | string | Internal notes about the customer |
| ↳ `tags` | array | Customer tags for categorization |
| ↳ `amountSpent` | object | Total amount spent by customer |
| ↳ `addresses` | array | Customer addresses |
| ↳ `defaultAddress` | object | Customer default address |
### `shopify_delete_customer` ### `shopify_delete_customer`
@@ -493,26 +325,7 @@ List inventory items from your Shopify store. Use this to find inventory item ID
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels | | `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels |
| ↳ `id` | string | Unique inventory item identifier \(GID\) |
| ↳ `sku` | string | Stock keeping unit |
| ↳ `tracked` | boolean | Whether inventory is tracked |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `variant` | object | Associated product variant |
| ↳ `id` | string | Variant identifier \(GID\) |
| ↳ `title` | string | Variant title |
| ↳ `product` | object | Associated product |
| ↳ `id` | string | Product identifier \(GID\) |
| ↳ `title` | string | Product title |
| ↳ `inventoryLevels` | array | Inventory levels at different locations |
| ↳ `id` | string | Inventory level identifier \(GID\) |
| ↳ `available` | number | Available quantity |
| ↳ `location` | object | Location for this inventory level |
| ↳ `id` | string | Location identifier \(GID\) |
| ↳ `name` | string | Location name |
| `pageInfo` | object | Pagination information | | `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
### `shopify_get_inventory_level` ### `shopify_get_inventory_level`
@@ -531,19 +344,6 @@ Get inventory level for a product variant at a specific location
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `inventoryLevel` | object | The inventory level details | | `inventoryLevel` | object | The inventory level details |
| ↳ `id` | string | Inventory item identifier \(GID\) |
| ↳ `sku` | string | Stock keeping unit |
| ↳ `tracked` | boolean | Whether inventory is tracked |
| ↳ `levels` | array | Inventory levels at different locations |
| ↳ `id` | string | Inventory level identifier \(GID\) |
| ↳ `available` | number | Available quantity |
| ↳ `onHand` | number | On-hand quantity |
| ↳ `committed` | number | Committed quantity |
| ↳ `incoming` | number | Incoming quantity |
| ↳ `reserved` | number | Reserved quantity |
| ↳ `location` | object | Location for this inventory level |
| ↳ `id` | string | Location identifier \(GID\) |
| ↳ `name` | string | Location name |
### `shopify_adjust_inventory` ### `shopify_adjust_inventory`
@@ -563,19 +363,6 @@ Adjust inventory quantity for a product variant at a specific location
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `inventoryLevel` | object | The inventory adjustment result | | `inventoryLevel` | object | The inventory adjustment result |
| ↳ `adjustmentGroup` | object | Inventory adjustment group details |
| ↳ `createdAt` | string | Adjustment timestamp \(ISO 8601\) |
| ↳ `reason` | string | Adjustment reason |
| ↳ `changes` | array | Inventory changes applied |
| ↳ `name` | string | Quantity name \(e.g., available\) |
| ↳ `delta` | number | Quantity change amount |
| ↳ `quantityAfterChange` | number | Quantity after adjustment |
| ↳ `item` | object | Inventory item |
| ↳ `id` | string | Inventory item identifier \(GID\) |
| ↳ `sku` | string | Stock keeping unit |
| ↳ `location` | object | Location of the adjustment |
| ↳ `id` | string | Location identifier \(GID\) |
| ↳ `name` | string | Location name |
### `shopify_list_locations` ### `shopify_list_locations`
@@ -594,14 +381,7 @@ List inventory locations from your Shopify store. Use this to find location IDs
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `locations` | array | List of locations with their IDs, names, and addresses | | `locations` | array | List of locations with their IDs, names, and addresses |
| ↳ `id` | string | Unique location identifier \(GID\) |
| ↳ `name` | string | Location name |
| ↳ `isActive` | boolean | Whether the location is active |
| ↳ `fulfillsOnlineOrders` | boolean | Whether the location fulfills online orders |
| ↳ `address` | object | Location address |
| `pageInfo` | object | Pagination information | | `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
### `shopify_create_fulfillment` ### `shopify_create_fulfillment`
@@ -623,16 +403,6 @@ Create a fulfillment to mark order items as shipped. Requires a fulfillment orde
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `fulfillment` | object | The created fulfillment with tracking info and fulfilled items | | `fulfillment` | object | The created fulfillment with tracking info and fulfilled items |
| ↳ `id` | string | Unique fulfillment identifier \(GID\) |
| ↳ `status` | string | Fulfillment status \(pending, open, success, cancelled, error, failure\) |
| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `trackingInfo` | array | Tracking information for shipments |
| ↳ `fulfillmentLineItems` | array | Fulfilled line items |
| ↳ `id` | string | Fulfillment line item identifier \(GID\) |
| ↳ `quantity` | number | Quantity fulfilled |
| ↳ `lineItem` | object | Associated order line item |
| ↳ `title` | string | Product title |
### `shopify_list_collections` ### `shopify_list_collections`
@@ -651,18 +421,7 @@ List product collections from your Shopify store. Filter by title, type (custom/
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `collections` | array | List of collections with their IDs, titles, and product counts | | `collections` | array | List of collections with their IDs, titles, and product counts |
| ↳ `id` | string | Unique collection identifier \(GID\) |
| ↳ `title` | string | Collection title |
| ↳ `handle` | string | URL-friendly collection identifier |
| ↳ `description` | string | Plain text description |
| ↳ `descriptionHtml` | string | HTML-formatted description |
| ↳ `productsCount` | number | Number of products in the collection |
| ↳ `sortOrder` | string | Product sort order in the collection |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `image` | object | Collection image |
| `pageInfo` | object | Pagination information | | `pageInfo` | object | Pagination information |
| ↳ `hasNextPage` | boolean | Whether there are more results after this page |
| ↳ `hasPreviousPage` | boolean | Whether there are results before this page |
### `shopify_get_collection` ### `shopify_get_collection`
@@ -681,15 +440,5 @@ Get a specific collection by ID, including its products. Use this to retrieve pr
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `collection` | object | The collection details including its products | | `collection` | object | The collection details including its products |
| ↳ `id` | string | Unique collection identifier \(GID\) |
| ↳ `title` | string | Collection title |
| ↳ `handle` | string | URL-friendly collection identifier |
| ↳ `description` | string | Plain text description |
| ↳ `descriptionHtml` | string | HTML-formatted description |
| ↳ `productsCount` | number | Number of products in the collection |
| ↳ `sortOrder` | string | Product sort order in the collection |
| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) |
| ↳ `image` | object | Collection image |
| ↳ `products` | array | Products in the collection |

View File

@@ -1,183 +0,0 @@
---
title: Similarweb
description: Website traffic and analytics data
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard
type="similarweb"
color="#000922"
/>
{/* MANUAL-CONTENT-START:intro */}
[Similarweb](https://www.similarweb.com/) is a leading platform for web analytics that provides in-depth traffic and engagement data for millions of websites. Similarweb gives you insights into website visits, traffic sources, audience behavior, and competitive benchmarks.
With Similarweb in Sim, your agents can:
- **Analyze website traffic**: Retrieve key metrics such as monthly visits, average duration, bounce rates, and top countries.
- **Understand audience engagement**: Gain insights into how users interact with websites, including pages per visit and engagement duration.
- **Track rankings and performance**: Access global, country, and category ranks to benchmark sites against competitors.
- **Discover traffic sources**: Break down traffic by channels like direct, search, social, referrals, and more.
Use Sim's Similarweb integration to automate the monitoring of competitors, track your sites performance, or surface actionable market research—all integrated directly into your workflows and automations. Empower your agents to access and utilize reliable web analytics data easily and programmatically.
{/* MANUAL-CONTENT-END */}
## Usage Instructions
Access comprehensive website analytics including traffic estimates, engagement metrics, rankings, and traffic sources using the Similarweb API.
## Tools
### `similarweb_website_overview`
Get comprehensive website analytics including traffic, rankings, engagement, and traffic sources
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `domain` | string | Yes | Website domain to analyze \(e.g., "example.com" without www or protocol\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `siteName` | string | Website name |
| `description` | string | Website description |
| `globalRank` | number | Global traffic rank |
| `countryRank` | number | Country traffic rank |
| `categoryRank` | number | Category traffic rank |
| `category` | string | Website category |
| `monthlyVisits` | number | Estimated monthly visits |
| `engagementVisitDuration` | number | Average visit duration in seconds |
| `engagementPagesPerVisit` | number | Average pages per visit |
| `engagementBounceRate` | number | Bounce rate \(0-1\) |
| `topCountries` | array | Top countries by traffic share |
| ↳ `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 |
### `similarweb_traffic_visits`
Get total website visits over time (desktop and mobile combined)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `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 \(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
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `visits` | array | Visit data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `visits` | number | Number of visits |
### `similarweb_bounce_rate`
Get website bounce rate over time (desktop and mobile combined)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `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 \(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
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `bounceRate` | array | Bounce rate data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `bounceRate` | number | Bounce rate \(0-1\) |
### `similarweb_pages_per_visit`
Get average pages per visit over time (desktop and mobile combined)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `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 \(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
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `pagesPerVisit` | array | Pages per visit data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `pagesPerVisit` | number | Average pages per visit |
### `similarweb_visit_duration`
Get average desktop visit duration over time (in seconds)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `apiKey` | string | Yes | SimilarWeb API key |
| `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 \(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
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `domain` | string | Analyzed domain |
| `country` | string | Country filter applied |
| `granularity` | string | Data granularity |
| `lastUpdated` | string | Data last updated timestamp |
| `averageVisitDuration` | array | Desktop visit duration data over time |
| ↳ `date` | string | Date \(YYYY-MM-DD\) |
| ↳ `durationSeconds` | number | Average visit duration in seconds |

View File

@@ -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 | | `authMethod` | string | No | Authentication method: oauth or bot_token |
| `destinationType` | string | No | Destination type: channel or dm | | `destinationType` | string | No | Destination type: channel or dm |
| `botToken` | string | No | Bot token for Custom Bot | | `botToken` | string | No | Bot token for Custom Bot |
| `channel` | string | No | Slack channel ID \(e.g., C1234567890\) | | `channel` | string | No | Target Slack channel \(e.g., #general\) |
| `dmUserId` | string | No | Slack user ID for direct messages \(e.g., U1234567890\) | | `dmUserId` | string | No | Target Slack user for direct messages |
| `text` | string | Yes | Message text to send \(supports Slack mrkdwn formatting\) | | `text` | string | Yes | Message text to send \(supports Slack mrkdwn formatting\) |
| `thread_ts` | string | No | Thread timestamp to reply to \(creates thread reply\) | | `thread_ts` | string | No | Thread timestamp to reply to \(creates thread reply\) |
| `files` | file[] | No | Files to attach to the message | | `files` | file[] | No | Files to attach to the message |
@@ -97,60 +97,6 @@ Send messages to Slack channels or direct messages. Supports Slack mrkdwn format
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | object | Complete message object with all properties returned by Slack | | `message` | object | Complete message object with all properties returned by Slack |
| ↳ `type` | string | Message type \(usually "message"\) |
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
| ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message |
| ↳ `bot_id` | string | Bot ID if sent by a bot |
| ↳ `username` | string | Display username |
| ↳ `channel` | string | Channel ID |
| ↳ `team` | string | Team/workspace ID |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
| ↳ `parent_user_id` | string | User ID of thread parent message author |
| ↳ `reply_count` | number | Total number of replies in thread |
| ↳ `reply_users_count` | number | Number of unique users who replied |
| ↳ `latest_reply` | string | Timestamp of most recent reply |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
| ↳ `last_read` | string | Timestamp of last read message |
| ↳ `unread_count` | number | Number of unread messages in thread |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
| ↳ `is_starred` | boolean | Whether message is starred by user |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `permalink` | string | Permanent URL to the message |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file |
| ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) |
| ↳ `permalink` | string | Permanent link to the file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `id` | number | Attachment ID |
| ↳ `fallback` | string | Plain text summary |
| ↳ `text` | string | Main attachment text |
| ↳ `pretext` | string | Text shown before attachment |
| ↳ `color` | string | Color bar hex code or preset |
| ↳ `author_name` | string | Author display name |
| ↳ `author_link` | string | Author link URL |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message |
| ↳ `ts` | string | Timestamp of the edit |
| `ts` | string | Message timestamp | | `ts` | string | Message timestamp |
| `channel` | string | Channel ID where message was sent | | `channel` | string | Channel ID where message was sent |
| `fileCount` | number | Number of files uploaded \(when files are attached\) | | `fileCount` | number | Number of files uploaded \(when files are attached\) |
@@ -165,7 +111,7 @@ Create and share Slack canvases in channels. Canvases are collaborative document
| --------- | ---- | -------- | ----------- | | --------- | ---- | -------- | ----------- |
| `authMethod` | string | No | Authentication method: oauth or bot_token | | `authMethod` | string | No | Authentication method: oauth or bot_token |
| `botToken` | string | No | Bot token for Custom Bot | | `botToken` | string | No | Bot token for Custom Bot |
| `channel` | string | Yes | Slack channel ID \(e.g., C1234567890\) | | `channel` | string | Yes | Target Slack channel \(e.g., #general\) |
| `title` | string | Yes | Title of the canvas | | `title` | string | Yes | Title of the canvas |
| `content` | string | Yes | Canvas content in markdown format | | `content` | string | Yes | Canvas content in markdown format |
| `document_content` | object | No | Structured canvas document content | | `document_content` | object | No | Structured canvas document content |
@@ -174,9 +120,9 @@ Create and share Slack canvases in channels. Canvases are collaborative document
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `canvas_id` | string | Unique canvas identifier | | `canvas_id` | string | ID of the created canvas |
| `channel` | string | Channel where canvas was created | | `channel` | string | Channel where canvas was created |
| `title` | string | Canvas title | | `title` | string | Title of the canvas |
### `slack_message_reader` ### `slack_message_reader`
@@ -189,8 +135,8 @@ Read the latest messages from Slack channels. Retrieve conversation history with
| `authMethod` | string | No | Authentication method: oauth or bot_token | | `authMethod` | string | No | Authentication method: oauth or bot_token |
| `destinationType` | string | No | Destination type: channel or dm | | `destinationType` | string | No | Destination type: channel or dm |
| `botToken` | string | No | Bot token for Custom Bot | | `botToken` | string | No | Bot token for Custom Bot |
| `channel` | string | No | Slack channel ID to read messages from \(e.g., C1234567890\) | | `channel` | string | No | Slack channel to read messages from \(e.g., #general\) |
| `dmUserId` | string | No | Slack user ID for DM conversation \(e.g., U1234567890\) | | `dmUserId` | string | No | Target Slack user for DM conversation |
| `limit` | number | No | Number of messages to retrieve \(default: 10, max: 15\) | | `limit` | number | No | Number of messages to retrieve \(default: 10, max: 15\) |
| `oldest` | string | No | Start of time range \(timestamp\) | | `oldest` | string | No | Start of time range \(timestamp\) |
| `latest` | string | No | End of time range \(timestamp\) | | `latest` | string | No | End of time range \(timestamp\) |
@@ -200,60 +146,51 @@ Read the latest messages from Slack channels. Retrieve conversation history with
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `messages` | array | Array of message objects from the channel | | `messages` | array | Array of message objects from the channel |
| ↳ `type` | string | Message type \(usually "message"\) | | ↳ `type` | string | Message type |
| ↳ `ts` | string | Message timestamp \(unique identifier\) | | ↳ `ts` | string | Edit timestamp |
| ↳ `text` | string | Message text content | | ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message | | ↳ `user` | string | User ID who edited |
| ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `bot_id` | string | Bot ID if sent by a bot |
| ↳ `username` | string | Display username | | ↳ `username` | string | Display username |
| ↳ `channel` | string | Channel ID | | ↳ `channel` | string | Channel ID |
| ↳ `team` | string | Team/workspace ID | | ↳ `team` | string | Team ID |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | | ↳ `thread_ts` | string | Thread parent message timestamp |
| ↳ `parent_user_id` | string | User ID of thread parent message author | | ↳ `parent_user_id` | string | User ID of thread parent |
| ↳ `reply_count` | number | Total number of replies in thread | | ↳ `reply_count` | number | Number of thread replies |
| ↳ `reply_users_count` | number | Number of unique users who replied | | ↳ `reply_users_count` | number | Number of users who replied |
| ↳ `latest_reply` | string | Timestamp of most recent reply | | ↳ `latest_reply` | string | Timestamp of latest reply |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread | | ↳ `subscribed` | boolean | Whether user is subscribed to thread |
| ↳ `last_read` | string | Timestamp of last read message | | ↳ `last_read` | string | Last read timestamp |
| ↳ `unread_count` | number | Number of unread messages in thread | | ↳ `unread_count` | number | Number of unread messages |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | | ↳ `subtype` | string | Message subtype |
| ↳ `is_starred` | boolean | Whether message is starred by user | | ↳ `reactions` | array | Array of reactions on this message |
| ↳ `pinned_to` | array | Channel IDs where message is pinned | | ↳ `name` | string | Emoji name |
| ↳ `permalink` | string | Permanent URL to the message | | ↳ `count` | number | Number of reactions |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted | | ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name | | ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file | | ↳ `count` | number | Number of reactions |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `is_starred` | boolean | Whether message is starred |
| ↳ `pinned_to` | array | Array of channel IDs where message is pinned |
| ↳ `files` | array | Array of files attached to message |
| ↳ `id` | string | File ID |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type |
| ↳ `size` | number | File size in bytes | | ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) | | ↳ `url_private` | string | Private download URL |
| ↳ `permalink` | string | Permanent link to the file | | ↳ `permalink` | string | Permanent link to file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) | | ↳ `mode` | string | File mode |
| ↳ `attachments` | array | Legacy attachments on the message | | ↳ `id` | string | File ID |
| ↳ `id` | number | Attachment ID | | ↳ `mimetype` | string | MIME type |
| ↳ `fallback` | string | Plain text summary | | ↳ `size` | number | File size in bytes |
| ↳ `text` | string | Main attachment text | | ↳ `url_private` | string | Private download URL |
| ↳ `pretext` | string | Text shown before attachment | | ↳ `permalink` | string | Permanent link to message |
| ↳ `color` | string | Color bar hex code or preset | | ↳ `mode` | string | File mode |
| ↳ `author_name` | string | Author display name | | ↳ `attachments` | array | Array of legacy attachments |
| ↳ `author_link` | string | Author link URL | | ↳ `blocks` | array | Array of Block Kit blocks |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited | | ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message | | ↳ `user` | string | User ID who edited |
| ↳ `ts` | string | Timestamp of the edit | | ↳ `ts` | string | Edit timestamp |
### `slack_get_message` ### `slack_get_message`
@@ -273,60 +210,46 @@ Retrieve a specific message by its timestamp. Useful for getting a thread parent
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | object | The retrieved message object | | `message` | object | The retrieved message object |
| ↳ `type` | string | Message type \(usually "message"\) | | ↳ `type` | string | Message type |
| ↳ `ts` | string | Message timestamp \(unique identifier\) | | ↳ `ts` | string | Edit timestamp |
| ↳ `text` | string | Message text content | | ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message | | ↳ `user` | string | User ID who edited |
| ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `bot_id` | string | Bot ID if sent by a bot |
| ↳ `username` | string | Display username | | ↳ `username` | string | Display username |
| ↳ `channel` | string | Channel ID | | ↳ `channel` | string | Channel ID |
| ↳ `team` | string | Team/workspace ID | | ↳ `team` | string | Team ID |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | | ↳ `thread_ts` | string | Thread parent timestamp |
| ↳ `parent_user_id` | string | User ID of thread parent message author | | ↳ `parent_user_id` | string | User ID of thread parent |
| ↳ `reply_count` | number | Total number of replies in thread | | ↳ `reply_count` | number | Number of thread replies |
| ↳ `reply_users_count` | number | Number of unique users who replied | | ↳ `reply_users_count` | number | Number of users who replied |
| ↳ `latest_reply` | string | Timestamp of most recent reply | | ↳ `latest_reply` | string | Timestamp of latest reply |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread | | ↳ `subtype` | string | Message subtype |
| ↳ `last_read` | string | Timestamp of last read message | | ↳ `reactions` | array | Array of reactions on this message |
| ↳ `unread_count` | number | Number of unread messages in thread | | ↳ `name` | string | Emoji name |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | | ↳ `count` | number | Number of reactions |
| ↳ `is_starred` | boolean | Whether message is starred by user | | ↳ `users` | array | User IDs who reacted |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `permalink` | string | Permanent URL to the message |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name | | ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file | | ↳ `count` | number | Number of reactions |
| ↳ `users` | array | User IDs who reacted |
| ↳ `is_starred` | boolean | Whether message is starred |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `files` | array | Files attached to message |
| ↳ `id` | string | File ID |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type |
| ↳ `size` | number | File size in bytes | | ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) | | ↳ `url_private` | string | Private download URL |
| ↳ `permalink` | string | Permanent link to the file | | ↳ `permalink` | string | Permanent link to file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) | | ↳ `id` | string | File ID |
| ↳ `attachments` | array | Legacy attachments on the message | | ↳ `mimetype` | string | MIME type |
| ↳ `id` | number | Attachment ID | | ↳ `size` | number | File size in bytes |
| ↳ `fallback` | string | Plain text summary | | ↳ `url_private` | string | Private download URL |
| ↳ `text` | string | Main attachment text | | ↳ `permalink` | string | Permanent link to message |
| ↳ `pretext` | string | Text shown before attachment | | ↳ `attachments` | array | Legacy attachments |
| ↳ `color` | string | Color bar hex code or preset | | ↳ `blocks` | array | Block Kit blocks |
| ↳ `author_name` | string | Author display name |
| ↳ `author_link` | string | Author link URL |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited | | ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message | | ↳ `user` | string | User ID who edited |
| ↳ `ts` | string | Timestamp of the edit | | ↳ `ts` | string | Edit timestamp |
### `slack_get_thread` ### `slack_get_thread`
@@ -347,170 +270,37 @@ Retrieve an entire thread including the parent message and all replies. Useful f
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `parentMessage` | object | The thread parent message | | `parentMessage` | object | The thread parent message |
| ↳ `type` | string | Message type \(usually "message"\) | | ↳ `type` | string | Message type |
| ↳ `ts` | string | Message timestamp \(unique identifier\) | | ↳ `ts` | string | Message timestamp |
| ↳ `text` | string | Message text content | | ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message | | ↳ `user` | string | User ID who sent the message |
| ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `bot_id` | string | Bot ID if sent by a bot |
| ↳ `username` | string | Display username | | ↳ `username` | string | Display username |
| ↳ `channel` | string | Channel ID | | ↳ `reply_count` | number | Total number of thread replies |
| ↳ `team` | string | Team/workspace ID | | ↳ `reply_users_count` | number | Number of users who replied |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | | ↳ `latest_reply` | string | Timestamp of latest reply |
| ↳ `parent_user_id` | string | User ID of thread parent message author | | ↳ `reactions` | array | Array of reactions on the parent message |
| ↳ `reply_count` | number | Total number of replies in thread | | ↳ `name` | string | Emoji name |
| ↳ `reply_users_count` | number | Number of unique users who replied | | ↳ `count` | number | Number of reactions |
| ↳ `latest_reply` | string | Timestamp of most recent reply | | ↳ `users` | array | User IDs who reacted |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
| ↳ `last_read` | string | Timestamp of last read message |
| ↳ `unread_count` | number | Number of unread messages in thread |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
| ↳ `is_starred` | boolean | Whether message is starred by user |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `permalink` | string | Permanent URL to the message |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name | | ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file | | ↳ `count` | number | Number of reactions |
| ↳ `users` | array | User IDs who reacted |
| ↳ `files` | array | Files attached to the parent message |
| ↳ `id` | string | File ID |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type |
| ↳ `size` | number | File size in bytes |
| ↳ `id` | string | File ID |
| ↳ `mimetype` | string | MIME type |
| ↳ `size` | number | File size in bytes | | ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) |
| ↳ `permalink` | string | Permanent link to the file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `id` | number | Attachment ID |
| ↳ `fallback` | string | Plain text summary |
| ↳ `text` | string | Main attachment text |
| ↳ `pretext` | string | Text shown before attachment |
| ↳ `color` | string | Color bar hex code or preset |
| ↳ `author_name` | string | Author display name |
| ↳ `author_link` | string | Author link URL |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message |
| ↳ `ts` | string | Timestamp of the edit |
| `replies` | array | Array of reply messages in the thread \(excluding the parent\) | | `replies` | array | Array of reply messages in the thread \(excluding the parent\) |
| ↳ `type` | string | Message type \(usually "message"\) | | ↳ `ts` | string | Message timestamp |
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
| ↳ `text` | string | Message text content | | ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message | | ↳ `user` | string | User ID who sent the reply |
| ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `reactions` | array | Reactions on the reply |
| ↳ `username` | string | Display username | | ↳ `files` | array | Files attached to the reply |
| ↳ `channel` | string | Channel ID |
| ↳ `team` | string | Team/workspace ID |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
| ↳ `parent_user_id` | string | User ID of thread parent message author |
| ↳ `reply_count` | number | Total number of replies in thread |
| ↳ `reply_users_count` | number | Number of unique users who replied |
| ↳ `latest_reply` | string | Timestamp of most recent reply |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
| ↳ `last_read` | string | Timestamp of last read message |
| ↳ `unread_count` | number | Number of unread messages in thread |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
| ↳ `is_starred` | boolean | Whether message is starred by user |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `permalink` | string | Permanent URL to the message |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file |
| ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) |
| ↳ `permalink` | string | Permanent link to the file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `id` | number | Attachment ID |
| ↳ `fallback` | string | Plain text summary |
| ↳ `text` | string | Main attachment text |
| ↳ `pretext` | string | Text shown before attachment |
| ↳ `color` | string | Color bar hex code or preset |
| ↳ `author_name` | string | Author display name |
| ↳ `author_link` | string | Author link URL |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message |
| ↳ `ts` | string | Timestamp of the edit |
| `messages` | array | All messages in the thread \(parent + replies\) in chronological order | | `messages` | array | All messages in the thread \(parent + replies\) in chronological order |
| ↳ `type` | string | Message type \(usually "message"\) |
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
| ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message |
| ↳ `bot_id` | string | Bot ID if sent by a bot |
| ↳ `username` | string | Display username |
| ↳ `channel` | string | Channel ID |
| ↳ `team` | string | Team/workspace ID |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
| ↳ `parent_user_id` | string | User ID of thread parent message author |
| ↳ `reply_count` | number | Total number of replies in thread |
| ↳ `reply_users_count` | number | Number of unique users who replied |
| ↳ `latest_reply` | string | Timestamp of most recent reply |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
| ↳ `last_read` | string | Timestamp of last read message |
| ↳ `unread_count` | number | Number of unread messages in thread |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
| ↳ `is_starred` | boolean | Whether message is starred by user |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `permalink` | string | Permanent URL to the message |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file |
| ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) |
| ↳ `permalink` | string | Permanent link to the file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `id` | number | Attachment ID |
| ↳ `fallback` | string | Plain text summary |
| ↳ `text` | string | Main attachment text |
| ↳ `pretext` | string | Text shown before attachment |
| ↳ `color` | string | Color bar hex code or preset |
| ↳ `author_name` | string | Author display name |
| ↳ `author_link` | string | Author link URL |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message |
| ↳ `ts` | string | Timestamp of the edit |
| `replyCount` | number | Number of replies returned in this response | | `replyCount` | number | Number of replies returned in this response |
| `hasMore` | boolean | Whether there are more messages in the thread \(pagination needed\) | | `hasMore` | boolean | Whether there are more messages in the thread \(pagination needed\) |
@@ -535,20 +325,14 @@ List all channels in a Slack workspace. Returns public and private channels the
| `channels` | array | Array of channel objects from the workspace | | `channels` | array | Array of channel objects from the workspace |
| ↳ `id` | string | Channel ID \(e.g., C1234567890\) | | ↳ `id` | string | Channel ID \(e.g., C1234567890\) |
| ↳ `name` | string | Channel name without # prefix | | ↳ `name` | string | Channel name without # prefix |
| ↳ `is_channel` | boolean | Whether this is a channel | | ↳ `is_private` | boolean | Whether the channel is private |
| ↳ `is_private` | boolean | Whether channel is private | | ↳ `is_archived` | boolean | Whether the channel is archived |
| ↳ `is_archived` | boolean | Whether channel is archived | | ↳ `is_member` | boolean | Whether the bot is a member of the channel |
| ↳ `is_general` | boolean | Whether this is the general channel |
| ↳ `is_member` | boolean | Whether the bot/user is a member |
| ↳ `is_shared` | boolean | Whether channel is shared across workspaces |
| ↳ `is_ext_shared` | boolean | Whether channel is externally shared |
| ↳ `is_org_shared` | boolean | Whether channel is org-wide shared |
| ↳ `num_members` | number | Number of members in the channel | | ↳ `num_members` | number | Number of members in the channel |
| ↳ `topic` | string | Channel topic | | ↳ `topic` | string | Channel topic |
| ↳ `purpose` | string | Channel purpose/description | | ↳ `purpose` | string | Channel purpose/description |
| ↳ `created` | number | Unix timestamp when channel was created | | ↳ `created` | number | Unix timestamp when channel was created |
| ↳ `creator` | string | User ID of channel creator | | ↳ `creator` | string | User ID of channel creator |
| ↳ `updated` | number | Unix timestamp of last update |
| `ids` | array | Array of channel IDs for easy access | | `ids` | array | Array of channel IDs for easy access |
| `names` | array | Array of channel names for easy access | | `names` | array | Array of channel names for easy access |
| `count` | number | Total number of channels returned | | `count` | number | Total number of channels returned |
@@ -624,8 +408,7 @@ Get detailed information about a specific Slack user by their user ID.
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `user` | object | Detailed user information | | `user` | object | Detailed user information |
| ↳ `id` | string | User ID \(e.g., U1234567890\) | | ↳ `id` | string | User ID |
| ↳ `team_id` | string | Workspace/team ID |
| ↳ `name` | string | Username \(handle\) | | ↳ `name` | string | Username \(handle\) |
| ↳ `real_name` | string | Full real name | | ↳ `real_name` | string | Full real name |
| ↳ `display_name` | string | Display name shown in Slack | | ↳ `display_name` | string | Display name shown in Slack |
@@ -640,14 +423,10 @@ Get detailed information about a specific Slack user by their user ID.
| ↳ `is_primary_owner` | boolean | Whether the user is the primary owner | | ↳ `is_primary_owner` | boolean | Whether the user is the primary owner |
| ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) | | ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) |
| ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest | | ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest |
| ↳ `is_app_user` | boolean | Whether user is an app user |
| ↳ `is_stranger` | boolean | Whether user is from different workspace |
| ↳ `deleted` | boolean | Whether the user is deactivated | | ↳ `deleted` | boolean | Whether the user is deactivated |
| ↳ `color` | string | User color for display |
| ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) | | ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) |
| ↳ `timezone_label` | string | Human-readable timezone label | | ↳ `timezone_label` | string | Human-readable timezone label |
| ↳ `timezone_offset` | number | Timezone offset in seconds from UTC | | ↳ `timezone_offset` | number | Timezone offset in seconds from UTC |
| ↳ `avatar` | string | URL to user avatar image |
| ↳ `avatar_24` | string | URL to 24px avatar | | ↳ `avatar_24` | string | URL to 24px avatar |
| ↳ `avatar_48` | string | URL to 48px avatar | | ↳ `avatar_48` | string | URL to 48px avatar |
| ↳ `avatar_72` | string | URL to 72px avatar | | ↳ `avatar_72` | string | URL to 72px avatar |
@@ -657,7 +436,6 @@ Get detailed information about a specific Slack user by their user ID.
| ↳ `status_emoji` | string | Custom status emoji | | ↳ `status_emoji` | string | Custom status emoji |
| ↳ `status_expiration` | number | Unix timestamp when status expires | | ↳ `status_expiration` | number | Unix timestamp when status expires |
| ↳ `updated` | number | Unix timestamp of last profile update | | ↳ `updated` | number | Unix timestamp of last profile update |
| ↳ `has_2fa` | boolean | Whether two-factor auth is enabled |
### `slack_download` ### `slack_download`
@@ -697,60 +475,6 @@ Update a message previously sent by the bot in Slack
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | object | Complete updated message object with all properties returned by Slack | | `message` | object | Complete updated message object with all properties returned by Slack |
| ↳ `type` | string | Message type \(usually "message"\) |
| ↳ `ts` | string | Message timestamp \(unique identifier\) |
| ↳ `text` | string | Message text content |
| ↳ `user` | string | User ID who sent the message |
| ↳ `bot_id` | string | Bot ID if sent by a bot |
| ↳ `username` | string | Display username |
| ↳ `channel` | string | Channel ID |
| ↳ `team` | string | Team/workspace ID |
| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) |
| ↳ `parent_user_id` | string | User ID of thread parent message author |
| ↳ `reply_count` | number | Total number of replies in thread |
| ↳ `reply_users_count` | number | Number of unique users who replied |
| ↳ `latest_reply` | string | Timestamp of most recent reply |
| ↳ `subscribed` | boolean | Whether user is subscribed to thread |
| ↳ `last_read` | string | Timestamp of last read message |
| ↳ `unread_count` | number | Number of unread messages in thread |
| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) |
| ↳ `is_starred` | boolean | Whether message is starred by user |
| ↳ `pinned_to` | array | Channel IDs where message is pinned |
| ↳ `permalink` | string | Permanent URL to the message |
| ↳ `reactions` | array | Reactions on this message |
| ↳ `name` | string | Emoji name \(without colons\) |
| ↳ `count` | number | Number of times this reaction was added |
| ↳ `users` | array | Array of user IDs who reacted |
| ↳ `files` | array | Files attached to the message |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name |
| ↳ `mimetype` | string | MIME type of the file |
| ↳ `size` | number | File size in bytes |
| ↳ `url_private` | string | Private download URL \(requires auth\) |
| ↳ `permalink` | string | Permanent link to the file |
| ↳ `mode` | string | File mode \(hosted, external, etc.\) |
| ↳ `attachments` | array | Legacy attachments on the message |
| ↳ `id` | number | Attachment ID |
| ↳ `fallback` | string | Plain text summary |
| ↳ `text` | string | Main attachment text |
| ↳ `pretext` | string | Text shown before attachment |
| ↳ `color` | string | Color bar hex code or preset |
| ↳ `author_name` | string | Author display name |
| ↳ `author_link` | string | Author link URL |
| ↳ `author_icon` | string | Author icon URL |
| ↳ `title` | string | Attachment title |
| ↳ `title_link` | string | Title link URL |
| ↳ `image_url` | string | Image URL |
| ↳ `thumb_url` | string | Thumbnail URL |
| ↳ `footer` | string | Footer text |
| ↳ `footer_icon` | string | Footer icon URL |
| ↳ `ts` | string | Timestamp shown in footer |
| ↳ `blocks` | array | Block Kit blocks in the message |
| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) |
| ↳ `block_id` | string | Unique block identifier |
| ↳ `edited` | object | Edit information if message was edited |
| ↳ `user` | string | User ID who edited the message |
| ↳ `ts` | string | Timestamp of the edit |
| `content` | string | Success message | | `content` | string | Success message |
| `metadata` | object | Updated message metadata | | `metadata` | object | Updated message metadata |
| ↳ `channel` | string | Channel ID | | ↳ `channel` | string | Channel ID |

View File

@@ -48,10 +48,10 @@ Send a message to an Amazon SQS queue
| `region` | string | Yes | AWS region \(e.g., us-east-1\) | | `region` | string | Yes | AWS region \(e.g., us-east-1\) |
| `accessKeyId` | string | Yes | AWS access key ID | | `accessKeyId` | string | Yes | AWS access key ID |
| `secretAccessKey` | string | Yes | AWS secret access key | | `secretAccessKey` | string | Yes | AWS secret access key |
| `queueUrl` | string | Yes | SQS queue URL \(e.g., https://sqs.us-east-1.amazonaws.com/123456789012/my-queue\) | | `queueUrl` | string | Yes | Queue URL |
| `data` | object | Yes | Message body to send as JSON object \(e.g., \{ "action": "process", "payload": \{...\} \}\) | | `data` | object | Yes | Message body to send |
| `messageGroupId` | string | No | Message group ID for FIFO queues \(e.g., "order-processing-group"\) | | `messageGroupId` | string | No | Message group ID \(optional\) |
| `messageDeduplicationId` | string | No | Message deduplication ID for FIFO queues \(e.g., "order-12345-v1"\) | | `messageDeduplicationId` | string | No | Message deduplication ID \(optional\) |
#### Output #### Output

View File

@@ -79,19 +79,16 @@ Run an autonomous web agent to complete tasks and extract structured data
| Parameter | Type | Description | | Parameter | Type | Description |
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `agentResult` | object | Result from the Stagehand agent execution | | `agentResult` | object | Result from the Stagehand agent execution |
| ↳ `success` | boolean | Whether the agent task completed successfully without errors | | ↳ `success` | boolean | Whether the agent task completed successfully |
| ↳ `completed` | boolean | Whether the agent finished executing \(may be false if max steps reached\) | | ↳ `completed` | boolean | Whether the task was fully completed |
| ↳ `message` | string | Final status message or result summary from the agent | | ↳ `message` | string | Status message or final result |
| ↳ `actions` | array | List of all actions performed by the agent during task execution | | ↳ `actions` | array | Type of action performed |
| ↳ `type` | string | Type of action performed \(e.g., "act", "observe", "ariaTree", "close", "wait", "navigate"\) | | ↳ `type` | string | Type of action performed |
| ↳ `reasoning` | string | AI reasoning for why this action was taken | | ↳ `params` | object | Parameters used for the action |
| ↳ `taskCompleted` | boolean | Whether the task was completed after this action | | ↳ `result` | object | Result of the action |
| ↳ `action` | string | Description of the action taken \(e.g., "click the submit button"\) | | ↳ `type` | string | Type of action performed |
| ↳ `instruction` | string | Instruction that triggered this action | | ↳ `params` | object | Parameters used for the action |
| ↳ `pageUrl` | string | URL of the page when this action was performed | | ↳ `result` | object | Result of the action |
| ↳ `pageText` | string | Page text content \(for ariaTree actions\) |
| ↳ `timestamp` | number | Unix timestamp when the action was performed |
| ↳ `timeMs` | number | Time in milliseconds \(for wait actions\) |
| `structuredOutput` | object | Extracted data matching the provided output schema | | `structuredOutput` | object | Extracted data matching the provided output schema |

File diff suppressed because it is too large Load Diff

View File

@@ -59,7 +59,7 @@ Transcribe audio to text using OpenAI Whisper
| `provider` | string | Yes | STT provider \(whisper\) | | `provider` | string | Yes | STT provider \(whisper\) |
| `apiKey` | string | Yes | OpenAI API key | | `apiKey` | string | Yes | OpenAI API key |
| `model` | string | No | Whisper model to use \(default: whisper-1\) | | `model` | string | No | Whisper model to use \(default: whisper-1\) |
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFile` | file | No | Audio or video file to transcribe |
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
| `audioUrl` | string | No | URL to audio or video file | | `audioUrl` | string | No | URL to audio or video file |
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
@@ -67,7 +67,6 @@ Transcribe audio to text using OpenAI Whisper
| `translateToEnglish` | boolean | No | Translate audio to English | | `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. | | `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. | | `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 #### Output
@@ -75,11 +74,6 @@ Transcribe audio to text using OpenAI Whisper
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `transcript` | string | Full transcribed text | | `transcript` | string | Full transcribed text |
| `segments` | array | Timestamped segments | | `segments` | array | Timestamped segments |
| ↳ `text` | string | Transcribed text for this segment |
| ↳ `start` | number | Start time in seconds |
| ↳ `end` | number | End time in seconds |
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
| ↳ `confidence` | number | Confidence score \(0-1\) |
| `language` | string | Detected or specified language | | `language` | string | Detected or specified language |
| `duration` | number | Audio duration in seconds | | `duration` | number | Audio duration in seconds |
@@ -94,7 +88,7 @@ Transcribe audio to text using Deepgram
| `provider` | string | Yes | STT provider \(deepgram\) | | `provider` | string | Yes | STT provider \(deepgram\) |
| `apiKey` | string | Yes | Deepgram API key | | `apiKey` | string | Yes | Deepgram API key |
| `model` | string | No | Deepgram model to use \(nova-3, nova-2, whisper-large, etc.\) | | `model` | string | No | Deepgram model to use \(nova-3, nova-2, whisper-large, etc.\) |
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFile` | file | No | Audio or video file to transcribe |
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
| `audioUrl` | string | No | URL to audio or video file | | `audioUrl` | string | No | URL to audio or video file |
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
@@ -107,11 +101,6 @@ Transcribe audio to text using Deepgram
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `transcript` | string | Full transcribed text | | `transcript` | string | Full transcribed text |
| `segments` | array | Timestamped segments with speaker labels | | `segments` | array | Timestamped segments with speaker labels |
| ↳ `text` | string | Transcribed text for this segment |
| ↳ `start` | number | Start time in seconds |
| ↳ `end` | number | End time in seconds |
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
| ↳ `confidence` | number | Confidence score \(0-1\) |
| `language` | string | Detected or specified language | | `language` | string | Detected or specified language |
| `duration` | number | Audio duration in seconds | | `duration` | number | Audio duration in seconds |
| `confidence` | number | Overall confidence score | | `confidence` | number | Overall confidence score |
@@ -127,7 +116,7 @@ Transcribe audio to text using ElevenLabs
| `provider` | string | Yes | STT provider \(elevenlabs\) | | `provider` | string | Yes | STT provider \(elevenlabs\) |
| `apiKey` | string | Yes | ElevenLabs API key | | `apiKey` | string | Yes | ElevenLabs API key |
| `model` | string | No | ElevenLabs model to use \(scribe_v1, scribe_v1_experimental\) | | `model` | string | No | ElevenLabs model to use \(scribe_v1, scribe_v1_experimental\) |
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFile` | file | No | Audio or video file to transcribe |
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
| `audioUrl` | string | No | URL to audio or video file | | `audioUrl` | string | No | URL to audio or video file |
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
@@ -154,7 +143,7 @@ Transcribe audio to text using AssemblyAI with advanced NLP features
| `provider` | string | Yes | STT provider \(assemblyai\) | | `provider` | string | Yes | STT provider \(assemblyai\) |
| `apiKey` | string | Yes | AssemblyAI API key | | `apiKey` | string | Yes | AssemblyAI API key |
| `model` | string | No | AssemblyAI model to use \(default: best\) | | `model` | string | No | AssemblyAI model to use \(default: best\) |
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFile` | file | No | Audio or video file to transcribe |
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
| `audioUrl` | string | No | URL to audio or video file | | `audioUrl` | string | No | URL to audio or video file |
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |
@@ -171,25 +160,11 @@ Transcribe audio to text using AssemblyAI with advanced NLP features
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `transcript` | string | Full transcribed text | | `transcript` | string | Full transcribed text |
| `segments` | array | Timestamped segments with speaker labels | | `segments` | array | Timestamped segments with speaker labels |
| ↳ `text` | string | Transcribed text for this segment |
| ↳ `start` | number | Start time in seconds |
| ↳ `end` | number | End time in seconds |
| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) |
| ↳ `confidence` | number | Confidence score \(0-1\) |
| `language` | string | Detected or specified language | | `language` | string | Detected or specified language |
| `duration` | number | Audio duration in seconds | | `duration` | number | Audio duration in seconds |
| `confidence` | number | Overall confidence score | | `confidence` | number | Overall confidence score |
| `sentiment` | array | Sentiment analysis results | | `sentiment` | array | Sentiment analysis results |
| ↳ `text` | string | Text that was analyzed |
| ↳ `sentiment` | string | Sentiment \(POSITIVE, NEGATIVE, NEUTRAL\) |
| ↳ `confidence` | number | Confidence score |
| ↳ `start` | number | Start time in milliseconds |
| ↳ `end` | number | End time in milliseconds |
| `entities` | array | Detected entities | | `entities` | array | Detected entities |
| ↳ `entity_type` | string | Entity type \(e.g., person_name, location, organization\) |
| ↳ `text` | string | Entity text |
| ↳ `start` | number | Start time in milliseconds |
| ↳ `end` | number | End time in milliseconds |
| `summary` | string | Auto-generated summary | | `summary` | string | Auto-generated summary |
### `stt_gemini` ### `stt_gemini`
@@ -203,7 +178,7 @@ Transcribe audio to text using Google Gemini with multimodal capabilities
| `provider` | string | Yes | STT provider \(gemini\) | | `provider` | string | Yes | STT provider \(gemini\) |
| `apiKey` | string | Yes | Google API key | | `apiKey` | string | Yes | Google API key |
| `model` | string | No | Gemini model to use \(default: gemini-2.5-flash\) | | `model` | string | No | Gemini model to use \(default: gemini-2.5-flash\) |
| `audioFile` | file | No | Audio or video file to transcribe \(e.g., MP3, WAV, M4A, WEBM\) | | `audioFile` | file | No | Audio or video file to transcribe |
| `audioFileReference` | file | No | Reference to audio/video file from previous blocks | | `audioFileReference` | file | No | Reference to audio/video file from previous blocks |
| `audioUrl` | string | No | URL to audio or video file | | `audioUrl` | string | No | URL to audio or video file |
| `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection | | `language` | string | No | Language code \(e.g., "en", "es", "fr"\) or "auto" for auto-detection |

View File

@@ -282,24 +282,9 @@ Introspect Supabase database schema to get table structures, columns, and relati
| ↳ `name` | string | Table name | | ↳ `name` | string | Table name |
| ↳ `schema` | string | Database schema name | | ↳ `schema` | string | Database schema name |
| ↳ `columns` | array | Array of column definitions | | ↳ `columns` | array | Array of column definitions |
| ↳ `name` | string | Column name |
| ↳ `type` | string | Column data type |
| ↳ `nullable` | boolean | Whether the column allows null values |
| ↳ `default` | string | Default value for the column |
| ↳ `isPrimaryKey` | boolean | Whether the column is a primary key |
| ↳ `isForeignKey` | boolean | Whether the column is a foreign key |
| ↳ `references` | object | Foreign key reference details |
| ↳ `table` | string | Referenced table name |
| ↳ `column` | string | Referenced column name |
| ↳ `primaryKey` | array | Array of primary key column names | | ↳ `primaryKey` | array | Array of primary key column names |
| ↳ `foreignKeys` | array | Array of foreign key relationships | | ↳ `foreignKeys` | array | Array of foreign key relationships |
| ↳ `column` | string | Local column name |
| ↳ `referencesTable` | string | Referenced table name |
| ↳ `referencesColumn` | string | Referenced column name |
| ↳ `indexes` | array | Array of index definitions | | ↳ `indexes` | array | Array of index definitions |
| ↳ `name` | string | Index name |
| ↳ `columns` | array | Columns included in the index |
| ↳ `unique` | boolean | Whether the index enforces uniqueness |
| `schemas` | array | List of schemas found in the database | | `schemas` | array | List of schemas found in the database |
### `supabase_storage_upload` ### `supabase_storage_upload`
@@ -325,9 +310,6 @@ Upload a file to a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Upload result including file path, bucket, and public URL | | `results` | object | Upload result including file path, bucket, and public URL |
| ↳ `id` | string | Unique identifier for the uploaded file |
| ↳ `path` | string | Path to the uploaded file within the bucket |
| ↳ `fullPath` | string | Full path including bucket name |
### `supabase_storage_download` ### `supabase_storage_download`
@@ -373,19 +355,6 @@ List files in a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | array | Array of file objects with metadata | | `results` | array | Array of file objects with metadata |
| ↳ `id` | string | Unique file identifier |
| ↳ `name` | string | File name |
| ↳ `bucket_id` | string | Bucket identifier the file belongs to |
| ↳ `owner` | string | Owner identifier |
| ↳ `created_at` | string | File creation timestamp |
| ↳ `updated_at` | string | Last update timestamp |
| ↳ `last_accessed_at` | string | Last access timestamp |
| ↳ `metadata` | object | File metadata including size and MIME type |
| ↳ `size` | number | File size in bytes |
| ↳ `mimetype` | string | MIME type of the file |
| ↳ `cacheControl` | string | Cache control header value |
| ↳ `lastModified` | string | Last modified timestamp |
| ↳ `eTag` | string | Entity tag for caching |
### `supabase_storage_delete` ### `supabase_storage_delete`
@@ -406,13 +375,6 @@ Delete files from a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | array | Array of deleted file objects | | `results` | array | Array of deleted file objects |
| ↳ `name` | string | Name of the deleted file |
| ↳ `bucket_id` | string | Bucket identifier |
| ↳ `owner` | string | Owner identifier |
| ↳ `id` | string | Unique file identifier |
| ↳ `updated_at` | string | Last update timestamp |
| ↳ `created_at` | string | File creation timestamp |
| ↳ `last_accessed_at` | string | Last access timestamp |
### `supabase_storage_move` ### `supabase_storage_move`
@@ -434,7 +396,6 @@ Move a file within a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Move operation result | | `results` | object | Move operation result |
| ↳ `message` | string | Operation status message |
### `supabase_storage_copy` ### `supabase_storage_copy`
@@ -456,7 +417,6 @@ Copy a file within a Supabase storage bucket
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Copy operation result | | `results` | object | Copy operation result |
| ↳ `message` | string | Operation status message |
### `supabase_storage_create_bucket` ### `supabase_storage_create_bucket`
@@ -479,7 +439,6 @@ Create a new storage bucket in Supabase
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Created bucket information | | `results` | object | Created bucket information |
| ↳ `name` | string | Created bucket name |
### `supabase_storage_list_buckets` ### `supabase_storage_list_buckets`
@@ -498,14 +457,6 @@ List all storage buckets in Supabase
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | array | Array of bucket objects | | `results` | array | Array of bucket objects |
| ↳ `id` | string | Unique bucket identifier |
| ↳ `name` | string | Bucket name |
| ↳ `owner` | string | Owner identifier |
| ↳ `public` | boolean | Whether the bucket is publicly accessible |
| ↳ `created_at` | string | Bucket creation timestamp |
| ↳ `updated_at` | string | Last update timestamp |
| ↳ `file_size_limit` | number | Maximum file size allowed in bytes |
| ↳ `allowed_mime_types` | array | List of allowed MIME types for uploads |
### `supabase_storage_delete_bucket` ### `supabase_storage_delete_bucket`
@@ -525,7 +476,6 @@ Delete a storage bucket in Supabase
| --------- | ---- | ----------- | | --------- | ---- | ----------- |
| `message` | string | Operation status message | | `message` | string | Operation status message |
| `results` | object | Delete operation result | | `results` | object | Delete operation result |
| ↳ `message` | string | Operation status message |
### `supabase_storage_get_public_url` ### `supabase_storage_get_public_url`

Some files were not shown because too many files have changed in this diff Show More