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
added dev setup doc (#1625)
Siddharth Balyanf1202b4f2351
diff --git a/.github/workflows/preview_docs.yml b/.github/workflows/preview_docs.ymlindex 5d0acaa78..4f4f9d678 100644--- a/.github/workflows/preview_docs.yml+++ b/.github/workflows/preview_docs.yml@@ -30,7 +30,7 @@ jobs:uv run composio apps generate-types- name: Generate Tool Documentation- run: pnpm tools:generate+ run: pnpm tools:generate && pnpm tools:uncomment- name: Generate SDK Referencerun: pnpm sdkdocsdiff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.ymlindex 458d18162..c1f631106 100644--- a/.github/workflows/publish_docs.yml+++ b/.github/workflows/publish_docs.yml@@ -30,7 +30,7 @@ jobs:uv run composio apps generate-types- name: Generate Tool Documentation- run: pnpm tools:generate+ run: pnpm tools:generate && pnpm tools:uncomment- name: Generate SDK Referencerun: pnpm sdkdocsdiff --git a/fern/assets/images/cursor-settings.png b/fern/assets/images/cursor-settings.pngnew file mode 100644index 000000000..3cb8e4c9aBinary files /dev/null and b/fern/assets/images/cursor-settings.png differdiff --git a/fern/docs.yml b/fern/docs.ymlindex 54ac97a34..24a147268 100644--- a/fern/docs.yml+++ b/fern/docs.yml@@ -133,9 +133,9 @@ navigation:- page: Quickstartpath: pages/get-started/quickstart.mdxslug: quickstart- - page: Configuration- path: pages/get-started/configuration.mdx- slug: configuration+ - page: IDE and Agent Setup+ path: pages/get-started/dev-setup.mdx+ slug: dev-setup- page: Providerspath: pages/get-started/providers.mdxslug: providersdiff --git a/fern/pages/get-started/configuration.mdx b/fern/pages/get-started/configuration.mdxdeleted file mode 100644index d17c916ba..000000000--- a/fern/pages/get-started/configuration.mdx+++ /dev/null@@ -1,89 +0,0 @@-----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 filediff --git a/fern/pages/get-started/dev-setup.mdx b/fern/pages/get-started/dev-setup.mdxnew file mode 100644index 000000000..2e88159cf--- /dev/null+++ b/fern/pages/get-started/dev-setup.mdx@@ -0,0 +1,99 @@+---+title: IDE and Agent Setup+subtitle: "Setup your AI IDE and agent to help you ship faster with Composio"+slug: /docs/dev-setup+image: "" # image for socials+keywords: ""+hide-nav-links: false+---++This guide explains how to setup your IDE, and coding agents to help you ship faster with Composio.++## Generate types for tools+<CodeGroup>+```typescript TypeScript maxLines=60 wordWrap++```++```python Python maxLines=60 wordWrap++```+</CodeGroup>++## Optimise Cursor+To optimize your experience building with Composio, you can add instructions to Cursor's system settings.++<Frame>+<img src="../../assets/images/cursor-settings.png" alt="Cursor settings" />+</Frame>++Add the following to your Cursor "Rules for AI":++<CodeGroup>+```md TypeScript+You are the best TypeScript developer known for your high taste and usage of new and cutting-edge practices.+You are building with Composio's TypeScript SDK. Composio is platform for building with authenticated tools for AI agents and workflows.+It lets you build agents that that can work across a user's apps like Gmail, Notion, Slack.++Below is a list of Composio documentation. Use your web and fetch capabilities to read the documentation you need.+[Composio Documentation](https://v3.docs.composio.dev)+- [Quickstart](https://v3.docs.composio.dev/docs/quickstart.mdx): Add authenticated tool-calling to any LLM agent in three steps.+- [Configuration](https://v3.docs.composio.dev/docs/configuration.mdx)+- [Providers](https://v3.docs.composio.dev/docs/toolsets.mdx)+- [Executing Tools](https://v3.docs.composio.dev/docs/executing-tools.mdx): Learn how to execute Composio's tools with different providers and frameworks+- [Authenticating Tools](https://v3.docs.composio.dev/docs/authenticating-tools.mdx): Learn how to authenticate tools+- [Fetching and Filtering Tools](https://v3.docs.composio.dev/docs/fetching-tools.mdx): Learn how to fetch and filter Composio's tools and toolsets+- [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.+- [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.+- [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.+- [Creating custom tools](https://v3.docs.composio.dev/docs/custom-tools.mdx): Learn how to extend Composio's toolkits with your own tools+- [Custom Auth Configs](https://v3.docs.composio.dev/docs/custom-auth-configs.mdx): Guide to using customising auth configs for a toolkit+- [Programmatic Auth Configs](https://v3.docs.composio.dev/docs/programmatic-auth-configs.mdx): Guide to creating auth configs programmatically+- [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+- [Using Triggers](https://v3.docs.composio.dev/docs/using-triggers.mdx): Send payloads to your system based on external events+- [OpenAI Providers](https://v3.docs.composio.dev/providers/openai.mdx)+- [Anthropic Provider](https://v3.docs.composio.dev/providers/anthropic.mdx)+- [LangGraph Provider](https://v3.docs.composio.dev/providers/langgraph.mdx)+- [CrewAI Provider](https://v3.docs.composio.dev/providers/crewai.mdx)+- [Vercel AI SDK Provider](https://v3.docs.composio.dev/providers/vercel.mdx)+- [Google ADK Provider](https://v3.docs.composio.dev/providers/google-adk.mdx)+- [OpenAI Agents Provider](https://v3.docs.composio.dev/providers/openai-agents.mdx)+- [Mastra Provider](https://v3.docs.composio.dev/providers/mastra.mdx)+- [Custom Providers](https://v3.docs.composio.dev/toolsets/custom.mdx)++```++```md Python+You are the best Python developer known for your high taste and usage of new and cutting-edge practices.+You are building with Composio's Python SDK. Composio is platform for building with authenticated tools for AI agents and workflows.+It lets you build agents that that can work across a user's apps like Gmail, Notion, Slack.++Below is a list of Composio documentation. Use your web and fetch capabilities to read the documentation you need.+[Composio Documentation](https://v3.docs.composio.dev)+- [Quickstart](https://v3.docs.composio.dev/docs/quickstart.mdx): Add authenticated tool-calling to any LLM agent in three steps.+- [Configuration](https://v3.docs.composio.dev/docs/configuration.mdx)+- [Providers](https://v3.docs.composio.dev/docs/toolsets.mdx)+- [Executing Tools](https://v3.docs.composio.dev/docs/executing-tools.mdx): Learn how to execute Composio's tools with different providers and frameworks+- [Authenticating Tools](https://v3.docs.composio.dev/docs/authenticating-tools.mdx): Learn how to authenticate tools+- [Fetching and Filtering Tools](https://v3.docs.composio.dev/docs/fetching-tools.mdx): Learn how to fetch and filter Composio's tools and toolsets+- [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.+- [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.+- [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.+- [Creating custom tools](https://v3.docs.composio.dev/docs/custom-tools.mdx): Learn how to extend Composio's toolkits with your own tools+- [Custom Auth Configs](https://v3.docs.composio.dev/docs/custom-auth-configs.mdx): Guide to using customising auth configs for a toolkit+- [Programmatic Auth Configs](https://v3.docs.composio.dev/docs/programmatic-auth-configs.mdx): Guide to creating auth configs programmatically+- [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+- [Using Triggers](https://v3.docs.composio.dev/docs/using-triggers.mdx): Send payloads to your system based on external events+- [OpenAI Providers](https://v3.docs.composio.dev/providers/openai.mdx)+- [Anthropic Provider](https://v3.docs.composio.dev/providers/anthropic.mdx)+- [LangGraph Provider](https://v3.docs.composio.dev/providers/langgraph.mdx)+- [CrewAI Provider](https://v3.docs.composio.dev/providers/crewai.mdx)+- [Vercel AI SDK Provider](https://v3.docs.composio.dev/providers/vercel.mdx)+- [Google ADK Provider](https://v3.docs.composio.dev/providers/google-adk.mdx)+- [OpenAI Agents Provider](https://v3.docs.composio.dev/providers/openai-agents.mdx)+- [Mastra Provider](https://v3.docs.composio.dev/providers/mastra.mdx)+- [Custom Providers](https://v3.docs.composio.dev/toolsets/custom.mdx)+```+</CodeGroup>++