Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
docs: update readme (#1977)
Prathit942ec7777809
diff --git a/README.md b/README.mdindex eb093e003..2ab161973 100644--- a/README.md+++ b/README.md@@ -1,10 +1,19 @@-++<div align="center">++<img src="https://raw.githubusercontent.com/ComposioHQ/composio/next/public/logo.png" alt="Composio Logo" width="200" height="auto" style="margin-bottom: 20px;"/>+# Composio SDK-| This is the preview for our next generation sdk, you can learn more about them here and how to move here https://v3.docs.composio.dev/docs/migration+Skills that evolve for your Agents-_if you are looking for the older sdk, you can find them [here](https://github.com/ComposioHQ/composio/tree/master)_+[🌐 Website](https://composio.dev) • [📚 Documentation](https://docs.composio.dev)++[](https://github.com/ComposioHQ/composio/stargazers)+[](https://pypi.org/project/composio/)+[](https://www.npmjs.com/package/@composio/core)+</div>This repository contains the official Software Development Kits (SDKs) for Composio, providing seamless integration capabilities across multiple programming languages.@@ -33,7 +42,7 @@ yarn add @composio/core@nextpnpm add @composio/core@next```-Quick start:+#### Quick start:```typescriptimport { Composio } from '@composio/core';@@ -43,6 +52,44 @@ const composio = new Composio({});```+#### Simple Agent with OpenAI++```bash+npm install @composio/openai+```++```typescript+import { Composio } from '@composio/core';+import { OpenAIResponsesProvider, OpenAIProvider } from '@composio/openai';+import { OpenAI } from 'openai';++const openai = new OpenAI();++const composioForCompletions = new Composio({ provider: new OpenAIProvider() });++const userId = '[email protected]'++const toolsForCompletions = await composioForCompletions.tools.get(userId, {+ toolkits: ['HACKERNEWS'],+});++const completion = await openai.chat.completions.create({+ model: 'gpt-5',+ messages: [+ {+ role: 'user',+ content: 'What is the latest hackernews post about?',+ },+ ],+ tools: toolsForCompletions,+});++const newResult = await composioForCompletions.provider.handleToolCalls(userId, completion);++console.log(JSON.stringify(newResult, null, 2));+// will return the raw response from the HACKERNEWS API.+```+### Python SDK Installation```bash@@ -53,7 +100,7 @@ pip install composiopoetry add composio```-Quick start:+#### Quick start:```pythonfrom composio import Composio@@ -64,6 +111,38 @@ composio = Composio()```+#### Simple Agent with OpenAI++```bash+pip install composio_openai>=0.8.0+```++```python+from openai import OpenAI+from composio import Composio+from composio_openai import OpenAIProvider++# Initialize Composio client with OpenAI Provider+composio = Composio(provider=OpenAIProvider())+openai = OpenAI()++user_id = "[email protected]"+tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])++response = openai.chat.completions.create(+ model="gpt-5",+ tools=tools,+ messages=[+ {"role": "user", "content": "What's the latest Hackernews post about?"},+ ],+)++# Execute the function calls.+result = composio.provider.handle_tool_calls(response=response, user_id=user_id)+print(result)+# will return the raw response from the HACKERNEWS API.+```+For more detailed usage instructions and examples, please refer to each SDK's specific documentation.### Open API Specification@@ -93,6 +172,7 @@ The Python SDK offers a Pythonic interface to Composio's services, making it easFor detailed information about the Python SDK, please refer to the [Python SDK Documentation](/python/README.md).+_if you are looking for the older sdk, you can find them [here](https://github.com/ComposioHQ/composio/tree/master)_## Contributingdiff --git a/public/logo.png b/public/logo.pngnew file mode 100644index 000000000..db9c969bbBinary files /dev/null and b/public/logo.png differ