@devries-cameron20 / composio Mirror · read-only / commits / e42ff4b07
Fork 0

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 21, 21:00 UTC

docs: use OpenAI agents tool names

Dhawal Upadhyay committed May 8, 2026 at 13:26 UTC e42ff4b0786c715084d789884d10fba06cc3980d
3 files changed +80 -13
docs/content/changelog/05-07-26-toolrouter-preload-direct-tools.mdx
+30 -6
@@ -22,8 +22,12 @@ generally fewer than 20 tools, to avoid context bloat.
22 <Tab value="Python">
23 ```python
24 from composio import Composio
25 +from composio_openai_agents import OpenAIAgentsProvider
26
26 -composio = Composio(api_key="your_api_key")
27 +composio = Composio(
28 + api_key="your_api_key",
29 + provider=OpenAIAgentsProvider(),
30 +)
31
32 session = composio.create(
33 user_id="user_123",
@@ -44,8 +48,12 @@ print([tool.name for tool in tools])
48 <Tab value="TypeScript">
49 ```typescript
50 import { Composio } from '@composio/core';
51 +import { OpenAIAgentsProvider } from '@composio/openai-agents';
52
48 -const composio = new Composio({ apiKey: 'your_api_key' });
53 +const composio = new Composio({
54 + apiKey: 'your_api_key',
55 + provider: new OpenAIAgentsProvider(),
56 +});
57
58 const session = await composio.create('user_123', {
59 toolkits: ['gmail'],
@@ -74,8 +82,12 @@ disable session meta tools by default.
82 <Tab value="Python">
83 ```python
84 from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
85 +from composio_openai_agents import OpenAIAgentsProvider
86
78 -composio = Composio(api_key="your_api_key")
87 +composio = Composio(
88 + api_key="your_api_key",
89 + provider=OpenAIAgentsProvider(),
90 +)
91
92 session = composio.create(
93 user_id="user_123",
@@ -97,8 +109,12 @@ print([tool.name for tool in tools])
109 <Tab value="TypeScript">
110 ```typescript
111 import { Composio, SessionPreset } from '@composio/core';
112 +import { OpenAIAgentsProvider } from '@composio/openai-agents';
113
101 -const composio = new Composio({ apiKey: 'your_api_key' });
114 +const composio = new Composio({
115 + apiKey: 'your_api_key',
116 + provider: new OpenAIAgentsProvider(),
117 +});
118
119 const session = await composio.create('user_123', {
120 toolkits: ['gmail'],
@@ -125,8 +141,12 @@ can be enabled alongside the preset:
141 <Tab value="Python">
142 ```python
143 from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
144 +from composio_openai_agents import OpenAIAgentsProvider
145
129 -composio = Composio(api_key="your_api_key")
146 +composio = Composio(
147 + api_key="your_api_key",
148 + provider=OpenAIAgentsProvider(),
149 +)
150
151 session = composio.create(
152 user_id="user_123",
@@ -153,8 +173,12 @@ print([tool.name for tool in tools])
173 <Tab value="TypeScript">
174 ```typescript
175 import { Composio, SessionPreset } from '@composio/core';
176 +import { OpenAIAgentsProvider } from '@composio/openai-agents';
177
157 -const composio = new Composio({ apiKey: 'your_api_key' });
178 +const composio = new Composio({
179 + apiKey: 'your_api_key',
180 + provider: new OpenAIAgentsProvider(),
181 +});
182
183 const session = await composio.create('user_123', {
184 toolkits: ['gmail'],
docs/content/docs/configuring-sessions.mdx
+40 -5
@@ -114,6 +114,14 @@ Requires `@composio/core` ≥ `0.9.0` (TypeScript) or `composio` ≥ `0.13.0`
114 <Tabs groupId="language" items={['Python', 'TypeScript']} persist>
115 <Tab value="Python">
116 ```python
117 +from composio import Composio
118 +from composio_openai_agents import OpenAIAgentsProvider
119 +
120 +composio = Composio(
121 + api_key="your_api_key",
122 + provider=OpenAIAgentsProvider(),
123 +)
124 +
125 session = composio.create(
126 user_id="user_123",
127 toolkits=["gmail"],
@@ -136,7 +144,12 @@ print([tool.name for tool in tools])
144 <Tab value="TypeScript">
145 ```typescript
146 import { Composio } from '@composio/core';
139 -const composio = new Composio({ apiKey: 'your_api_key' });
147 +import { OpenAIAgentsProvider } from '@composio/openai-agents';
148 +
149 +const composio = new Composio({
150 + apiKey: 'your_api_key',
151 + provider: new OpenAIAgentsProvider(),
152 +});
153 // ---cut---
154 const session = await composio.create("user_123", {
155 toolkits: ["gmail"],
@@ -177,7 +190,13 @@ context bloat.
190 <Tabs groupId="language" items={['Python', 'TypeScript']} persist>
191 <Tab value="Python">
192 ```python
180 -from composio import SESSION_PRESET_DIRECT_TOOLS
193 +from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
194 +from composio_openai_agents import OpenAIAgentsProvider
195 +
196 +composio = Composio(
197 + api_key="your_api_key",
198 + provider=OpenAIAgentsProvider(),
199 +)
200
201 session = composio.create(
202 user_id="user_123",
@@ -202,7 +221,12 @@ print([tool.name for tool in tools])
221 <Tab value="TypeScript">
222 ```typescript
223 import { Composio, SessionPreset } from '@composio/core';
205 -const composio = new Composio({ apiKey: 'your_api_key' });
224 +import { OpenAIAgentsProvider } from '@composio/openai-agents';
225 +
226 +const composio = new Composio({
227 + apiKey: 'your_api_key',
228 + provider: new OpenAIAgentsProvider(),
229 +});
230 // ---cut---
231 const session = await composio.create("user_123", {
232 toolkits: ["gmail"],
@@ -232,7 +256,13 @@ support available:
256 <Tabs groupId="language" items={['Python', 'TypeScript']} persist>
257 <Tab value="Python">
258 ```python
235 -from composio import SESSION_PRESET_DIRECT_TOOLS
259 +from composio import Composio, SESSION_PRESET_DIRECT_TOOLS
260 +from composio_openai_agents import OpenAIAgentsProvider
261 +
262 +composio = Composio(
263 + api_key="your_api_key",
264 + provider=OpenAIAgentsProvider(),
265 +)
266
267 session = composio.create(
268 user_id="user_123",
@@ -266,7 +296,12 @@ print([tool.name for tool in tools])
296 <Tab value="TypeScript">
297 ```typescript
298 import { Composio, SessionPreset } from '@composio/core';
269 -const composio = new Composio({ apiKey: 'your_api_key' });
299 +import { OpenAIAgentsProvider } from '@composio/openai-agents';
300 +
301 +const composio = new Composio({
302 + apiKey: 'your_api_key',
303 + provider: new OpenAIAgentsProvider(),
304 +});
305 // ---cut---
306 const session = await composio.create("user_123", {
307 toolkits: ["gmail"],
docs/content/docs/toolkits/custom-tools-and-toolkits.mdx
+10 -2
@@ -98,8 +98,12 @@ const getUserProfile = experimental_createTool("GET_USER_PROFILE", {
98 from pydantic import BaseModel, Field
99
100 from composio import Composio
101 +from composio_openai_agents import OpenAIAgentsProvider
102
102 -composio = Composio(api_key="your_api_key")
103 +composio = Composio(
104 + api_key="your_api_key",
105 + provider=OpenAIAgentsProvider(),
106 +)
107
108
109 class UserLookupInput(BaseModel):
@@ -497,9 +501,13 @@ preload applies to all tools in that toolkit; set `preload: false` /
501 <Tab value="TypeScript">
502 ```typescript
503 import { Composio, experimental_createTool } from "@composio/core";
504 +import { OpenAIAgentsProvider } from "@composio/openai-agents";
505 import { z } from "zod/v3";
506
502 -const composio = new Composio({ apiKey: "your_api_key" });
507 +const composio = new Composio({
508 + apiKey: "your_api_key",
509 + provider: new OpenAIAgentsProvider(),
510 +});
511
512 const replyGuide = experimental_createTool("GET_REPLY_STYLE_GUIDE", {
513 name: "Get reply style guide",