Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

feat: added doc on custom tools (#1624)

Siddharth Balyan314b4cc97aa0
diff --git a/fern/docs.yml b/fern/docs.yml
index 46f876629..54ac97a34 100644
--- a/fern/docs.yml
+++ b/fern/docs.yml
@@ -1,13 +1,13 @@
# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
instances:
- - url: v3composio.docs.buildwithfern.com
- custom-domain: v3.docs.composio.dev
- edit-this-page:
- github:
- owner: ComposioHQ
- repo: composio
- branch: master
+- url: v3composio.docs.buildwithfern.com
+ custom-domain: v3.docs.composio.dev
+ edit-this-page:
+ github:
+ owner: ComposioHQ
+ repo: composio
+ branch: master
title: Composio Docs
default-language: typescript # TODO: change to python
@@ -19,40 +19,40 @@ logo:
href: /
favicon: assets/favicon.png
js:
- - path: js/search.js
- strategy: afterInteractive
+- path: js/search.js
+ strategy: afterInteractive
# css: dist/output.css
typography:
bodyFont:
name: Roobert
paths:
- - path: assets/Roobert-Medium.woff2
- weight: '500'
- - path: assets/Roobert-Regular.woff2
- weight: '400'
+ - path: assets/Roobert-Medium.woff2
+ weight: '500'
+ - path: assets/Roobert-Regular.woff2
+ weight: '400'
headingsFont:
name: Roobert
paths:
# - path: assets/FlechTestSRegular.woff2
# weight: "400"
- - path: assets/Roobert-Medium.woff2
- weight: '500'
- - path: assets/Roobert-Regular.woff2
- weight: '400'
+ - path: assets/Roobert-Medium.woff2
+ weight: '500'
+ - path: assets/Roobert-Regular.woff2
+ weight: '400'
codeFont:
name: IBM Plex Mono
paths:
- - path: assets/IBMPlexMono-Light.ttf
- weight: '400'
+ - path: assets/IBMPlexMono-Light.ttf
+ weight: '400'
# - path: assets/IBMPlexMono-Medium.woff2
# weight: "500 525"
navbar-links:
- - type: primary
- text: V1 Docs
- url: https://docs.composio.dev
- - type: filled
- text: LOG IN
- url: https://app.composio.dev/login
+- type: primary
+ text: V1 Docs
+ url: https://docs.composio.dev
+- type: filled
+ text: LOG IN
+ url: https://app.composio.dev/login
layout:
page-width: full
tabs-placement: header
@@ -80,8 +80,8 @@ colors:
# dark: "#292929"
experimental:
mdx-components:
- - ./components
- - ./icons
+ - ./components
+ - ./icons
disable-stream-toggle: true
analytics:
posthog:
@@ -121,787 +121,788 @@ tabs:
# path: pages/index.mdx
navigation:
- - tab: docs
- layout:
- - section: Get Started
- icon: rocket
- skip-slug: true
- contents:
- - page: Welcome
- path: pages/get-started/welcome.mdx
- slug: welcome
- - page: Quickstart
- path: pages/get-started/quickstart.mdx
- slug: quickstart
- - page: Providers
- path: pages/get-started/providers.mdx
- slug: providers
- - section: Tools
- icon: tools
- skip-slug: true
- contents:
- - page: Executing Tools
- path: pages/tool-calling/executing-tools.mdx
- slug: executing-tools
- - page: Authenticating Tools
- path: pages/tool-calling/authenticating-tools.mdx
- slug: authenticating-tools
- - page: Fetch and Filter Tools
- path: pages/tool-calling/fetching-tools.mdx
- slug: fetching-tools
- - section: Modifiers
- slug: modifiers
- contents:
- - page: Schema Modifiers
- path: pages/tool-calling/schema-modifiers.mdx
- slug: schema-modifiers
- - page: Before Tool Execution
- path: pages/tool-calling/before-execution-modifiers.mdx
- slug: before-execution
- - page: After Tool Execution
- path: pages/tool-calling/after-execution-modifiers.mdx
- slug: after-execution
- - page: Extending Toolkits with your own tools
- path: pages/tool-calling/extending-toolkits.mdx
- slug: extending-toolkits
- - section: Authentication
- icon: lock
- skip-slug: true
- contents:
- - page: Custom Auth Configs
- path: pages/authentication/custom-auth-configs.mdx
- slug: custom-auth-configs
- - page: Programmatic Auth Configs
- path: pages/authentication/programmatic-auth-configs.mdx
- slug: programmatic-auth-configs
- - page: Custom Auth Parameters
- path: pages/authentication/custom-auth-params.mdx
- slug: custom-auth-params
- - section: Triggers
- icon: bolt
- skip-slug: true
- contents:
- - page: Using Triggers
- path: pages/triggers/using-triggers.mdx
- slug: using-triggers
- - section: MCP
- icon: server
- skip-slug: true
- contents:
- - page: Introduction
- path: pages/mcp/introduction.mdx
- slug: mcp-introduction
- - tab: examples
- layout:
- - section: Getting Started
- icon: rocket
- skip-slug: true
- contents:
- - page: Hello World
- path: pages/examples/dist/hello-world.mdx
- slug: examples/hello-world
- - page: Sample Script
- path: pages/examples/dist/sample-script/sample-script.mdx
- slug: examples/sample-script
- - page: Sample Webserver
- path: pages/examples/dist/sample-webserver/sample-webserver.mdx
- slug: examples/sample-webserver
- - section: Full Stack Applications
- icon: globe
- skip-slug: true
- contents:
- - page: Full Stack Chat App
- path: pages/examples/dist/vercel-composio.mdx
- slug: full-stack-chat-app
- - section: Productivity & Automation
- icon: zap
- skip-slug: true
- contents:
- - page: Gmail Filterer
- path: pages/examples/dist/gmail-filterer.mdx
- slug: gmail-filterer
- - tab: providers
- layout:
- - section: Providers
- icon: code
- contents:
- - page: OpenAI Provider
- path: pages/providers/openai.mdx
- - page: Anthropic Provider
- path: pages/providers/anthropic.mdx
- - page: LangGraph Provider
- path: pages/providers/langgraph.mdx
- - page: CrewAI Provider
- path: pages/providers/crewai.mdx
- - page: Vercel AI SDK Provider
- path: pages/providers/vercel.mdx
- - page: Google ADK Provider
- path: pages/providers/google-adk.mdx
- - page: OpenAI Agents Provider
- path: pages/providers/openai-agents.mdx
- - page: Mastra Provider
- path: pages/providers/mastra.mdx
- - page: Custom Provider
- path: pages/providers/custom.mdx
- - tab: tools
- layout:
- - section: Tools
- contents:
- - page: Introduction
- path: tools/introduction.mdx
- - page: Ably
- path: tools/ably.mdx
- - page: Accelo
- path: tools/accelo.mdx
- - page: Acculynx
- path: tools/acculynx.mdx
- - page: Active Campaign
- path: tools/active_campaign.mdx
- - page: Adobe
- path: tools/adobe.mdx
- - page: Aero Workflow
- path: tools/aero_workflow.mdx
- - page: Affinity
- path: tools/affinity.mdx
- - page: Agencyzoom
- path: tools/agencyzoom.mdx
- - page: Ahrefs
- path: tools/ahrefs.mdx
- - page: Airtable
- path: tools/airtable.mdx
- - page: Alchemy
- path: tools/alchemy.mdx
- - page: Altoviz
- path: tools/altoviz.mdx
- - page: Amazon
- path: tools/amazon.mdx
- - page: Amcards
- path: tools/amcards.mdx
- - page: Amplitude
- path: tools/amplitude.mdx
- - page: Apaleo
- path: tools/apaleo.mdx
- - page: Apollo
- path: tools/apollo.mdx
- - page: Appdrag
- path: tools/appdrag.mdx
- - page: Appsflyer
- path: tools/appsflyer.mdx
- - page: Asana
- path: tools/asana.mdx
- - page: Ashby
- path: tools/ashby.mdx
- - page: Atlassian
- path: tools/atlassian.mdx
- - page: Attio
- path: tools/attio.mdx
- - page: Auth0
- path: tools/auth0.mdx
- - page: Axonaut
- path: tools/axonaut.mdx
- - page: Bamboohr
- path: tools/bamboohr.mdx
- - page: Bannerbear
- path: tools/bannerbear.mdx
- - page: Baserow
- path: tools/baserow.mdx
- - page: Battlenet
- path: tools/battlenet.mdx
- - page: Beeminder
- path: tools/beeminder.mdx
- - page: Bigmailer
- path: tools/bigmailer.mdx
- - page: Bitbucket
- path: tools/bitbucket.mdx
- - page: Bitwarden
- path: tools/bitwarden.mdx
- - page: Blackbaud
- path: tools/blackbaud.mdx
- - page: Blackboard
- path: tools/blackboard.mdx
- - page: Boldsign
- path: tools/boldsign.mdx
- - page: Bolna
- path: tools/bolna.mdx
- - page: Borneo
- path: tools/borneo.mdx
- - page: Botbaba
- path: tools/botbaba.mdx
- - page: Box
- path: tools/box.mdx
- - page: Braintree
- path: tools/braintree.mdx
- - page: Brandfetch
- path: tools/brandfetch.mdx
- - page: Breezy Hr
- path: tools/breezy_hr.mdx
- - page: Brevo
- path: tools/brevo.mdx
- - page: Brex
- path: tools/brex.mdx
- - page: Brex Staging
- path: tools/brex_staging.mdx
- - page: Brightpearl
- path: tools/brightpearl.mdx
- - page: Brilliant Directories
- path: tools/brilliant_directories.mdx
- - page: Browseai
- path: tools/browseai.mdx
- - page: Browserbase Tool
- path: tools/browserbase_tool.mdx
- - page: Browserhub
- path: tools/browserhub.mdx
- - page: Browserless
- path: tools/browserless.mdx
- - page: Bubble
- path: tools/bubble.mdx
- - page: Bugbug
- path: tools/bugbug.mdx
- - page: Cal
- path: tools/cal.mdx
- - page: Calendly
- path: tools/calendly.mdx
- - page: Canva
- path: tools/canva.mdx
- - page: Canvas
- path: tools/canvas.mdx
- - page: Chatwork
- path: tools/chatwork.mdx
- - page: Chmeetings
- path: tools/chmeetings.mdx
- - page: Clickup
- path: tools/clickup.mdx
- - page: Clockify
- path: tools/clockify.mdx
- - page: Close
- path: tools/close.mdx
- - page: Cloudflare
- path: tools/cloudflare.mdx
- - page: Coda
- path: tools/coda.mdx
- - page: Codeinterpreter
- path: tools/codeinterpreter.mdx
- - page: Coinbase
- path: tools/coinbase.mdx
- - page: Coinmarketcal
- path: tools/coinmarketcal.mdx
- - page: Composio
- path: tools/composio.mdx
- - page: Composio Search
- path: tools/composio_search.mdx
- - page: Confluence
- path: tools/confluence.mdx
- - page: Contentful
- path: tools/contentful.mdx
- - page: Crustdata
- path: tools/crustdata.mdx
- - page: Customer Io
- path: tools/customer_io.mdx
- - page: Cutt Ly
- path: tools/cutt_ly.mdx
- - page: D2Lbrightspace
- path: tools/d2lbrightspace.mdx
- - page: Dailybot
- path: tools/dailybot.mdx
- - page: Datadog
- path: tools/datadog.mdx
- - page: Datagma
- path: tools/datagma.mdx
- - page: Datarobot
- path: tools/datarobot.mdx
- - page: Deel
- path: tools/deel.mdx
- - page: Demio
- path: tools/demio.mdx
- - page: Dialpad
- path: tools/dialpad.mdx
- - page: Digicert
- path: tools/digicert.mdx
- - page: Discord
- path: tools/discord.mdx
- - page: Discordbot
- path: tools/discordbot.mdx
- - page: Docmosis
- path: tools/docmosis.mdx
- - page: Docusign
- path: tools/docusign.mdx
- - page: Dropbox
- path: tools/dropbox.mdx
- - page: Dropbox Sign
- path: tools/dropbox_sign.mdx
- - page: Dynamics365
- path: tools/dynamics365.mdx
- - page: Echtpost
- path: tools/echtpost.mdx
- - page: Elevenlabs
- path: tools/elevenlabs.mdx
- - page: Emailoctopus
- path: tools/emailoctopus.mdx
- - page: Enigma
- path: tools/enigma.mdx
- - page: Entelligence
- path: tools/entelligence.mdx
- - page: Epic Games
- path: tools/epic_games.mdx
- - page: Eventbrite
- path: tools/eventbrite.mdx
- - page: Exa
- path: tools/exa.mdx
- - page: Excel
- path: tools/excel.mdx
- - page: Exist
- path: tools/exist.mdx
- - page: Facebook
- path: tools/facebook.mdx
- - page: Factorial
- path: tools/factorial.mdx
- - page: Figma
- path: tools/figma.mdx
- - page: Finage
- path: tools/finage.mdx
- - page: Firecrawl
- path: tools/firecrawl.mdx
- - page: Fireflies
- path: tools/fireflies.mdx
- - page: Fitbit
- path: tools/fitbit.mdx
- - page: Flutterwave
- path: tools/flutterwave.mdx
- - page: Fomo
- path: tools/fomo.mdx
- - page: Formcarry
- path: tools/formcarry.mdx
- - page: Formsite
- path: tools/formsite.mdx
- - page: Foursquare
- path: tools/foursquare.mdx
- - page: Freshbooks
- path: tools/freshbooks.mdx
- - page: Freshdesk
- path: tools/freshdesk.mdx
- - page: Front
- path: tools/front.mdx
- - page: Github
- path: tools/github.mdx
- - page: Gmail
- path: tools/gmail.mdx
- - page: Go To Webinar
- path: tools/go_to_webinar.mdx
- - page: Gong
- path: tools/gong.mdx
- - page: Google Analytics
- path: tools/google_analytics.mdx
- - page: Google Maps
- path: tools/google_maps.mdx
- - page: Googleads
- path: tools/googleads.mdx
- - page: Googlebigquery
- path: tools/googlebigquery.mdx
- - page: Googlecalendar
- path: tools/googlecalendar.mdx
- - page: Googledocs
- path: tools/googledocs.mdx
- - page: Googledrive
- path: tools/googledrive.mdx
- - page: Googlemeet
- path: tools/googlemeet.mdx
- - page: Googlephotos
- path: tools/googlephotos.mdx
- - page: Googlesheets
- path: tools/googlesheets.mdx
- - page: Googlesuper
- path: tools/googlesuper.mdx
- - page: Googletasks
- path: tools/googletasks.mdx
- - page: Gorgias
- path: tools/gorgias.mdx
- - page: Gumroad
- path: tools/gumroad.mdx
- - page: Guru
- path: tools/guru.mdx
- - page: Hackernews
- path: tools/hackernews.mdx
- - page: Hackerrank Work
- path: tools/hackerrank_work.mdx
- - page: Harvest
- path: tools/harvest.mdx
- - page: Helcim
- path: tools/helcim.mdx
- - page: Heygen
- path: tools/heygen.mdx
- - page: Highlevel
- path: tools/highlevel.mdx
- - page: Hubspot
- path: tools/hubspot.mdx
- - page: Humanloop
- path: tools/humanloop.mdx
- - page: Icims Talent Cloud
- path: tools/icims_talent_cloud.mdx
- - page: Idea Scale
- path: tools/idea_scale.mdx
- - page: Intercom
- path: tools/intercom.mdx
- - page: Interzoid
- path: tools/interzoid.mdx
- - page: Jira
- path: tools/jira.mdx
- - page: Junglescout
- path: tools/junglescout.mdx
- - page: Keap
- path: tools/keap.mdx
- - page: Klaviyo
- path: tools/klaviyo.mdx
- - page: Klipfolio
- path: tools/klipfolio.mdx
- - page: Kommo
- path: tools/kommo.mdx
- - page: Lastpass
- path: tools/lastpass.mdx
- - page: Launch Darkly
- path: tools/launch_darkly.mdx
- - page: Leadfeeder
- path: tools/leadfeeder.mdx
- - page: Leadoku
- path: tools/leadoku.mdx
- - page: Lever
- path: tools/lever.mdx
- - page: Lever Sandbox
- path: tools/lever_sandbox.mdx
- - page: Lexoffice
- path: tools/lexoffice.mdx
- - page: Linear
- path: tools/linear.mdx
- - page: Linkedin
- path: tools/linkedin.mdx
- - page: Linkhut
- path: tools/linkhut.mdx
- - page: Linkup
- path: tools/linkup.mdx
- - page: Listennotes
- path: tools/listennotes.mdx
- - page: Lmnt
- path: tools/lmnt.mdx
- - page: Lodgify
- path: tools/lodgify.mdx
- - page: Mailchimp
- path: tools/mailchimp.mdx
- - page: Mailerlite
- path: tools/mailerlite.mdx
- - page: Maintainx
- path: tools/maintainx.mdx
- - page: Mboum
- path: tools/mboum.mdx
- - page: Mem0
- path: tools/mem0.mdx
- - page: Metaads
- path: tools/metaads.mdx
- - page: Metatextai
- path: tools/metatextai.mdx
- - page: Microsoft Clarity
- path: tools/microsoft_clarity.mdx
- - page: Microsoft Teams
- path: tools/microsoft_teams.mdx
- - page: Microsoft Tenant
- path: tools/microsoft_tenant.mdx
- - page: Miro
- path: tools/miro.mdx
- - page: Mixpanel
- path: tools/mixpanel.mdx
- - page: Mocean
- path: tools/mocean.mdx
- - page: Monday
- path: tools/monday.mdx
- - page: Mopinion
- path: tools/mopinion.mdx
- - page: More Trees
- path: tools/more_trees.mdx
- - page: Moxie
- path: tools/moxie.mdx
- - page: Moz
- path: tools/moz.mdx
- - page: Mural
- path: tools/mural.mdx
- - page: Ncscale
- path: tools/ncscale.mdx
- - page: Neon
- path: tools/neon.mdx
- - page: Netsuite
- path: tools/netsuite.mdx
- - page: Nextdns
- path: tools/nextdns.mdx
- - page: Ngrok
- path: tools/ngrok.mdx
- - page: Notion
- path: tools/notion.mdx
- - page: Oncehub
- path: tools/oncehub.mdx
- - page: One Drive
- path: tools/one_drive.mdx
- - page: Onepage
- path: tools/onepage.mdx
- - page: Open Sea
- path: tools/open_sea.mdx
- - page: Outlook
- path: tools/outlook.mdx
- - page: Pagerduty
- path: tools/pagerduty.mdx
- - page: Pandadoc
- path: tools/pandadoc.mdx
- - page: Peopledatalabs
- path: tools/peopledatalabs.mdx
- - page: Perplexityai
- path: tools/perplexityai.mdx
- - page: Piggy
- path: tools/piggy.mdx
- - page: Pipedrive
- path: tools/pipedrive.mdx
- - page: Placekey
- path: tools/placekey.mdx
- - page: Posthog
- path: tools/posthog.mdx
- - page: Precoro
- path: tools/precoro.mdx
- - page: Printnode
- path: tools/printnode.mdx
- - page: Process Street
- path: tools/process_street.mdx
- - page: Productboard
- path: tools/productboard.mdx
- - page: Qualaroo
- path: tools/qualaroo.mdx
- - page: Quickbooks
- path: tools/quickbooks.mdx
- - page: Rafflys
- path: tools/rafflys.mdx
- - page: Ragic
- path: tools/ragic.mdx
- - page: Ramp
- path: tools/ramp.mdx
- - page: Ravenseotools
- path: tools/ravenseotools.mdx
- - page: Recallai
- path: tools/recallai.mdx
- - page: Reddit
- path: tools/reddit.mdx
- - page: Resend
- path: tools/resend.mdx
- - page: Retellai
- path: tools/retellai.mdx
- - page: Ring Central
- path: tools/ring_central.mdx
- - page: Rippling
- path: tools/rippling.mdx
- - page: Rocket Reach
- path: tools/rocket_reach.mdx
- - page: Rocketlane
- path: tools/rocketlane.mdx
- - page: Rootly
- path: tools/rootly.mdx
- - page: Rosette Text Analytics
- path: tools/rosette_text_analytics.mdx
- - page: Sage
- path: tools/sage.mdx
- - page: Salesforce
- path: tools/salesforce.mdx
- - page: Scrape Do
- path: tools/scrape_do.mdx
- - page: Scrapingant
- path: tools/scrapingant.mdx
- - page: Screenshotone
- path: tools/screenshotone.mdx
- - page: Seismic
- path: tools/seismic.mdx
- - page: Semanticscholar
- path: tools/semanticscholar.mdx
- - page: Semrush
- path: tools/semrush.mdx
- - page: Sendgrid
- path: tools/sendgrid.mdx
- - page: Sentry
- path: tools/sentry.mdx
- - page: Serpapi
- path: tools/serpapi.mdx
- - page: Servicem8
- path: tools/servicem8.mdx
- - page: Servicenow
- path: tools/servicenow.mdx
- - page: Share Point
- path: tools/share_point.mdx
- - page: Shopify
- path: tools/shopify.mdx
- - page: Shortcut
- path: tools/shortcut.mdx
- - page: Simplesat
- path: tools/simplesat.mdx
- - page: Slack
- path: tools/slack.mdx
- - page: Slackbot
- path: tools/slackbot.mdx
- - page: Smartrecruiters
- path: tools/smartrecruiters.mdx
- - page: Smugmug
- path: tools/smugmug.mdx
- - page: Snowflake
- path: tools/snowflake.mdx
- - page: Square
- path: tools/square.mdx
- - page: Stack Exchange
- path: tools/stack_exchange.mdx
- - page: Starton
- path: tools/starton.mdx
- - page: Stripe
- path: tools/stripe.mdx
- - page: Supabase
- path: tools/supabase.mdx
- - page: Survey Monkey
- path: tools/survey_monkey.mdx
- - page: Tapform
- path: tools/tapform.mdx
- - page: Tavily
- path: tools/tavily.mdx
- - page: Terminus
- path: tools/terminus.mdx
- - page: Text To Pdf
- path: tools/text_to_pdf.mdx
- - page: Textrazor
- path: tools/textrazor.mdx
- - page: Timecamp
- path: tools/timecamp.mdx
- - page: Timekit
- path: tools/timekit.mdx
- - page: Timely
- path: tools/timely.mdx
- - page: Tinypng
- path: tools/tinypng.mdx
- - page: Tinyurl
- path: tools/tinyurl.mdx
- - page: Tisane
- path: tools/tisane.mdx
- - page: Todoist
- path: tools/todoist.mdx
- - page: Toneden
- path: tools/toneden.mdx
- - page: Tpscheck
- path: tools/tpscheck.mdx
- - page: Trello
- path: tools/trello.mdx
- - page: Twitch
- path: tools/twitch.mdx
- - page: Twitter
- path: tools/twitter.mdx
- - page: Twitter Media
- path: tools/twitter_media.mdx
- - page: Typefully
- path: tools/typefully.mdx
- - page: Venly
- path: tools/venly.mdx
- - page: Vero
- path: tools/vero.mdx
- - page: Visme
- path: tools/visme.mdx
- - page: Waboxapp
- path: tools/waboxapp.mdx
- - page: Wakatime
- path: tools/wakatime.mdx
- - page: Wave Accounting
- path: tools/wave_accounting.mdx
- - page: Weathermap
- path: tools/weathermap.mdx
- - page: Webex
- path: tools/webex.mdx
- - page: Webflow
- path: tools/webflow.mdx
- - page: Whatsapp
- path: tools/whatsapp.mdx
- - page: Wiz
- path: tools/wiz.mdx
- - page: Workiom
- path: tools/workiom.mdx
- - page: Wrike
- path: tools/wrike.mdx
- - page: Xero
- path: tools/xero.mdx
- - page: Yandex
- path: tools/yandex.mdx
- - page: Ynab
- path: tools/ynab.mdx
- - page: Yousearch
- path: tools/yousearch.mdx
- - page: Youtube
- path: tools/youtube.mdx
- - page: Zendesk
- path: tools/zendesk.mdx
- - page: Zenrows
- path: tools/zenrows.mdx
- - page: Zenserp
- path: tools/zenserp.mdx
- - page: Zoho
- path: tools/zoho.mdx
- - page: Zoho Bigin
- path: tools/zoho_bigin.mdx
- - page: Zoho Books
- path: tools/zoho_books.mdx
- - page: Zoho Desk
- path: tools/zoho_desk.mdx
- - page: Zoho Inventory
- path: tools/zoho_inventory.mdx
- - page: Zoho Invoice
- path: tools/zoho_invoice.mdx
- - page: Zoho Mail
- path: tools/zoho_mail.mdx
- - page: Zoom
- path: tools/zoom.mdx
- - page: Zoominfo
- path: tools/zoominfo.mdx
- - tab: sdk-reference
- layout:
- - section: Python
- icon: python
- contents:
- - page: Python SDK
- path: pages/sdk/python/index.mdx
- - section: TypeScript
- icon: typescript
- contents:
- - section: Core Classes
- slug: core-classes
- contents:
- - page: Composio
- path: pages/sdk/typescript/composio/classes/Composio.mdx
- - page: ComposioProvider
- path: pages/sdk/typescript/provider/ComposioProvider/classes/ComposioProvider.mdx
- - page: OpenAIProvider
- path: pages/sdk/typescript/provider/OpenAIProvider/classes/OpenAIProvider.mdx
- - page: BaseAgenticProvider
- path: pages/sdk/typescript/provider/BaseProvider/classes/BaseAgenticProvider.mdx
- - page: BaseNonAgenticProvider
- path: pages/sdk/typescript/provider/BaseProvider/classes/BaseNonAgenticProvider.mdx
- - section: Models
- slug: models
- contents:
- - page: Tools
- path: pages/sdk/typescript/models/Tools/classes/Tools.mdx
- - page: Toolkits
- path: pages/sdk/typescript/models/Toolkits/classes/Toolkits.mdx
- - page: Triggers
- path: pages/sdk/typescript/models/Triggers/classes/Triggers.mdx
- - page: AuthConfigs
- path: pages/sdk/typescript/AuthConfigs/classes/AuthConfigs.mdx
- - page: ConnectedAccounts
- path: pages/sdk/typescript/ConnectedAccounts/classes/ConnectedAccounts.mdx
- - page: ConnectionRequest
- path: pages/sdk/typescript/ConnectionRequest/classes/ConnectionRequest.mdx
- - page: CustomTools
- path: pages/sdk/typescript/CustomTools/classes/CustomTools.mdx
- - page: Session
- path: pages/sdk/typescript/models/Session/classes/Session.mdx
- - tab: api-reference
- layout:
- - section: API Reference
- contents:
- - api: v3
- api-name: v3
- skip-slug: true
- paginated: false
- flattened: true
- - tab: changelog
+- tab: docs
+ layout:
+ - section: Get Started
+ icon: rocket
+ skip-slug: true
+ contents:
+ - page: Welcome
+ path: pages/get-started/welcome.mdx
+ slug: welcome
+ - page: Quickstart
+ path: pages/get-started/quickstart.mdx
+ slug: quickstart
+ - page: Configuration
+ path: pages/get-started/configuration.mdx
+ slug: configuration
+ - page: Providers
+ path: pages/get-started/providers.mdx
+ slug: providers
+ - section: Tools
+ icon: tools
+ skip-slug: true
+ contents:
+ - page: Executing Tools
+ path: pages/tool-calling/executing-tools.mdx
+ slug: executing-tools
+ - page: Authenticating Tools
+ path: pages/tool-calling/authenticating-tools.mdx
+ slug: authenticating-tools
+ - page: Fetch and Filter Tools
+ path: pages/tool-calling/fetching-tools.mdx
+ slug: fetching-tools
+ - section: Modifiers
+ slug: modifiers
+ contents:
+ - page: Schema Modifiers
+ path: pages/tool-calling/schema-modifiers.mdx
+ slug: schema-modifiers
+ - page: Before Tool Execution
+ path: pages/tool-calling/before-execution-modifiers.mdx
+ slug: before-execution
+ - page: After Tool Execution
+ path: pages/tool-calling/after-execution-modifiers.mdx
+ slug: after-execution
+ - page: Custom tools
+ path: pages/tool-calling/custom-tools.mdx
+ slug: custom-tools
+ - section: Authentication
+ icon: lock
+ skip-slug: true
+ contents:
+ - page: Custom Auth Configs
+ path: pages/authentication/custom-auth-configs.mdx
+ slug: custom-auth-configs
+ - page: Programmatic Auth Configs
+ path: pages/authentication/programmatic-auth-configs.mdx
+ slug: programmatic-auth-configs
+ - page: Custom Auth Parameters
+ path: pages/authentication/custom-auth-params.mdx
+ slug: custom-auth-params
+ - section: Triggers
+ icon: bolt
+ skip-slug: true
+ contents:
+ - page: Using Triggers
+ path: pages/triggers/using-triggers.mdx
+ slug: using-triggers
+ - section: MCP
+ icon: server
+ skip-slug: true
+ contents:
+ - page: Introduction
+ path: pages/mcp/introduction.mdx
+ slug: mcp-introduction
+- tab: examples
+ layout:
+ - section: Getting Started
+ icon: rocket
+ skip-slug: true
+ contents:
+ - page: Hello World
+ path: pages/examples/dist/hello-world.mdx
+ slug: examples/hello-world
+ - page: Sample Script
+ path: pages/examples/dist/sample-script/sample-script.mdx
+ slug: examples/sample-script
+ - page: Sample Webserver
+ path: pages/examples/dist/sample-webserver/sample-webserver.mdx
+ slug: examples/sample-webserver
+ - section: Full Stack Applications
+ icon: globe
+ skip-slug: true
+ contents:
+ - page: Full Stack Chat App
+ path: pages/examples/dist/vercel-composio.mdx
+ slug: full-stack-chat-app
+ - section: Productivity & Automation
+ icon: zap
+ skip-slug: true
+ contents:
+ - page: Gmail Filterer
+ path: pages/examples/dist/gmail-filterer.mdx
+ slug: gmail-filterer
+- tab: providers
+ layout:
+ - section: Providers
+ icon: code
+ contents:
+ - page: OpenAI Provider
+ path: pages/providers/openai.mdx
+ - page: Anthropic Provider
+ path: pages/providers/anthropic.mdx
+ - page: LangGraph Provider
+ path: pages/providers/langgraph.mdx
+ - page: CrewAI Provider
+ path: pages/providers/crewai.mdx
+ - page: Vercel AI SDK Provider
+ path: pages/providers/vercel.mdx
+ - page: Google ADK Provider
+ path: pages/providers/google-adk.mdx
+ - page: OpenAI Agents Provider
+ path: pages/providers/openai-agents.mdx
+ - page: Mastra Provider
+ path: pages/providers/mastra.mdx
+ - page: Custom Provider
+ path: pages/providers/custom.mdx
+- tab: tools
+ layout:
+ - section: Tools
+ contents:
+ - page: Introduction
+ path: tools/introduction.mdx
+ - page: Ably
+ path: tools/ably.mdx
+ - page: Accelo
+ path: tools/accelo.mdx
+ - page: Acculynx
+ path: tools/acculynx.mdx
+ - page: Active Campaign
+ path: tools/active_campaign.mdx
+ - page: Adobe
+ path: tools/adobe.mdx
+ # - page: Aero Workflow
+ # path: tools/aero_workflow.mdx
+ # - page: Affinity
+ # path: tools/affinity.mdx
+ # - page: Agencyzoom
+ # path: tools/agencyzoom.mdx
+ # - page: Ahrefs
+ # path: tools/ahrefs.mdx
+ # - page: Airtable
+ # path: tools/airtable.mdx
+ # - page: Alchemy
+ # path: tools/alchemy.mdx
+ # - page: Altoviz
+ # path: tools/altoviz.mdx
+ # - page: Amazon
+ # path: tools/amazon.mdx
+ # - page: Amcards
+ # path: tools/amcards.mdx
+ # - page: Amplitude
+ # path: tools/amplitude.mdx
+ # - page: Apaleo
+ # path: tools/apaleo.mdx
+ # - page: Apollo
+ # path: tools/apollo.mdx
+ # - page: Appdrag
+ # path: tools/appdrag.mdx
+ # - page: Appsflyer
+ # path: tools/appsflyer.mdx
+ # - page: Asana
+ # path: tools/asana.mdx
+ # - page: Ashby
+ # path: tools/ashby.mdx
+ # - page: Atlassian
+ # path: tools/atlassian.mdx
+ # - page: Attio
+ # path: tools/attio.mdx
+ # - page: Auth0
+ # path: tools/auth0.mdx
+ # - page: Axonaut
+ # path: tools/axonaut.mdx
+ # - page: Bamboohr
+ # path: tools/bamboohr.mdx
+ # - page: Bannerbear
+ # path: tools/bannerbear.mdx
+ # - page: Baserow
+ # path: tools/baserow.mdx
+ # - page: Battlenet
+ # path: tools/battlenet.mdx
+ # - page: Beeminder
+ # path: tools/beeminder.mdx
+ # - page: Bigmailer
+ # path: tools/bigmailer.mdx
+ # - page: Bitbucket
+ # path: tools/bitbucket.mdx
+ # - page: Bitwarden
+ # path: tools/bitwarden.mdx
+ # - page: Blackbaud
+ # path: tools/blackbaud.mdx
+ # - page: Blackboard
+ # path: tools/blackboard.mdx
+ # - page: Boldsign
+ # path: tools/boldsign.mdx
+ # - page: Bolna
+ # path: tools/bolna.mdx
+ # - page: Borneo
+ # path: tools/borneo.mdx
+ # - page: Botbaba
+ # path: tools/botbaba.mdx
+ # - page: Box
+ # path: tools/box.mdx
+ # - page: Braintree
+ # path: tools/braintree.mdx
+ # - page: Brandfetch
+ # path: tools/brandfetch.mdx
+ # - page: Breezy Hr
+ # path: tools/breezy_hr.mdx
+ # - page: Brevo
+ # path: tools/brevo.mdx
+ # - page: Brex
+ # path: tools/brex.mdx
+ # - page: Brex Staging
+ # path: tools/brex_staging.mdx
+ # - page: Brightpearl
+ # path: tools/brightpearl.mdx
+ # - page: Brilliant Directories
+ # path: tools/brilliant_directories.mdx
+ # - page: Browseai
+ # path: tools/browseai.mdx
+ # - page: Browserbase Tool
+ # path: tools/browserbase_tool.mdx
+ # - page: Browserhub
+ # path: tools/browserhub.mdx
+ # - page: Browserless
+ # path: tools/browserless.mdx
+ # - page: Bubble
+ # path: tools/bubble.mdx
+ # - page: Bugbug
+ # path: tools/bugbug.mdx
+ # - page: Cal
+ # path: tools/cal.mdx
+ # - page: Calendly
+ # path: tools/calendly.mdx
+ # - page: Canva
+ # path: tools/canva.mdx
+ # - page: Canvas
+ # path: tools/canvas.mdx
+ # - page: Chatwork
+ # path: tools/chatwork.mdx
+ # - page: Chmeetings
+ # path: tools/chmeetings.mdx
+ # - page: Clickup
+ # path: tools/clickup.mdx
+ # - page: Clockify
+ # path: tools/clockify.mdx
+ # - page: Close
+ # path: tools/close.mdx
+ # - page: Cloudflare
+ # path: tools/cloudflare.mdx
+ # - page: Coda
+ # path: tools/coda.mdx
+ # - page: Codeinterpreter
+ # path: tools/codeinterpreter.mdx
+ # - page: Coinbase
+ # path: tools/coinbase.mdx
+ # - page: Coinmarketcal
+ # path: tools/coinmarketcal.mdx
+ # - page: Composio
+ # path: tools/composio.mdx
+ # - page: Composio Search
+ # path: tools/composio_search.mdx
+ # - page: Confluence
+ # path: tools/confluence.mdx
+ # - page: Contentful
+ # path: tools/contentful.mdx
+ # - page: Crustdata
+ # path: tools/crustdata.mdx
+ # - page: Customer Io
+ # path: tools/customer_io.mdx
+ # - page: Cutt Ly
+ # path: tools/cutt_ly.mdx
+ # - page: D2Lbrightspace
+ # path: tools/d2lbrightspace.mdx
+ # - page: Dailybot
+ # path: tools/dailybot.mdx
+ # - page: Datadog
+ # path: tools/datadog.mdx
+ # - page: Datagma
+ # path: tools/datagma.mdx
+ # - page: Datarobot
+ # path: tools/datarobot.mdx
+ # - page: Deel
+ # path: tools/deel.mdx
+ # - page: Demio
+ # path: tools/demio.mdx
+ # - page: Dialpad
+ # path: tools/dialpad.mdx
+ # - page: Digicert
+ # path: tools/digicert.mdx
+ # - page: Discord
+ # path: tools/discord.mdx
+ # - page: Discordbot
+ # path: tools/discordbot.mdx
+ # - page: Docmosis
+ # path: tools/docmosis.mdx
+ # - page: Docusign
+ # path: tools/docusign.mdx
+ # - page: Dropbox
+ # path: tools/dropbox.mdx
+ # - page: Dropbox Sign
+ # path: tools/dropbox_sign.mdx
+ # - page: Dynamics365
+ # path: tools/dynamics365.mdx
+ # - page: Echtpost
+ # path: tools/echtpost.mdx
+ # - page: Elevenlabs
+ # path: tools/elevenlabs.mdx
+ # - page: Emailoctopus
+ # path: tools/emailoctopus.mdx
+ # - page: Enigma
+ # path: tools/enigma.mdx
+ # - page: Entelligence
+ # path: tools/entelligence.mdx
+ # - page: Epic Games
+ # path: tools/epic_games.mdx
+ # - page: Eventbrite
+ # path: tools/eventbrite.mdx
+ # - page: Exa
+ # path: tools/exa.mdx
+ # - page: Excel
+ # path: tools/excel.mdx
+ # - page: Exist
+ # path: tools/exist.mdx
+ # - page: Facebook
+ # path: tools/facebook.mdx
+ # - page: Factorial
+ # path: tools/factorial.mdx
+ # - page: Figma
+ # path: tools/figma.mdx
+ # - page: Finage
+ # path: tools/finage.mdx
+ # - page: Firecrawl
+ # path: tools/firecrawl.mdx
+ # - page: Fireflies
+ # path: tools/fireflies.mdx
+ # - page: Fitbit
+ # path: tools/fitbit.mdx
+ # - page: Flutterwave
+ # path: tools/flutterwave.mdx
+ # - page: Fomo
+ # path: tools/fomo.mdx
+ # - page: Formcarry
+ # path: tools/formcarry.mdx
+ # - page: Formsite
+ # path: tools/formsite.mdx
+ # - page: Foursquare
+ # path: tools/foursquare.mdx
+ # - page: Freshbooks
+ # path: tools/freshbooks.mdx
+ # - page: Freshdesk
+ # path: tools/freshdesk.mdx
+ # - page: Front
+ # path: tools/front.mdx
+ # - page: Github
+ # path: tools/github.mdx
+ # - page: Gmail
+ # path: tools/gmail.mdx
+ # - page: Go To Webinar
+ # path: tools/go_to_webinar.mdx
+ # - page: Gong
+ # path: tools/gong.mdx
+ # - page: Google Analytics
+ # path: tools/google_analytics.mdx
+ # - page: Google Maps
+ # path: tools/google_maps.mdx
+ # - page: Googleads
+ # path: tools/googleads.mdx
+ # - page: Googlebigquery
+ # path: tools/googlebigquery.mdx
+ # - page: Googlecalendar
+ # path: tools/googlecalendar.mdx
+ # - page: Googledocs
+ # path: tools/googledocs.mdx
+ # - page: Googledrive
+ # path: tools/googledrive.mdx
+ # - page: Googlemeet
+ # path: tools/googlemeet.mdx
+ # - page: Googlephotos
+ # path: tools/googlephotos.mdx
+ # - page: Googlesheets
+ # path: tools/googlesheets.mdx
+ # - page: Googlesuper
+ # path: tools/googlesuper.mdx
+ # - page: Googletasks
+ # path: tools/googletasks.mdx
+ # - page: Gorgias
+ # path: tools/gorgias.mdx
+ # - page: Gumroad
+ # path: tools/gumroad.mdx
+ # - page: Guru
+ # path: tools/guru.mdx
+ # - page: Hackernews
+ # path: tools/hackernews.mdx
+ # - page: Hackerrank Work
+ # path: tools/hackerrank_work.mdx
+ # - page: Harvest
+ # path: tools/harvest.mdx
+ # - page: Helcim
+ # path: tools/helcim.mdx
+ # - page: Heygen
+ # path: tools/heygen.mdx
+ # - page: Highlevel
+ # path: tools/highlevel.mdx
+ # - page: Hubspot
+ # path: tools/hubspot.mdx
+ # - page: Humanloop
+ # path: tools/humanloop.mdx
+ # - page: Icims Talent Cloud
+ # path: tools/icims_talent_cloud.mdx
+ # - page: Idea Scale
+ # path: tools/idea_scale.mdx
+ # - page: Intercom
+ # path: tools/intercom.mdx
+ # - page: Interzoid
+ # path: tools/interzoid.mdx
+ # - page: Jira
+ # path: tools/jira.mdx
+ # - page: Junglescout
+ # path: tools/junglescout.mdx
+ # - page: Keap
+ # path: tools/keap.mdx
+ # - page: Klaviyo
+ # path: tools/klaviyo.mdx
+ # - page: Klipfolio
+ # path: tools/klipfolio.mdx
+ # - page: Kommo
+ # path: tools/kommo.mdx
+ # - page: Lastpass
+ # path: tools/lastpass.mdx
+ # - page: Launch Darkly
+ # path: tools/launch_darkly.mdx
+ # - page: Leadfeeder
+ # path: tools/leadfeeder.mdx
+ # - page: Leadoku
+ # path: tools/leadoku.mdx
+ # - page: Lever
+ # path: tools/lever.mdx
+ # - page: Lever Sandbox
+ # path: tools/lever_sandbox.mdx
+ # - page: Lexoffice
+ # path: tools/lexoffice.mdx
+ # - page: Linear
+ # path: tools/linear.mdx
+ # - page: Linkedin
+ # path: tools/linkedin.mdx
+ # - page: Linkhut
+ # path: tools/linkhut.mdx
+ # - page: Linkup
+ # path: tools/linkup.mdx
+ # - page: Listennotes
+ # path: tools/listennotes.mdx
+ # - page: Lmnt
+ # path: tools/lmnt.mdx
+ # - page: Lodgify
+ # path: tools/lodgify.mdx
+ # - page: Mailchimp
+ # path: tools/mailchimp.mdx
+ # - page: Mailerlite
+ # path: tools/mailerlite.mdx
+ # - page: Maintainx
+ # path: tools/maintainx.mdx
+ # - page: Mboum
+ # path: tools/mboum.mdx
+ # - page: Mem0
+ # path: tools/mem0.mdx
+ # - page: Metaads
+ # path: tools/metaads.mdx
+ # - page: Metatextai
+ # path: tools/metatextai.mdx
+ # - page: Microsoft Clarity
+ # path: tools/microsoft_clarity.mdx
+ # - page: Microsoft Teams
+ # path: tools/microsoft_teams.mdx
+ # - page: Microsoft Tenant
+ # path: tools/microsoft_tenant.mdx
+ # - page: Miro
+ # path: tools/miro.mdx
+ # - page: Mixpanel
+ # path: tools/mixpanel.mdx
+ # - page: Mocean
+ # path: tools/mocean.mdx
+ # - page: Monday
+ # path: tools/monday.mdx
+ # - page: Mopinion
+ # path: tools/mopinion.mdx
+ # - page: More Trees
+ # path: tools/more_trees.mdx
+ # - page: Moxie
+ # path: tools/moxie.mdx
+ # - page: Moz
+ # path: tools/moz.mdx
+ # - page: Mural
+ # path: tools/mural.mdx
+ # - page: Ncscale
+ # path: tools/ncscale.mdx
+ # - page: Neon
+ # path: tools/neon.mdx
+ # - page: Netsuite
+ # path: tools/netsuite.mdx
+ # - page: Nextdns
+ # path: tools/nextdns.mdx
+ # - page: Ngrok
+ # path: tools/ngrok.mdx
+ # - page: Notion
+ # path: tools/notion.mdx
+ # - page: Oncehub
+ # path: tools/oncehub.mdx
+ # - page: One Drive
+ # path: tools/one_drive.mdx
+ # - page: Onepage
+ # path: tools/onepage.mdx
+ # - page: Open Sea
+ # path: tools/open_sea.mdx
+ # - page: Outlook
+ # path: tools/outlook.mdx
+ # - page: Pagerduty
+ # path: tools/pagerduty.mdx
+ # - page: Pandadoc
+ # path: tools/pandadoc.mdx
+ # - page: Peopledatalabs
+ # path: tools/peopledatalabs.mdx
+ # - page: Perplexityai
+ # path: tools/perplexityai.mdx
+ # - page: Piggy
+ # path: tools/piggy.mdx
+ # - page: Pipedrive
+ # path: tools/pipedrive.mdx
+ # - page: Placekey
+ # path: tools/placekey.mdx
+ # - page: Posthog
+ # path: tools/posthog.mdx
+ # - page: Precoro
+ # path: tools/precoro.mdx
+ # - page: Printnode
+ # path: tools/printnode.mdx
+ # - page: Process Street
+ # path: tools/process_street.mdx
+ # - page: Productboard
+ # path: tools/productboard.mdx
+ # - page: Qualaroo
+ # path: tools/qualaroo.mdx
+ # - page: Quickbooks
+ # path: tools/quickbooks.mdx
+ # - page: Rafflys
+ # path: tools/rafflys.mdx
+ # - page: Ragic
+ # path: tools/ragic.mdx
+ # - page: Ramp
+ # path: tools/ramp.mdx
+ # - page: Ravenseotools
+ # path: tools/ravenseotools.mdx
+ # - page: Recallai
+ # path: tools/recallai.mdx
+ # - page: Reddit
+ # path: tools/reddit.mdx
+ # - page: Resend
+ # path: tools/resend.mdx
+ # - page: Retellai
+ # path: tools/retellai.mdx
+ # - page: Ring Central
+ # path: tools/ring_central.mdx
+ # - page: Rippling
+ # path: tools/rippling.mdx
+ # - page: Rocket Reach
+ # path: tools/rocket_reach.mdx
+ # - page: Rocketlane
+ # path: tools/rocketlane.mdx
+ # - page: Rootly
+ # path: tools/rootly.mdx
+ # - page: Rosette Text Analytics
+ # path: tools/rosette_text_analytics.mdx
+ # - page: Sage
+ # path: tools/sage.mdx
+ # - page: Salesforce
+ # path: tools/salesforce.mdx
+ # - page: Scrape Do
+ # path: tools/scrape_do.mdx
+ # - page: Scrapingant
+ # path: tools/scrapingant.mdx
+ # - page: Screenshotone
+ # path: tools/screenshotone.mdx
+ # - page: Seismic
+ # path: tools/seismic.mdx
+ # - page: Semanticscholar
+ # path: tools/semanticscholar.mdx
+ # - page: Semrush
+ # path: tools/semrush.mdx
+ # - page: Sendgrid
+ # path: tools/sendgrid.mdx
+ # - page: Sentry
+ # path: tools/sentry.mdx
+ # - page: Serpapi
+ # path: tools/serpapi.mdx
+ # - page: Servicem8
+ # path: tools/servicem8.mdx
+ # - page: Servicenow
+ # path: tools/servicenow.mdx
+ # - page: Share Point
+ # path: tools/share_point.mdx
+ # - page: Shopify
+ # path: tools/shopify.mdx
+ # - page: Shortcut
+ # path: tools/shortcut.mdx
+ # - page: Simplesat
+ # path: tools/simplesat.mdx
+ # - page: Slack
+ # path: tools/slack.mdx
+ # - page: Slackbot
+ # path: tools/slackbot.mdx
+ # - page: Smartrecruiters
+ # path: tools/smartrecruiters.mdx
+ # - page: Smugmug
+ # path: tools/smugmug.mdx
+ # - page: Snowflake
+ # path: tools/snowflake.mdx
+ # - page: Square
+ # path: tools/square.mdx
+ # - page: Stack Exchange
+ # path: tools/stack_exchange.mdx
+ # - page: Starton
+ # path: tools/starton.mdx
+ # - page: Stripe
+ # path: tools/stripe.mdx
+ # - page: Supabase
+ # path: tools/supabase.mdx
+ # - page: Survey Monkey
+ # path: tools/survey_monkey.mdx
+ # - page: Tapform
+ # path: tools/tapform.mdx
+ # - page: Tavily
+ # path: tools/tavily.mdx
+ # - page: Terminus
+ # path: tools/terminus.mdx
+ # - page: Text To Pdf
+ # path: tools/text_to_pdf.mdx
+ # - page: Textrazor
+ # path: tools/textrazor.mdx
+ # - page: Timecamp
+ # path: tools/timecamp.mdx
+ # - page: Timekit
+ # path: tools/timekit.mdx
+ # - page: Timely
+ # path: tools/timely.mdx
+ # - page: Tinypng
+ # path: tools/tinypng.mdx
+ # - page: Tinyurl
+ # path: tools/tinyurl.mdx
+ # - page: Tisane
+ # path: tools/tisane.mdx
+ # - page: Todoist
+ # path: tools/todoist.mdx
+ # - page: Toneden
+ # path: tools/toneden.mdx
+ # - page: Tpscheck
+ # path: tools/tpscheck.mdx
+ # - page: Trello
+ # path: tools/trello.mdx
+ # - page: Twitch
+ # path: tools/twitch.mdx
+ # - page: Twitter
+ # path: tools/twitter.mdx
+ # - page: Twitter Media
+ # path: tools/twitter_media.mdx
+ # - page: Typefully
+ # path: tools/typefully.mdx
+ # - page: Venly
+ # path: tools/venly.mdx
+ # - page: Vero
+ # path: tools/vero.mdx
+ # - page: Visme
+ # path: tools/visme.mdx
+ # - page: Waboxapp
+ # path: tools/waboxapp.mdx
+ # - page: Wakatime
+ # path: tools/wakatime.mdx
+ # - page: Wave Accounting
+ # path: tools/wave_accounting.mdx
+ # - page: Weathermap
+ # path: tools/weathermap.mdx
+ # - page: Webex
+ # path: tools/webex.mdx
+ # - page: Webflow
+ # path: tools/webflow.mdx
+ # - page: Whatsapp
+ # path: tools/whatsapp.mdx
+ # - page: Wiz
+ # path: tools/wiz.mdx
+ # - page: Workiom
+ # path: tools/workiom.mdx
+ # - page: Wrike
+ # path: tools/wrike.mdx
+ # - page: Xero
+ # path: tools/xero.mdx
+ # - page: Yandex
+ # path: tools/yandex.mdx
+ # - page: Ynab
+ # path: tools/ynab.mdx
+ # - page: Yousearch
+ # path: tools/yousearch.mdx
+ # - page: Youtube
+ # path: tools/youtube.mdx
+ # - page: Zendesk
+ # path: tools/zendesk.mdx
+ # - page: Zenrows
+ # path: tools/zenrows.mdx
+ # - page: Zenserp
+ # path: tools/zenserp.mdx
+ # - page: Zoho
+ # path: tools/zoho.mdx
+ # - page: Zoho Bigin
+ # path: tools/zoho_bigin.mdx
+ # - page: Zoho Books
+ # path: tools/zoho_books.mdx
+ # - page: Zoho Desk
+ # path: tools/zoho_desk.mdx
+ # - page: Zoho Inventory
+ # path: tools/zoho_inventory.mdx
+ # - page: Zoho Invoice
+ # path: tools/zoho_invoice.mdx
+ # - page: Zoho Mail
+ # path: tools/zoho_mail.mdx
+ # - page: Zoom
+ # path: tools/zoom.mdx
+ # - page: Zoominfo
+ # path: tools/zoominfo.mdx
+- tab: sdk-reference
+ layout:
+ - section: Python
+ icon: python
+ contents:
+ - page: Python SDK
+ path: pages/sdk/python/index.mdx
+ - section: TypeScript
+ icon: typescript
+ contents:
+ - section: Core Classes
+ slug: core-classes
+ contents:
+ - page: Composio
+ path: pages/sdk/typescript/composio/classes/Composio.mdx
+ - page: ComposioProvider
+ path: pages/sdk/typescript/provider/ComposioProvider/classes/ComposioProvider.mdx
+ - page: OpenAIProvider
+ path: pages/sdk/typescript/provider/OpenAIProvider/classes/OpenAIProvider.mdx
+ - page: BaseAgenticProvider
+ path: pages/sdk/typescript/provider/BaseProvider/classes/BaseAgenticProvider.mdx
+ - page: BaseNonAgenticProvider
+ path: pages/sdk/typescript/provider/BaseProvider/classes/BaseNonAgenticProvider.mdx
+ - section: Models
+ slug: models
+ contents:
+ - page: Tools
+ path: pages/sdk/typescript/models/Tools/classes/Tools.mdx
+ - page: Toolkits
+ path: pages/sdk/typescript/models/Toolkits/classes/Toolkits.mdx
+ - page: Triggers
+ path: pages/sdk/typescript/models/Triggers/classes/Triggers.mdx
+ - page: AuthConfigs
+ path: pages/sdk/typescript/AuthConfigs/classes/AuthConfigs.mdx
+ - page: ConnectedAccounts
+ path: pages/sdk/typescript/ConnectedAccounts/classes/ConnectedAccounts.mdx
+ - page: ConnectionRequest
+ path: pages/sdk/typescript/ConnectionRequest/classes/ConnectionRequest.mdx
+ - page: CustomTools
+ path: pages/sdk/typescript/CustomTools/classes/CustomTools.mdx
+- tab: api-reference
+ layout:
+ - section: API Reference
+ contents:
+ - api: v3
+ api-name: v3
+ skip-slug: true
+ paginated: false
+ flattened: true
+- tab: changelog
diff --git a/fern/pages/get-started/configuration.mdx b/fern/pages/get-started/configuration.mdx
new file mode 100644
index 000000000..d17c916ba
--- /dev/null
+++ b/fern/pages/get-started/configuration.mdx
@@ -0,0 +1,89 @@
+---
+title: Configuration
+slug: /docs/configuration
+image: "" # image for socials
+keywords: ""
+hide-nav-links: false
+---
+
+This guide explains how to configure the Composio SDK using the environment variables.
+
+## Environment Variables
+
+The SDK supports several environment variables for configuration:
+
+### Core Configuration
+- `COMPOSIO_API_KEY`: Your Composio API key
+ - Required for authentication
+ - Can be obtained from [Composio Dashboard](https://app.composio.dev)
+ - Can also be set via SDK initialization.
+- `COMPOSIO_BASE_URL`: Custom API base URL
+ - Optional
+ - Default: `https://backend.composio.dev`
+ - Use this to point the SDK to a different API endpoint
+
+<Note>
+The API key and base URL can also be set while initializing the SDK.
+</Note>
+
+### Logging Configuration
+
+- `COMPOSIO_LOG_LEVEL`: Controls the verbosity of SDK logs
+ - Values: `silent`, `error`, `warn`, `info`, `debug`
+ - Default: `info`
+ - Hierarchy (from highest to lowest priority):
+ - `silent`: No logs
+ - `error`: Only critical errors
+ - `warn`: Warnings and errors
+ - `info`: General information, warnings, and errors
+ - `debug`: Detailed debugging information
+
+### Development and Testing
+
+- `NODE_ENV`: Environment mode
+
+ - Values: `development`, `production`, `test`
+ - Affects:
+ - Telemetry collection (disabled in development/test)
+ - Error handling verbosity
+ - Version check notifications
+
+- `DEVELOPMENT`: Development mode flag
+
+ - Set to any value to enable development mode
+ - Enables additional debugging features
+ - Shows more verbose logs
+
+- `CI`: CI environment flag
+ - Set to any value to indicate CI environment
+ - Affects certain behaviors like version checks
+
+### Telemetry
+
+- `COMPOSIO_DISABLE_TELEMETRY`: Disable telemetry collection
+ - Set to `"true"` to disable
+ - Default: `"false"`
+ - Alternative to `allowTracking` initialization option
+
+## SDK Initialization Options
+
+When initializing the SDK, you can provide configuration through the constructor:
+
+```typescript
+const composio = new Composio({
+ apiKey: 'your-api-key', // Override COMPOSIO_API_KEY
+ baseURL: 'custom-url', // Override COMPOSIO_BASE_URL
+ allowTracking: false, // Disable telemetry
+ allowTracing: true, // Enable tracing
+ provider: new CustomProvider(), // Custom provider
+ telemetryTransport: customTransport, // Custom telemetry transport
+});
+```
+
+### Configuration Priority
+
+When multiple configuration sources are present, the SDK follows this priority order:
+
+1. Constructor parameters
+2. Environment variables
+3. Default values
\ No newline at end of file
diff --git a/fern/pages/tool-calling/custom-tools.mdx b/fern/pages/tool-calling/custom-tools.mdx
new file mode 100644
index 000000000..e9e8ba9be
--- /dev/null
+++ b/fern/pages/tool-calling/custom-tools.mdx
@@ -0,0 +1,223 @@
+---
+title: Creating custom tools
+image: "" # image for socials
+keywords: ""
+subtitle: "Learn how to extend Composio's toolkits with your own tools"
+hide-nav-links: false
+---
+
+Custom tools allow you to create your own tools that can be used with Composio.
+
+1. Standalone tools - Simple tools that don't require any authentication
+2. Toolkit-based tools - Tools that require authentication and can use toolkit credentials
+
+## Creating a Custom Tool
+
+### Standalone Tool
+
+A standalone tool is the simplest form of custom tool. It only requires input parameters and an execute function:
+
+<CodeGroup>
+```typescript TypeScript maxLines=60 wordWrap
+const tool = await composio.tools.createCustomTool({
+ slug: 'CALCULATE_SQUARE',
+ name: 'Calculate Square',
+ description: 'Calculates the square of a number',
+ inputParams: z.object({
+ number: z.number().describe('The number to calculate the square of'),
+ }),
+ execute: async input => {
+ const { number } = input;
+ return {
+ data: { result: number * number },
+ error: null,
+ successful: true,
+ };
+ },
+});
+```
+```python Python maxLines=60 wordWrap
+
+```
+</CodeGroup>
+
+### Toolkit-based Tool
+
+A toolkit-based tool has access to two ways of making authenticated requests:
+
+1. Using `executeToolRequest` - The recommended way to make authenticated requests to the toolkit's API endpoints. Composio automatically handles credential injection and baseURL resolution:
+
+<CodeGroup>
+```typescript TypeScript maxLines=60 wordWrap
+const tool = await composio.tools.createCustomTool({
+ slug: 'GITHUB_STAR_COMPOSIOHQ_REPOSITORY',
+ name: 'Github star composio repositories',
+ toolkitSlug: 'github',
+ description: 'Star any specificied repo of `composiohq` user',
+ inputParams: z.object({
+ repository: z.string().describe('The repository to star'),
+ page: z.number().optional().describe('Pagination page number'),
+ customHeader: z.string().optional().describe('Custom header'),
+ }),
+ execute: async (input, authCredentials, executeToolRequest) => {
+ // This method makes authenticated requests to relevant API
+ // You can use relative paths!
+ // Composio will automatically inject the baseURL
+ const result = await executeToolRequest({
+ endpoint: `/user/starred/composiohq/${input.repository}`,
+ method: 'PUT',
+ body: {},
+ // Add custom headers or query parameters
+ parameters: [
+ // Add query parameters
+ {
+ name: 'page',
+ value: input.page?.toString() || '1',
+ in: 'query',
+ },
+ // Add custom headers
+ {
+ name: 'x-custom-header',
+ value: input.customHeader || 'default-value',
+ in: 'header',
+ },
+ ],
+ });
+ return result;
+ },
+});
+```
+```python Python maxLines=60 wordWrap
+```
+</CodeGroup>
+
+2. Using `authCredentials` - For making direct API calls when needed:
+
+<CodeGroup>
+```typescript TypeScript maxLines=60 wordWrap
+const tool = await composio.tools.createCustomTool({
+ slug: 'GITHUB_DIRECT_API',
+ name: 'Direct GitHub API Call',
+ description: 'Makes direct calls to GitHub API',
+ toolkitSlug: 'github',
+ inputParams: z.object({
+ repo: z.string().describe('Repository name'),
+ }),
+ execute: async (input, authCredentials, executeToolRequest) => {
+ // Use authCredentials for direct API calls
+ const result = await fetch(`https://api.github.com/repos/${input.repo}`, {
+ headers: {
+ Authorization: `Bearer ${authCredentials.access_token}`,
+ },
+ });
+
+ return {
+ data: await result.json(),
+ error: null,
+ successful: true,
+ };
+ },
+});
+```
+```python Python maxLines=60 wordWrap
+```
+</CodeGroup>
+
+### Using Custom Headers and Query Parameters
+
+You can add custom headers and query parameters to your toolkit-based tools using the `parameters` option in `executeToolRequest`:
+
+<CodeGroup>
+```typescript TypeScript maxLines=60
+const tool = await composio.tools.createCustomTool({
+ slug: 'GITHUB_SEARCH_REPOSITORIES',
+ name: 'Search GitHub Repositories',
+ description: 'Search for repositories with custom parameters',
+ toolkitSlug: 'github',
+ inputParams: z.object({
+ query: z.string().describe('Search query'),
+ perPage: z.number().optional().describe('Results per page'),
+ acceptType: z.string().optional().describe('Custom accept header'),
+ }),
+ execute: async (input, authCredentials, executeToolRequest) => {
+ const result = await executeToolRequest({
+ endpoint: '/search/repositories',
+ method: 'GET',
+ parameters: [
+ // Add query parameters for pagination
+ {
+ name: 'q',
+ value: input.query,
+ in: 'query',
+ },
+ {
+ name: 'per_page',
+ value: (input.perPage || 30).toString(),
+ in: 'query',
+ },
+ // Add custom headers
+ {
+ name: 'Accept',
+ value: input.acceptType || 'application/vnd.github.v3+json',
+ in: 'header',
+ },
+ {
+ name: 'X-Custom-Header',
+ value: 'custom-value',
+ in: 'header',
+ },
+ ],
+ });
+ return result;
+ },
+});
+```
+```python Python maxLines=60 wordWrap
+```
+</CodeGroup>
+
+## Executing Custom Tools
+
+You can execute custom tools just like any other tool:
+
+<CodeGroup>
+```typescript TypeScript maxLines=60 wordWrap
+const result = await composio.tools.execute('TOOL_SLUG', {
+ arguments: {
+ // Tool input parameters
+ },
+ userId: 'user-id',
+ connectedAccountId: 'optional-account-id', // Required for toolkit-based tools
+});
+```
+```python Python maxLines=60 wordWrap
+```
+</CodeGroup>
+
+## Best Practices
+
+1. Use descriptive names and slugs for your tools
+2. Always provide descriptions for input parameters using `describe()`
+3. Handle errors gracefully in your execute function
+4. For toolkit-based tools:
+ - Prefer `executeToolRequest` over direct API calls when possible
+ - Use relative paths with `executeToolRequest` - Composio will automatically inject the correct baseURL
+ - Use the `parameters` option to add custom headers or query parameters:
+ ```typescript
+ parameters: [
+ { name: 'page', value: '1', in: 'query' }, // Adds ?page=1 to URL
+ { name: 'x-custom', value: 'value', in: 'header' }, // Adds header
+ ];
+ ```
+ - Remember that `executeToolRequest` can only call tools from the same toolkit
+ - Use `executeToolRequest` to leverage Composio's automatic credential handling
+ - Only use `authCredentials` when you need to make direct API calls or interact with different services
+5. Chain multiple toolkit operations using `executeToolRequest` for better maintainability
+
+## Limitations
+
+1. Custom tools are stored in memory and are not persisted
+2. They need to be recreated when the application restarts
+3. Toolkit-based tools require a valid connected account with the specified toolkit
+4. `executeToolRequest` can only execute tools from the same toolkit that the custom tool belongs to
+5. Each toolkit-based tool can only use one connected account at a time
\ No newline at end of file
diff --git a/fern/pages/tool-calling/executing-tools.mdx b/fern/pages/tool-calling/executing-tools.mdx
index ee6476ba6..cc18dfa04 100644
--- a/fern/pages/tool-calling/executing-tools.mdx
+++ b/fern/pages/tool-calling/executing-tools.mdx
@@ -6,10 +6,9 @@ subtitle: "Learn how to execute Composio's tools with different providers and fr
hide-nav-links: false
---
-## Calling Tools
Tool calling is a feature of all frontier LLMs to allow them to interact with the outside world. Earlier you might be able to ask an LLM to write you a nice email, but you would have to manually send it. With tool calling, you can now provide an LLM a valid tools for example, `GMAIL_SEND_EMAIL` to go and accomplish the task autonomously.
-### Using Chat Completions
+## Using Chat Completions
For non-agent providers—such as OpenAI, Anthropic, and Google AI—you can process tool calls using the tool call handlers provided by the Composio SDK.
This approach works consistently across all supported non-agent providers.
@@ -55,7 +54,7 @@ console.log(result);
</CodeGroup>
-### Using Agentic Frameworks
+## Using Agentic Frameworks
Composio also has first-party support for agentic frameworks which execute tools, feed the result to the LLM and continue the conversation.
@@ -118,7 +117,7 @@ if response.choices[0].message.tool_calls:
```
</CodeGroup>
-### Tools are scoped to a user
+## Tools are scoped to a user
Each tool and tool action is scoped to a user. Hence, a `user_id` is required to fetch and execute tools.
The authentication state is checked and used while fetching and executing a tool.
@@ -126,7 +125,7 @@ The authentication state is checked and used while fetching and executing a tool
You need to authorize the user to execute tools.
For more information on authentication, see [Authenticating Tools](./authenticating-tools).
-### For Humans (deterministic tool calling)
+## For Humans (deterministic tool calling)
In case you just want to call a tool manually -- not using any framework or LLM provider, you can do so using the `execute` method.
<CodeGroup>
@@ -155,4 +154,27 @@ result = composio.tools.execute(
)
print(result)
```
-</CodeGroup>
\ No newline at end of file
+</CodeGroup>
+
+### Proxy Execute -- Manually calling toolkit APIs
+You can also proxy requests to an API of any supported toolkit. This is useful when you want to manually call an API of a toolkit and inject the authentication state from Composio.
+
+<CodeGroup>
+```typescript TypeScript maxLines=60 wordWrap
+// Send a custom request to a toolkit
+const { data } = await composio.tools.proxyExecute({
+ toolkitSlug: 'github',
+ userId: '[email protected]',
+ data: {
+ endpoint: '/repos/owner/repo/issues',
+ method: 'GET'
+ }
+});
+console.log(data);
+```
+```python Python maxLines=60 wordWrap
+
+```
+</CodeGroup>
+
+If you're interested in extending toolkits and creating custom tools, see [Custom tools](/docs/custom-tools).
\ No newline at end of file
diff --git a/fern/pages/tool-calling/extending-toolkits.mdx b/fern/pages/tool-calling/extending-toolkits.mdx
deleted file mode 100644
index e69de29bb..000000000
diff --git a/fern/pages/tool-calling/fetching-tools.mdx b/fern/pages/tool-calling/fetching-tools.mdx
index 04d9103c9..ca1f50db5 100644
--- a/fern/pages/tool-calling/fetching-tools.mdx
+++ b/fern/pages/tool-calling/fetching-tools.mdx
@@ -10,6 +10,8 @@ To effectively use tools, it is recommended to fetch, inspect, and filter them b
This process returns a union of all tools that match the specified criteria, ensuring you provide the most relevant tools to the agents.
+When fetching tools, they are automatically formatted to match the requirements of the provider you are using. This means you do not need to manually convert or adapt the tool format.
+
## Filtering by toolkit
Toolkits are collections of tools that from a specific app!
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 65725f2a8..fb2666688 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -156,7 +156,7 @@ importers:
version: link:../../packages/providers/langchain
'@langchain/core':
specifier: ^0.3.56
'@langchain/langgraph':
specifier: ^0.2.72
@@ -411,8 +411,8 @@ importers:
specifier: 0.1.0-alpha.17
version: 0.1.0-alpha.17
'@composio/json-schema-to-zod':
- specifier: 0.1.1
- version: 0.1.1
+ specifier: 0.1.2
+ version: 0.1.2
chalk:
specifier: ^5.4.1
version: 5.4.1
@@ -525,7 +525,7 @@ importers:
dependencies:
'@langchain/core':
specifier: ^0.3.44
devDependencies:
'@composio/core':
specifier: workspace:*
@@ -847,8 +847,8 @@ packages:
'@composio/[email protected]':
resolution: {integrity: sha512-iNCDSgdwfFVsjbbyZIMknMPy4uO8Xw5+MP2aI+yoQo34VXF17Fi6ZHYirrJPf8RbdoRROZTDJjC/rU18mMzC2Q==}
- '@composio/[email protected]':
- resolution: {integrity: sha512-bSZbYtwKSRGURERoF8R/fR2QpYD397aR7qqp2PezzOtlCPvE95Bzci8slwTiuXvvt6lrgoA7M7jkOipoceo0sw==}
+ '@composio/[email protected]':
+ resolution: {integrity: sha512-QL+SoybrhpQDVEcdwqjYimUZbdbXYLoltedVm6AcHaDZXs5f67ztMnf7VdoMglDbXTP6O916e0dA9PLvOuQxHA==}
'@esbuild/[email protected]':
resolution: {integrity: sha512-1VCICWypeQKhVbE9oW/sJaAmjLxhVqacdkvPLEjwlttjfwENRSClS8EjBz0KzRyFSCPDIkuXW34Je/vk7zdB7Q==}
@@ -5449,7 +5449,7 @@ snapshots:
'@composio/[email protected]': {}
- '@composio/[email protected]':
+ '@composio/[email protected]':
dependencies:
zod: 3.24.4
@@ -5723,14 +5723,14 @@ snapshots:
'@jsdevtools/[email protected]': {}
dependencies:
'@cfworker/json-schema': 4.1.1
ansi-styles: 5.2.0
camelcase: 6.3.0
decamelize: 1.2.0
js-tiktoken: 1.0.20
mustache: 4.2.0
p-queue: 6.6.2
p-retry: 4.6.2
@@ -5742,7 +5742,7 @@ snapshots:
dependencies:
+ '@langchain/core': 0.3.56([email protected]([email protected]))
uuid: 10.0.0
@@ -5752,12 +5752,12 @@ snapshots:
p-retry: 4.6.2
uuid: 9.0.1
optionalDependencies:
+ '@langchain/core': 0.3.56([email protected]([email protected]))
react: 19.1.0
dependencies:
+ '@langchain/core': 0.3.56([email protected]([email protected]))
'@langchain/langgraph-checkpoint': 0.0.17(@langchain/[email protected]([email protected]([email protected])([email protected])([email protected])))
uuid: 10.0.0
@@ -5769,7 +5769,7 @@ snapshots:
dependencies:
+ '@langchain/core': 0.3.56([email protected]([email protected]))
js-tiktoken: 1.0.20
zod: 3.24.4
@@ -7248,6 +7248,14 @@ snapshots:
chai: 5.2.0
tinyrainbow: 2.0.0
+ dependencies:
+ '@vitest/spy': 3.1.4
+ estree-walker: 3.0.3
+ magic-string: 0.30.17
+ optionalDependencies:
+
dependencies:
'@vitest/spy': 3.1.4
@@ -8416,7 +8424,7 @@ snapshots:
dependencies:
'@types/uuid': 10.0.0
chalk: 4.1.2
@@ -9617,7 +9625,7 @@ snapshots:
dependencies:
'@vitest/expect': 3.1.4
'@vitest/pretty-format': 3.1.4
'@vitest/runner': 3.1.4
'@vitest/snapshot': 3.1.4