Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 22, 23:15 UTC
fix: grammar and language
balyan.sid@gmail.com committed
Jun 30, 2025 at 13:20 UTC
d20fc5d58feb3b461cbca47b1197971c5b01ca5a
32 files changed
+92
-92
fern/pages/src/authentication/custom-auth-configs.mdx
+8
-8
@@ -1,14 +1,14 @@
1
---
2
title: Custom Auth Configs
3
image: "https://og.composio.dev/api/og?title=Custom%20Auth%20Configs" # image for socials
4
-subtitle: 'Guide to using customising auth configs for a toolkit '
4
+subtitle: 'Guide to customizing auth configs for a toolkit'
5
keywords: ''
6
hide-nav-links: true
7
---
8
9
-Many toolkits support a level of customisation for the auth config, specifically OAuth applications.
9
+Many toolkits support a level of customization for the auth config, specifically OAuth applications.
10
11
-This guide will walk you through the process of customising the auth config for toolkits where you can configure the developer app.
11
+This guide will walk you through the process of customizing the auth config for toolkits where you can configure the developer app.
12
13
## Creating a custom auth config
14
@@ -26,7 +26,7 @@ You may change the subdomain for the PostHog toolkit to match your own instance.
26
<Tab title="Example: Hubspot">
27
For Hubspot you may customize everything here. For each auth scheme there is a different set of fields.
28
29
-If you choose to use your own developer app for OAuth2 scheme, you will have to provide the client ID and client secret.
29
+If you choose to use your own developer app for the OAuth2 scheme, you will have to provide the client ID and client secret.
30
31
<Frame background="subtle" title="Hubspot Auth Config Settings">
32
<img src="../../../assets/images/custom-auth-hubspot.png" />
@@ -37,9 +37,9 @@ If you choose to use your own developer app for OAuth2 scheme, you will have to
37
Toolkits that support OAuth2 allow using your own developer app. This is the recommended approach for most cases.
38
39
<Tip title="Use your own developer app!" icon="exclamation">
40
-We recommend using your own developer app for OAuth2 scheme as it is suited more for production usage with many users and more granular control over scopes.
40
+We recommend using your own developer app for the OAuth2 scheme as it is more suited for production usage with many users and more granular control over scopes.
41
42
-However getting OAuth approvals takes time so Composio provides a default developer app!
42
+However, getting OAuth approvals takes time, so Composio provides a default developer app!
43
44
</Tip>
45
@@ -130,7 +130,7 @@ By default the users will see an OAuth screen like the one below:
130
<img src="../../../assets/images/oauth-branding.png" />
131
</Frame>
132
133
-The OAuth redirect URL is surfaced in the some OAuth providers' consent screens. This may cause confusion for some users as that URL is not of the same domain as the application.
133
+The OAuth redirect URL is surfaced in some OAuth providers' consent screens. This may cause confusion for some users as that URL is not of the same domain as the application.
134
135
To remediate this:
136
@@ -203,7 +203,7 @@ res.redirect(302, redirectUrl);
203
</CodeGroup>
204
</Step>
205
<Step title="Create the auth config">
206
-Specify the your custom redirect URI in the auth config settings!
206
+Specify your custom redirect URI in the auth config settings!
207
208
<Frame background="subtle" title="Auth Config Settings">
209
<img src="../../../assets/images/custom-redirect-uri.png" />
fern/pages/src/authentication/custom-auth-params.mdx
+1
-1
@@ -6,7 +6,7 @@ keywords: ""
6
hide-nav-links: true
7
---
8
9
-In case Composio is not being used for managing the auth but only for the tools. It is possible to use the `beforeExecute` hook to inject custom auth headers or parameters for a toolkit.
9
+In cases where Composio is not being used for managing the auth but only for the tools, it is possible to use the `beforeExecute` hook to inject custom auth headers or parameters for a toolkit.
10
11
## Setup and Initialization
12
fern/pages/src/authentication/programmatic-auth-configs.mdx
+1
-1
@@ -6,7 +6,7 @@ keywords: ""
6
hide-nav-links: true
7
---
8
9
-Auth configs are created once and reused many times. However when dealing with many toolkits, you may want to create auth configs programmatically.
9
+Auth configs are created once and reused many times. However, when dealing with many toolkits, you may want to create auth configs programmatically.
10
11
- When creating and destroying auth configs multiple times in your app's lifecycle.
12
- When creating auth configs for your users' users.
fern/pages/src/examples/gmail-filterer.mdx
+5
-5
@@ -21,7 +21,7 @@ The complete app is available in our [`filter-gmails-example`](https://github.co
21
Explore the complete source code on GitHub
22
</Card>
23
24
-In this guide, we'll focus on the Composio + OpenAI Agents part of the app
24
+In this guide, we'll focus on the Composio + OpenAI Agents part of the app.
25
26
## Prerequisites
27
- Clone the [`filter-gmails-example`](https://github.com/ComposioHQ/filter-gmails-example) repository and set the project up locally.
@@ -31,7 +31,7 @@ In this guide, we'll focus on the Composio + OpenAI Agents part of the app
31
## Creating Triggers for users
32
[Triggers](/docs/using-triggers) are a way to listen for events from apps. They act as a notification system for your AI applications, enabling your agents to respond dynamically to external events occurring within your apps.
33
34
-In some cases, triggers require certain configuration to set the correct events. You can inspect and add these properties while enabling the triggers.
34
+In some cases, triggers require certain configurations to set the correct events. You can inspect and add these properties while enabling the triggers.
35
36
<SnippetCode
37
githubUrl="https://github.com/ComposioHQ/filter-gmails-example/blob/master/apps/backend/email_processor.py#L135-L156"
@@ -68,7 +68,7 @@ This is the main webhook endpoint for processing Gmail new message events.
68
69
Composio sends a POST request to the webhook endpoint `/composio/webhook` that contains the event data.
70
71
-It is parsed and then the labelling method `process_gmail_message` is called through a FastAPI Background task.
71
+It is parsed and then the labeling method `process_gmail_message` is called through a FastAPI Background task.
72
73
```python apps/backend/main.py {1-5, 29-33} maxLines=33
74
@app.post("/composio/webhook")
@@ -126,7 +126,7 @@ The `process_gmail_message` method is responsible for processing the email using
126
title="apps/backend/email_processor.py"
127
/>
128
129
-We read the first 10k characters of the email body to pass it to the agent. This is done to not overwhelm or surpass the token limits in case of really long emails.
129
+We read the first 10k characters of the email body to pass it to the agent. This is done to avoid overwhelming or surpassing the token limits in case of really long emails.
130
131
<SnippetCode
132
githubUrl="https://github.com/ComposioHQ/filter-gmails-example/blob/master/apps/backend/email_processor.py#L50-L60"
@@ -175,4 +175,4 @@ In the `/composio/webhook` endpoint, we verify the webhook signature and then pa
175
## Inspiration
176
This example was inspired by an X/Twitter post by [@FarzaTV](https://x.com/FarzaTV/status/1905371012369350857).
177
178
-We encourage you to check out the [full app](https://github.com/ComposioHQ/filter-gmails-example), fork it, build it and make it your own! Reach out to [sid@composio.dev](mailto:sid@composio.dev) for free credits ;)
178
+We encourage you to check out the [full app](https://github.com/ComposioHQ/filter-gmails-example), fork it, build it, and make it your own! Reach out to [sid@composio.dev](mailto:sid@composio.dev) for free credits ;)
fern/pages/src/examples/sample-script.mdx
+1
-1
@@ -1,7 +1,7 @@
1
---
2
title: Sample Script
3
image: "https://og.composio.dev/api/og?title=Sample%20Script" # image for socials
4
-description: "A simple example of python script that uses the Composio SDK to call tools."
4
+description: "A simple example of a Python script that uses the Composio SDK to call tools."
5
keywords: "hello world python, composio, sdk, tool calling"
6
subtitle: ""
7
hide-nav-links: true
fern/pages/src/examples/sample-webserver/sample-webserver.mdx
+9
-9
@@ -7,12 +7,12 @@ subtitle: ""
7
hide-nav-links: true
8
---
9
10
-This tutorial shows you a minimal example of a web server that can use composio
10
+This tutorial shows you a minimal example of a web server that can use Composio.
11
12
13
### Install dependencies
14
15
-using `bun` for this example, it is super convenient for rapid prototyping.
15
+Using `bun` for this example, it is super convenient for rapid prototyping.
16
17
```bash
18
bun install @composio/core@next openai hono
@@ -46,11 +46,11 @@ Basic scaffolding for the server.
46
47
### Auth Configs
48
49
-These are configurations for tools that control how they are authorized, the scopes and permissions they have. You can learn more about them [here](/authenticating-tools).
49
+These are configurations for tools that control how they are authorized, the scopes, and permissions they have. You can learn more about them [here](/authenticating-tools).
50
51
For this example, we will create a basic GMAIL auth config.
52
53
-You are recommend to store these config ids, so that you can reuse them later.
53
+You are recommended to store these config IDs, so that you can reuse them later.
54
55
<SnippetCode
56
src="./index.ts"
@@ -64,7 +64,7 @@ You are recommend to store these config ids, so that you can reuse them later.
64
65
Connections are your users authorizing your tools.
66
67
-Here we start the connection process, once your user uses the `redirectUrl` from the response,
67
+Here we start the connection process. Once your user uses the `redirectUrl` from the response,
68
they will be redirected to the auth flow.
69
Once they have authorized the connection, you can use the `id` to get and execute the tools as the user.
70
@@ -114,19 +114,19 @@ You can see the full code [here](https://github.com/ComposioHQ/composio/blob/nex
114
115
### What just happened?
116
117
-Well first - we created an instance of our `gmail` tool with our default auth config, then our user authorized that tool with their account and some permissions.
117
+Well, first - we created an instance of our `gmail` tool with our default auth config, then our user authorized that tool with their account and some permissions.
118
119
-Then we used that `gmail` tool by giving it to OpenAI's `gpt-4o`. The model composed the email and sent it correctly formatted to the composio team.
119
+Then we used that `gmail` tool by giving it to OpenAI's `gpt-4o`. The model composed the email and sent it correctly formatted to the Composio team.
120
121
### What's next?
122
123
-This is a fairly basic example, but you can do a lot more with our sdk.
123
+This is a fairly basic example, but you can do a lot more with our SDK.
124
125
Recommended further reading:
126
127
- [Authenticating tools](/authenticating-tools) - understand how to control tool authorization
128
- [Executing Tools](/executing-tools) - understand how tool execution works
129
-- [Providers](/providers) - want to use something other than OpenAI? we probably support it
129
+- [Providers](/providers) - want to use something other than OpenAI? We probably support it
130
- [Tools](/tools) - understand what tools we have
131
132
fern/pages/src/examples/tool-generator.mdx
+8
-8
@@ -1,30 +1,30 @@
1
---
2
title: Tool Type Generator
3
image: "https://og.composio.dev/api/og?title=Tool%20Type%20Generator" # image for socials
4
-description: "An example that show you how to showcase auth scheme and action params for tools"
4
+description: "An example that shows you how to showcase auth scheme and action params for tools"
5
keywords: "tool type generator, composio, sdk, tool calling"
6
subtitle: "using raw tool definition to build your own platform on top of Composio"
7
hide-nav-links: true
8
---
9
10
-This is a bit of a checky tutorial as it is dogfooding the `docs` tool generation process.
10
+This is a bit of a cheeky tutorial as it is dogfooding the `docs` tool generation process.
11
12
-To motivate this example clearly, in our tools section — we have details about let's say [`Github`](/tools/github) tool, that shows its auth scheme, actions and their params.
12
+To motivate this example clearly, in our tools section — we have details about, let's say, the [`Github`](/tools/github) tool, that shows its auth scheme, actions, and their params.
13
14
-Now why would anyone outside of Composio want to do this? Well if you are building a platform on top of Composio, perchance a Workflow builder like langflow. You would want to show some or all of this information to your users.
14
+Now why would anyone outside of Composio want to do this? Well, if you are building a platform on top of Composio, perhaps a workflow builder like Langflow, you would want to show some or all of this information to your users.
15
16
-This is a non standard use case, that we support and love users building on top of us but if this is uninteresting to you, you can skip this tutorial.
16
+This is a non-standard use case that we support and love users building on top of us, but if this is uninteresting to you, you can skip this tutorial.
17
18
## How does one build a tool type generator?
19
20
-In composio, we have two internal states for tools
20
+In Composio, we have two internal states for tools:
21
22
1. Raw tool definition
23
2. Provider tool definition
24
25
-The raw tool definition is an generic input output schema definition that we internally for tools, we expose it for customers if they want to build on top of it but it is not the primary way tools are normally used.
25
+The raw tool definition is a generic input-output schema definition that we use internally for tools. We expose it for customers if they want to build on top of it, but it is not the primary way tools are normally used.
26
27
-The provider tool definition, translates this raw tool definition to the specific schema of a provider (by default `openai`).
27
+The provider tool definition translates this raw tool definition to the specific schema of a provider (by default `openai`).
28
29
For building something like this, we need to use the raw tool definition.
30
fern/pages/src/examples/vercel-composio.mdx
+3
-3
@@ -16,7 +16,7 @@ You can find the demo live [here](https://chat.composio.dev/).
16
17
## Prerequisites
18
19
-Ensure you've followed the README.md in the [composiohq/chat](https://github.com/composiohq/chat) repository to set the project locally.
19
+Ensure you've followed the README.md in the [composiohq/chat](https://github.com/composiohq/chat) repository to set up the project locally.
20
21
## Creating auth configs
22
@@ -32,7 +32,7 @@ Once done, your auth configs will be available in the [Composio dashboard](https
32
33
### Save auth config IDs to environment variables
34
35
-For this project, the auth config IDs should be saved the the environment variables with the `NEXT_PUBLIC_` prefix.
35
+For this project, the auth config IDs should be saved to the environment variables with the `NEXT_PUBLIC_` prefix.
36
37
```bash .env.local
38
NEXT_PUBLIC_GMAIL_AUTH_CONFIG_ID=ac_1234567890
@@ -41,7 +41,7 @@ NEXT_PUBLIC_GITHUB_AUTH_CONFIG_ID=ac_1234567890
41
42
## Create a Composio client instance
43
44
-We create a Composio client instance for server-side operations like, API routes, server components, etc.
44
+We create a Composio client instance for server-side operations like API routes, server components, etc.
45
46
```typescript lib/service/composio.ts
47
import { Composio } from '@composio/core';
fern/pages/src/get-started/dev-setup.mdx
+9
-9
@@ -7,7 +7,7 @@ keywords: ''
7
hide-nav-links: false
8
---
9
10
-This comprehensive guide explains how to setup your IDE and coding agents to help you ship faster with Composio. We'll cover optimal configurations for popular editors and AI coding assistants.
10
+This comprehensive guide explains how to set up your IDE and coding agents to help you ship faster with Composio. We'll cover optimal configurations for popular editors and AI coding assistants.
11
12
## Cursor
13
Cursor is an AI-powered code editor that can significantly accelerate your development with Composio. Here's how to set it up optimally.
@@ -50,8 +50,8 @@ To get the best experience building with Composio, add custom instructions to Cu
50
<CodeGroup>
51
```md TypeScript
52
You are the best TypeScript developer known for your high taste and usage of new and cutting-edge practices.
53
-You are building with Composio's TypeScript SDK. Composio is platform for building with authenticated tools for AI agents and workflows.
54
-It lets you build agents that that can work across a user's apps like Gmail, Notion, Slack.
53
+You are building with Composio's TypeScript SDK. Composio is a platform for building with authenticated tools for AI agents and workflows.
54
+It lets you build agents that can work across a user's apps like Gmail, Notion, Slack.
55
56
Below is a list of Composio documentation. Use your web and fetch capabilities to read the documentation you need.
57
[Composio Documentation](https://v3.docs.composio.dev)
@@ -61,12 +61,12 @@ Below is a list of Composio documentation. Use your web and fetch capabilities t
61
- [Providers](https://v3.docs.composio.dev/docs/providers.mdx)
62
- [Executing Tools](https://v3.docs.composio.dev/docs/executing-tools.mdx): Learn how to execute Composio's tools with different providers and frameworks
63
- [Authenticating Tools](https://v3.docs.composio.dev/docs/authenticating-tools.mdx): Learn how to authenticate tools
64
-- [Fetching and Filtering Tools](https://v3.docs.composio.dev/docs/fetching-tools.mdx): Learn how to fetch and filter Composio's tools and toolsets
64
+- [Fetching and Filtering Tools](https://v3.docs.composio.dev/docs/fetching-tools.mdx): Learn how to fetch and filter Composio's tools and toolkits
65
- [Schema Modifiers](https://v3.docs.composio.dev/docs/modifiers/schema-modifiers.mdx): Learn how to use schema modifiers to transform tool schemas before they are seen by agents.
66
- [Before Execution Modifiers](https://v3.docs.composio.dev/docs/modifiers/before-execution.mdx): Learn how to use before execution modifiers to modify tool arguments before execution.
67
- [After Execution Modifiers](https://v3.docs.composio.dev/docs/modifiers/after-execution.mdx): Learn how to use after execution modifiers to transform tool results after execution.
68
- [Creating custom tools](https://v3.docs.composio.dev/docs/custom-tools.mdx): Learn how to extend Composio's toolkits with your own tools
69
-- [Custom Auth Configs](https://v3.docs.composio.dev/docs/custom-auth-configs.mdx): Guide to using customising auth configs for a toolkit
69
+- [Custom Auth Configs](https://v3.docs.composio.dev/docs/custom-auth-configs.mdx): Guide to using customizing auth configs for a toolkit
70
- [Programmatic Auth Configs](https://v3.docs.composio.dev/docs/programmatic-auth-configs.mdx): Guide to creating auth configs programmatically
71
- [Custom Auth Parameters](https://v3.docs.composio.dev/docs/custom-auth-params.mdx): Guide to injecting custom credentials in headers or parameters for a toolkit
72
- [Using Triggers](https://v3.docs.composio.dev/docs/using-triggers.mdx): Send payloads to your system based on external events
@@ -84,8 +84,8 @@ Below is a list of Composio documentation. Use your web and fetch capabilities t
84
85
```md Python
86
You are the best Python developer known for your high taste and usage of new and cutting-edge practices.
87
-You are building with Composio's Python SDK. Composio is platform for building with authenticated tools for AI agents and workflows.
88
-It lets you build agents that that can work across a user's apps like Gmail, Notion, Slack.
87
+You are building with Composio's Python SDK. Composio is a platform for building with authenticated tools for AI agents and workflows.
88
+It lets you build agents that can work across a user's apps like Gmail, Notion, Slack.
89
90
Below is a list of Composio documentation. Use your web and fetch capabilities to read the documentation you need.
91
[Composio Documentation](https://v3.docs.composio.dev)
@@ -94,12 +94,12 @@ Below is a list of Composio documentation. Use your web and fetch capabilities t
94
- [Providers](https://v3.docs.composio.dev/docs/toolsets.mdx)
95
- [Executing Tools](https://v3.docs.composio.dev/docs/executing-tools.mdx): Learn how to execute Composio's tools with different providers and frameworks
96
- [Authenticating Tools](https://v3.docs.composio.dev/docs/authenticating-tools.mdx): Learn how to authenticate tools
97
-- [Fetching and Filtering Tools](https://v3.docs.composio.dev/docs/fetching-tools.mdx): Learn how to fetch and filter Composio's tools and toolsets
97
+- [Fetching and Filtering Tools](https://v3.docs.composio.dev/docs/fetching-tools.mdx): Learn how to fetch and filter Composio's tools and toolkits
98
- [Schema Modifiers](https://v3.docs.composio.dev/docs/modifiers/schema-modifiers.mdx): Learn how to use schema modifiers to transform tool schemas before they are seen by agents.
99
- [Before Execution Modifiers](https://v3.docs.composio.dev/docs/modifiers/before-execution.mdx): Learn how to use before execution modifiers to modify tool arguments before execution.
100
- [After Execution Modifiers](https://v3.docs.composio.dev/docs/modifiers/after-execution.mdx): Learn how to use after execution modifiers to transform tool results after execution.
101
- [Creating custom tools](https://v3.docs.composio.dev/docs/custom-tools.mdx): Learn how to extend Composio's toolkits with your own tools
102
-- [Custom Auth Configs](https://v3.docs.composio.dev/docs/custom-auth-configs.mdx): Guide to using customising auth configs for a toolkit
102
+- [Custom Auth Configs](https://v3.docs.composio.dev/docs/custom-auth-configs.mdx): Guide to using customizing auth configs for a toolkit
103
- [Programmatic Auth Configs](https://v3.docs.composio.dev/docs/programmatic-auth-configs.mdx): Guide to creating auth configs programmatically
104
- [Custom Auth Parameters](https://v3.docs.composio.dev/docs/custom-auth-params.mdx): Guide to injecting custom credentials in headers or parameters for a toolkit
105
- [Using Triggers](https://v3.docs.composio.dev/docs/using-triggers.mdx): Send payloads to your system based on external events
fern/pages/src/get-started/providers.mdx
+1
-1
@@ -329,7 +329,7 @@ Select a provider based on your AI platform:
329
> No, providers are set during initialization. Create a new Composio instance with a different provider if needed.
330
331
**Q: Do I need different API keys for different providers?**
332
-> Yes, your Composio API key is used only for tool authentication, and is not used by the provider. You need to use provider specific API keys for each provider.
332
+> Yes, your Composio API key is used only for tool authentication and is not used by the provider. You need to use provider-specific API keys for each provider.
333
334
**Q: Can I use multiple providers in the same application?**
335
> Yes, create separate Composio instances with different providers for different parts of your application.
fern/pages/src/mcp/developers.mdx
+4
-4
@@ -12,7 +12,7 @@ hide-nav-links: true
12
Composio MCP lets you build custom MCP servers that your users can connect to and use to perform actions.
13
You can manage these servers via our [Dashboard](https://app.composio.dev), or use the [SDK/API](/api-reference/mcp) for greater control and flexibility.
14
15
-## Creating MCP Servers and Onboarding End users
15
+## Creating MCP Servers and Onboarding End Users
16
<Steps>
17
<Step title="Configure Authentication">
18
- **Configure Toolkit permissions:**
@@ -45,7 +45,7 @@ You can manage these servers via our [Dashboard](https://app.composio.dev), or u
45
```json
46
{
47
"id": "5bc757cc-7a8e-431c-8616-7f57cbed2423",
48
- "name": "Gmail MCP Server"",
48
+ "name": "Gmail MCP Server",
49
"auth_config_ids": ["ac_auth_12"],
50
"allowed_tools": [
51
"GMAIL_FETCH_EMAIL",
@@ -81,9 +81,9 @@ You can manage these servers via our [Dashboard](https://app.composio.dev), or u
81
</Tip>
82
83
### Configuring authentication
84
-You or your users need to authenticate against an app to use it's MCP server through Composio!
84
+You or your users need to authenticate against an app to use its MCP server through Composio!
85
This can be done in two ways:
86
87
-* Authenticate users upfront via the Composio SDK/API. Follow [custom auth configs](/docs/custom-auth-configs) to learn how to connect users. This is recommended for most use cases
87
+* Authenticate users upfront via the Composio SDK/API. Follow [custom auth configs](/docs/custom-auth-configs) to learn how to connect users. This is recommended for most use cases.
88
* Let the agent authenticate users on demand. Passing `include_composio_helper_actions=true` in the URL will include Composio's helper actions and the agent will guide the user through auth on demand.
89
fern/pages/src/mcp/introduction.mdx
+3
-3
@@ -47,7 +47,7 @@ Interested in embedding Composio MCP servers into your MCP clients or applicatio
47
```json
48
{
49
"id": "5bc757cc-7a8e-431c-8616-7f57cbed2423",
50
- "name": "Gmail MCP Server"",
50
+ "name": "Gmail MCP Server",
51
"auth_config_ids": ["ac_auth_12"],
52
"allowed_tools": [
53
"GMAIL_FETCH_EMAIL",
@@ -83,9 +83,9 @@ Interested in embedding Composio MCP servers into your MCP clients or applicatio
83
</Tip>
84
85
### Configuring authentication
86
-You or your users need to authenticate against an app to use it's MCP server through Composio!
86
+You or your users need to authenticate against an app to use its MCP server through Composio!
87
This can be done in two ways:
88
89
-* Authenticate users upfront via the Composio SDK/API. Follow [custom auth configs](/docs/custom-auth-configs) to learn how to connect users. This is recommended for most use cases
89
+* Authenticate users upfront via the Composio SDK/API. Follow [custom auth configs](/docs/custom-auth-configs) to learn how to connect users. This is recommended for most use cases.
90
* Let the agent authenticate users on demand. Passing `include_composio_helper_actions=true` in the URL will include Composio's helper actions and the agent will guide the user through auth on demand.
91
fern/pages/src/mcp/overview.mdx
+1
-1
@@ -7,7 +7,7 @@ hide-nav-links: true
7
---
8
[Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) is an open protocol that standardizes how LLM-powered applications provide _tools_ and relevant context to the underlying models.
9
10
-The protocol follows a client server model, where the MCP server provides the tools and context to the MCP client.
10
+The protocol follows a client-server model, where the MCP server provides the tools and context to the MCP client.
11
12
All [tools](/tools) in Composio are also available through MCP servers.
13
fern/pages/src/mcp/partner-api.mdx
+1
-1
@@ -1,6 +1,6 @@
1
---
2
title: Composio Partner Program
3
-subtitle: "Onboard as a partner with composio"
3
+subtitle: "Onboard as a partner with Composio"
4
image: "https://og.composio.dev/api/og?title=Composio%20Partner%20Program" # image for socials
5
keywords: ""
6
hide-nav-links: true
fern/pages/src/mcp/providers.mdx
+1
-1
@@ -8,7 +8,7 @@ hide-nav-links: true
8
9
---
10
11
-<Warning title="Only available for Typescript SDK" icon="warning">At this time, MCP providers using the Composio SDK are only supported in the TypeScript SDK. Support for the Python SDK is coming soon.</Warning>
11
+<Warning title="Only available for TypeScript SDK" icon="warning">At this time, MCP providers using the Composio SDK are only supported in the TypeScript SDK. Support for the Python SDK is coming soon.</Warning>
12
13
Integrating external tools into agent frameworks can be a complex and time-consuming process. Composio MCP (Model Context Protocol) servers simplify this workflow, enabling you to connect your framework to a wide array of tools and services with minimal configuration.
14
fern/pages/src/migration-guide.mdx
+4
-4
@@ -8,17 +8,17 @@ hide-nav-links: true
8
9
In the last few months, we have experienced very rapid growth in usage of our platform. As such, our team has been working hard to radically improve the performance and developer experience of our platform.
10
11
-A lot of these changes have happened in the background, but we are excited to finally share our new SDKs with you that compliment our new infra.
11
+A lot of these changes have happened in the background, but we are excited to finally share our new SDKs with you that complement our new infra.
12
13
The new API features improved usability, enhanced stability, and better scalability. The SDKs built on top of it simplify the developer experience, making it easier than ever to build useful agents.
14
15
## What's new?
16
17
-A lot of the changes are on the infra side, but from the SDK point of view. Here is what you can expect:
17
+A lot of the changes are on the infra side, but from the SDK point of view, here is what you can expect:
18
- Faster and more reliable tool execution
19
- A simpler but more opinionated SDK
20
- Much more intuitive and consistent naming conventions
21
-- A vastly improved typescript sdk that is meaningfully more type-safe and has full feature parity with the python sdk
21
+- A vastly improved TypeScript SDK that is meaningfully more type-safe and has full feature parity with the Python SDK
22
23
There aren't too many new flashy features here (yet) mainly because we wanted to get the bones right — but we feel we have a solid foundation to ship incredible new experiences on top very quickly.
24
@@ -27,7 +27,7 @@ There aren't too many new flashy features here (yet) mainly because we wanted to
27
28
Currently, the new SDKs are in a preview release. These new SDKs come almost fully formed, we do not expect many breaking changes to them but are releasing them in a preview state to get feedback and make necessary changes before locking them in.
29
30
-As we lock the new SDKs in place, we will deprecate support for the old SDKs. They will continue to work for the foreseeable future but are no longer active maintained. We will continue to push security update and fix any critical bugs but will not be support any new functionality in them.
30
+As we lock the new SDKs in place, we will deprecate support for the old SDKs. They will continue to work for the foreseeable future but are no longer actively maintained. We will continue to push security updates and fix any critical bugs but will not support any new functionality in them.
31
32
We urge you to upgrade to the new SDKs as soon as possible.
33
fern/pages/src/providers/anthropic.mdx
+2
-2
@@ -7,10 +7,10 @@ hide-nav-links: false
7
---
8
9
10
-The Anthropic Provider transforms Composio tools into a format compatible with Anthropic's function calling capabilities through it's Messages API.
10
+The Anthropic Provider transforms Composio tools into a format compatible with Anthropic's function calling capabilities through its Messages API.
11
12
## Setup
13
-Anthropic provider can be installed for both the SDKs.
13
+The Anthropic provider can be installed for both SDKs.
14
15
<CodeGroup>
16
```bash title="Python" for="python" maxLines=60 wordWrap
fern/pages/src/providers/crewai.mdx
+2
-2
@@ -8,7 +8,7 @@ hide-nav-links: false
8
9
## CrewAI Provider
10
11
-The CrewAI Provider is a provider that formats the Composio tools into an object compatible with CrewAI's tool calling capabilities. Agents and LLM workflows built with this can call and execute the Composio tools.
11
+The CrewAI Provider formats the Composio tools into an object compatible with CrewAI's tool calling capabilities. Agents and LLM workflows built with this can call and execute the Composio tools.
12
13
## Setup
14
@@ -40,7 +40,7 @@ crewai_agent = Agent(
40
goal="""You take action on Github using Github APIs""",
41
backstory=(
42
"You are AI agent that is responsible for taking actions on Github "
43
- "on users behalf. You need to take action on Github using Github APIs"
43
+ "on users' behalf. You need to take action on Github using Github APIs"
44
),
45
verbose=True,
46
tools=tools,
fern/pages/src/providers/google-adk.mdx
+1
-1
@@ -10,7 +10,7 @@ hide-nav-links: false
10
11
## Google ADK Provider
12
13
-The Google ADK Provider is a provider that formats the Composio tools into an object compatible with Google's ADK capabilities. Agents and LLM workflows built with this can call and execute the Composio tools.
13
+The Google ADK Provider formats the Composio tools into an object compatible with Google's ADK capabilities. Agents and LLM workflows built with this can call and execute the Composio tools.
14
15
## Setup
16
fern/pages/src/providers/mastra.mdx
+1
-1
@@ -8,7 +8,7 @@ hide-nav-links: false
8
9
Mastra is a TypeScript native framework for building agents with tools and MCPs. It expects tools to be in the following format:
10
- Inputs: What information the tool needs to run (defined with an `inputSchema`, often using Zod).
11
-- Outputs: The structure of the data the tool returns (defined with an outputSchema).
11
+- Outputs: The structure of the data the tool returns (defined with an `outputSchema`).
12
- Execution Logic: The code that performs the tool's action.
13
- Description: Text that helps the agent understand what the tool does and when to use it.
14
fern/pages/src/providers/openai-agents.mdx
+1
-1
@@ -10,7 +10,7 @@ hide-nav-links: false
10
11
The OpenAI Agents Provider is a provider that formats the Composio tools into an object compatible with OpenAI's Agents API.
12
13
-OpenAI Agents SDK is different from the OpenAI SDK. It's to help build agentic AI apps in a lightweight, easy-to-use package with very few abstractions.
13
+OpenAI Agents SDK is different from the OpenAI SDK. It helps build agentic AI apps in a lightweight, easy-to-use package with very few abstractions.
14
15
## Setup
16
fern/pages/src/providers/openai.mdx
+3
-3
@@ -6,10 +6,10 @@ keywords: ""
6
hide-nav-links: false
7
---
8
9
-The OpenAI Provider is the default provider for the Composio SDK. It transforms Composio tools into a format compatible with OpenAI's function calling capabilities through both: the Responses and Chat Completion APIs.
9
+The OpenAI Provider is the default provider for the Composio SDK. It transforms Composio tools into a format compatible with OpenAI's function calling capabilities through both the Responses and Chat Completion APIs.
10
11
## Setup
12
-By default the OpenAI Provider is installed when you install the Composio SDK. You can also install it manually:
12
+By default, the OpenAI Provider is installed when you install the Composio SDK. You can also install it manually:
13
14
<CodeGroup>
15
```bash title="Python" for="python"
@@ -49,7 +49,7 @@ The Responses API is the recommended way to build more agentic flows with the Op
49
</CodeGroup>
50
51
## Chat Completion API
52
-Chat Completion API is the industry standard for building LLM-powered applications. Chat completions is also adopted and used by many other LLM providers apart from OpenAI.
52
+Chat Completion API is the industry standard for building LLM-powered applications. Chat completions are also adopted and used by many other LLM providers apart from OpenAI.
53
54
<CodeGroup>
55
<SnippetCode
fern/pages/src/providers/ts-custom.mdx
+1
-1
@@ -5,7 +5,7 @@ keywords: ""
5
hide-nav-links: false
6
---
7
8
-This guide provides a comprehensive walkthrough of creating custom providers for the Composio TypeScriptSDK, enabling integration with different AI frameworks and platforms.
8
+This guide provides a comprehensive walkthrough of creating custom providers for the Composio TypeScript SDK, enabling integration with different AI frameworks and platforms.
9
10
## Provider Architecture
11
fern/pages/src/providers/vercel.mdx
+1
-1
@@ -39,7 +39,7 @@ const { text } = await generateText({
39
{
40
role: "user",
41
content:
42
- "Send an email to sid@composio.dev saying how 'hi from the ether of composio'",
42
+ "Send an email to sid@composio.dev saying 'hi from the ether of composio'",
43
},
44
],
45
tools,
fern/pages/src/tool-calling/after-execution-modifiers.mdx
+2
-2
@@ -15,7 +15,7 @@ These modifiers are called after the tool is executed by the LLM. This allows yo
15
**Useful for:**
16
17
- Modifying or truncating the output of the tool.
18
-- Convert the output to a different format before returning it to the agent.
18
+- Converting the output to a different format before returning it to the agent.
19
20
<Frame>
21
<img src="../../../assets/images/after-execute.png" alt="After Execution Modifier" />
@@ -46,7 +46,7 @@ def after_execute_modifier(
46
return {
47
**response,
48
"data": {
49
- "karama": response["data"]["karama"],
49
+ "karma": response["data"]["karma"],
50
},
51
}
52
fern/pages/src/tool-calling/authenticating-tools.mdx
+5
-5
@@ -10,7 +10,7 @@ Different apps (like Slack, Notion, Shopify) have their own authentication flows
10
11
## Creating an auth config
12
13
-Each toolkit comes with it's own _auth config_.
13
+Each toolkit comes with its own _auth config_.
14
This configuration is used to authenticate the users to the tools.
15
16
The first step is to create an auth config for any toolkit that you want to use.
@@ -37,12 +37,12 @@ The dashboard offers a guided process for all app types.
37
</Frame>
38
</Step>
39
<Step title="Configure Auth Config Settings">
40
- Select between the supported auth schemes of OAuth2, API Key, Bearer Token, Basic Auth, depending on the toolkit.
40
+ Select among the supported auth schemes of OAuth2, API Key, Bearer Token, Basic Auth, depending on the toolkit.
41
Switch between the auth schemes and configure the scopes, developer credentials, etc here.
42
43
<Note title="Composio Managed Auth" icon="info">
44
You may also choose to use Composio's managed auth for certain toolkits or use your own auth credentials.
45
- It is recommended to use specify your own credentials for production workloads and ability to control scopes, etc.
45
+ It is recommended to specify your own credentials for production workloads and ability to control scopes, etc.
46
</Note>
47
48
<Frame background="subtle" title="Auth Config Settings">
@@ -50,7 +50,7 @@ The dashboard offers a guided process for all app types.
50
</Frame>
51
</Step>
52
<Step title="Create and Get auth config ID">
53
- Click **"Create Integration"**. After creation, **copy the displayed starting with `ac_`**. This is your auth config ID. This is _not_ a sensitive ID -- you can save it in environment variables or a database.
53
+ Click **"Create Integration"**. After creation, **copy the displayed ID starting with `ac_`**. This is your auth config ID. This is _not_ a sensitive ID -- you can save it in environment variables or a database.
54
**This ID will be used to create connections to the toolkit for a given user.**
55
</Step>
56
</Steps>
@@ -105,7 +105,7 @@ If you know the required authentication fields for your toolkit (like `apiKey` f
105
## Specifying auth schemes
106
Composio supports a wide range of auth schemes; OAuth2, API Key, HTTP Basic and many more.
107
Each app (and toolkit) has different connection options required for each auth scheme. For example;
108
-- Shopify requires an *API key* from each user from each user for the API Key auth scheme.
108
+- Shopify requires an *API key* from each user for the API Key auth scheme.
109
- Airtable requires the Bearer token from each user for the *Bearer* auth scheme.
110
111
The auth scheme information is typed and can be configured as follows:
fern/pages/src/tool-calling/before-execution-modifiers.mdx
+2
-2
@@ -96,7 +96,7 @@ if (tool_calls) {
96
arguments: JSON.parse(toolArgs),
97
},
98
{
99
- beforeExecute: { toolSlug, toolkitSlug, params }) => {
99
+ beforeExecute: ({ toolSlug, toolkitSlug, params }) => {
100
if (toolSlug === "HACKERNEWS_GET_LATEST_POSTS") {
101
params.arguments.size = 1;
102
}
@@ -142,7 +142,7 @@ tools = composio.tools.get(
142
"LINEAR_CREATE_LINEAR_ISSUE",
143
],
144
modifiers=[
145
- after_execute_modifier,
145
+ modify_linear_project_id,
146
]
147
)
148
```
fern/pages/src/tool-calling/custom-tools.mdx
+2
-2
@@ -75,14 +75,14 @@ const tool = await composio.tools.createCustomTool({
75
slug: 'GITHUB_STAR_COMPOSIOHQ_REPOSITORY',
76
name: 'Github star composio repositories',
77
toolkitSlug: 'github',
78
- description: 'Star any specificied repo of `composiohq` user',
78
+ description: 'Star any specified repo of `composiohq` user',
79
inputParams: z.object({
80
repository: z.string().describe('The repository to star'),
81
page: z.number().optional().describe('Pagination page number'),
82
customHeader: z.string().optional().describe('Custom header'),
83
}),
84
execute: async (input, connectionConfig, executeToolRequest) => {
85
- // This method makes authenticated requests to relevant API
85
+ // This method makes authenticated requests to the relevant API
86
// You can use relative paths!
87
// Composio will automatically inject the baseURL
88
const result = await executeToolRequest({
fern/pages/src/tool-calling/executing-tools.mdx
+2
-2
@@ -6,7 +6,7 @@ subtitle: "Learn how to execute Composio's tools with different providers and fr
6
hide-nav-links: false
7
---
8
9
-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.
9
+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 tool, for example, `GMAIL_SEND_EMAIL` to go and accomplish the task autonomously.
10
11
## Using Chat Completions
12
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.
@@ -58,7 +58,7 @@ Each tool and tool action is scoped to a user. Hence, a `user_id` is required to
58
The authentication state is checked and used while fetching and executing a tool.
59
60
You need to authorize the user to execute tools.
61
-For more information on authentication, see [Authenticating Tools](./authenticating-tools).
61
+For more information on authentication, see [Authenticating Tools](./authenticating-tools).
62
63
## For Humans (deterministic tool calling)
64
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.
fern/pages/src/tool-calling/fetching-tools.mdx
+3
-3
@@ -13,7 +13,7 @@ This process returns a union of all tools that match the specified criteria, ens
13
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.
14
15
## Filtering by toolkit
16
-Toolkits are collections of tools that from a specific app!
16
+Toolkits are collections of tools from a specific app!
17
18
Fetching tools from a toolkit is a good way to get a sense of the tools available.
19
@@ -122,7 +122,7 @@ const tools = await composio.tools.get(userId, {
122
</CodeGroup>
123
124
## Fetching raw tools
125
-To examine the raw schema definitition of a tool to understand the input/output parameters or to build custom logic around tool definitions, you can use the following methods. This can be useful for:
125
+To examine the raw schema definition of a tool to understand the input/output parameters or to build custom logic around tool definitions, you can use the following methods. This can be useful for:
126
- Understanding exact input parameters and output structures.
127
- Building custom logic around tool definitions.
128
- Debugging tool interactions.
@@ -203,4 +203,4 @@ When fetching tools, you must use one of these filter combinations:
203
{ search: "query", toolkits?: string[], limit?: number }
204
```
205
206
-These combinations are mutually exclusive - you can't mix `tools` with `search` or use `scopes` with multiple toolkits.
\ No newline at end of file
206
+These combinations are mutually exclusive - you can't mix `tools` with `search` or use `scopes` with multiple toolkits.
\ No newline at end of file
fern/pages/src/tool-calling/schema-modifiers.mdx
+3
-3
@@ -153,15 +153,15 @@ const tools = await composio.tools.get(
153
tools: ['HACKERNEWS_GET_LATEST_POSTS', 'HACKERNEWS_GET_USER'],
154
},
155
{
156
- modifyToolSchema: (toolSlug, _, toolSchema) => {
156
+ modifyToolSchema: ({ toolSlug, toolkitSlug, schema }) => {
157
if (toolSlug === 'HACKERNEWS_GET_LATEST_POSTS') {
158
- const { inputParameters } = toolSchema;
158
+ const { inputParameters } = schema;
159
if (inputParameters?.properties) {
160
delete inputParameters.properties['page'];
161
}
162
inputParameters.required = ['size'];
163
}
164
- return toolSchema;
164
+ return schema;
165
},
166
}
167
);
fern/pages/src/triggers/using-triggers.mdx
+1
-1
@@ -131,7 +131,7 @@ Below are some examples of how to listen in on trigger events for a FastAPI/Next
131
</CodeGroup>
132
133
## Trigger payload types
134
-When subscribing to triggers, it is helpful to know the payload type recieved from the trigger. You can inspect the payload type by fetching the trigger type.
134
+When subscribing to triggers, it is helpful to know the payload type received from the trigger. You can inspect the payload type by fetching the trigger type.
135
136
<CodeGroup>
137
```python Python maxLines=60 wordWrap