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.

Docs: Restructure the main tabs and changes in paths (#2183)

Sushmitha Malleshd9014b9d9561
diff --git a/fern/docs.yml b/fern/docs.yml
index 57aa28599..85cb8e165 100644
--- a/fern/docs.yml
+++ b/fern/docs.yml
@@ -42,7 +42,7 @@ layout:
tabs-placement: header
searchbar-placement: header
header-height: 64px
- sidebar-width: 298px
+ sidebar-width: 255px
ai-search:
location:
- docs
@@ -81,34 +81,34 @@ analytics:
redirects:
- source: /tools/:path
destination: /toolkits/:path
+- source: /changelog
+ destination: /docs/changelog
+- source: /changelog/:date
+ destination: /docs/changelog/:date
+- source: /sdk-reference/python
+ destination: /python
+- source: /sdk-reference/python/:path
+ destination: /python/:path
+- source: /sdk-reference/type-script
+ destination: /type-script
+- source: /sdk-reference/type-script/:path
+ destination: /type-script/:path
tabs:
docs:
- display-name: Guides
- icon: fa-light fa-book
+ display-name: Docs
slug: docs
- sdk-reference:
- display-name: SDK Reference
- icon: fa-light fa-code
- api-reference:
- display-name: API Reference
- icon: fa-light fa-server
+ providers:
+ display-name: Providers
skip-slug: true
toolkits:
display-name: Toolkits
- icon: fa-light fa-tools
skip-slug: true
- providers:
- display-name: Providers
- icon: fa-light fa-code
+ api-reference:
+ display-name: API Reference
skip-slug: true
examples:
display-name: Examples
- icon: fa-light fa-running
skip-slug: true
- changelog:
- display-name: Changelog
- icon: fa-light fa-history
- changelog: ./pages/src/changelog
navigation:
- tab: docs
layout:
@@ -128,36 +128,42 @@ navigation:
- page: Providers
path: pages/dist/get-started/providers.mdx
slug: providers
- - section: Tools
+ - changelog: ./pages/src/changelog
+ title: Changelog
+ slug: changelog
+ - section: Tools and Triggers
icon: fa-light fa-wrench
skip-slug: true
contents:
- - page: Authenticating Tools
- path: pages/dist/tool-calling/authenticating-tools.mdx
- slug: authenticating-tools
- page: Fetching tools and schemas
- path: pages/dist/tool-calling/fetching-tools.mdx
+ path: pages/dist/tools-and-triggers/fetching-tools.mdx
slug: fetching-tools
+ - page: Authenticating Tools
+ path: pages/dist/tools-and-triggers/authenticating-tools.mdx
+ slug: authenticating-tools
- page: Executing Tools
- path: pages/dist/tool-calling/executing-tools.mdx
+ path: pages/dist/tools-and-triggers/executing-tools.mdx
slug: executing-tools
+ - page: Using Triggers
+ path: pages/dist/tools-and-triggers/using-triggers.mdx
+ slug: using-triggers
- section: Modify tool behavior
slug: tools/modify
contents:
- page: Modifying tool schemas
- path: pages/dist/tool-calling/schema-modifiers.mdx
+ path: pages/dist/tools-and-triggers/schema-modifiers.mdx
slug: modifying-tool-schemas
- page: Modifying tool inputs
- path: pages/dist/tool-calling/before-execution-modifiers.mdx
+ path: pages/dist/tools-and-triggers/before-execution-modifiers.mdx
slug: modifying-tool-inputs
- page: Modifying tool outputs
- path: pages/dist/tool-calling/after-execution-modifiers.mdx
+ path: pages/dist/tools-and-triggers/after-execution-modifiers.mdx
slug: modifying-tool-outputs
- page: Custom tools
- path: pages/dist/tool-calling/custom-tools.mdx
+ path: pages/dist/tools-and-triggers/custom-tools.mdx
slug: custom-tools
- page: Toolkit Versioning
- path: pages/dist/tool-calling/toolkit-versioning.mdx
+ path: pages/dist/tools-and-triggers/toolkit-versioning.mdx
slug: toolkit-versioning
- section: Authentication
icon: fa-light fa-key
@@ -178,13 +184,6 @@ navigation:
- page: User Management
path: pages/dist/authentication/user-management.mdx
slug: user-management
- - section: Triggers
- icon: fa-light fa-bolt
- skip-slug: true
- contents:
- - page: Using Triggers
- path: pages/dist/triggers/using-triggers.mdx
- slug: using-triggers
- section: MCP
icon: fa-light fa-database
skip-slug: true
@@ -257,49 +256,9 @@ navigation:
- page: Triggers
path: pages/dist/resources/troubleshooting/triggers.mdx
slug: triggers
-- tab: examples
- layout:
- - section: Getting Started
- icon: fa-light fa-rocket
- skip-slug: true
- contents:
- - page: Basic FastAPI Server
- path: pages/dist/examples/fast-api.mdx
- slug: examples/fast-api
- - page: Basic Hono Server
- path: pages/dist/examples/hono.mdx
- slug: examples/hono
- - section: Productivity & Automation
- icon: fa-light fa-bolt
- skip-slug: true
- contents:
- - page: Gmail Labeller
- path: pages/dist/examples/utility_agents/gmail_labeler.mdx
- slug: examples/gmail-labeler
- - page: Slack summariser
- path: pages/dist/examples/utility_agents/slack_summariser.mdx
- slug: examples/slack-summariser
- - page: Supabase SQL Agent
- path: pages/dist/examples/utility_agents/supabase_sql_agent.mdx
- slug: examples/supabase-sql-agent
- - section: Full Stack Applications
- icon: fa-light fa-globe
- skip-slug: true
- contents:
- - page: Full Stack Chat App
- path: pages/dist/examples/chat_applications/vercel_chat.mdx
- slug: examples/vercel-chat
- - section: Behind the curtain
- icon: fa-light fa-person-booth
- skip-slug: true
- contents:
- - page: Tool Generator
- path: pages/dist/examples/tool-generator/tool-generator.mdx
- slug: examples/tool-generator
- tab: providers
layout:
- section: Supported Providers
- icon: fa-light fa-code
contents:
- page: OpenAI Provider
path: pages/dist/providers/openai.mdx
@@ -364,16 +323,23 @@ navigation:
- page: Composio
slug: toolkits/composio
path: toolkits/composio.mdx
-- tab: sdk-reference
+- tab: api-reference
layout:
- - section: Python
+ - section: REST API
+ contents:
+ - api: v3
+ api-name: v3
+ skip-slug: true
+ paginated: false
+ flattened: true
+ - section: Python SDK
slug: python
icon: fa-brands fa-python
contents:
- page: Python SDK Reference
slug: python-sdk-reference
path: pages/dist/sdk/python/sdk-reference.md
- - section: TypeScript
+ - section: TypeScript SDK
slug: type-script
icon: fa-brands fa-js
contents:
@@ -416,13 +382,42 @@ navigation:
- page: CustomTools
slug: custom-tools
path: pages/dist/sdk/typescript/CustomTools/classes/CustomTools.mdx
-- tab: api-reference
+- tab: examples
layout:
- - section: API Reference
+ - section: Getting Started
+ icon: fa-light fa-rocket
+ skip-slug: true
contents:
- - api: v3
- api-name: v3
- skip-slug: true
- paginated: false
- flattened: true
-- tab: changelog
+ - page: Basic FastAPI Server
+ path: pages/dist/examples/fast-api.mdx
+ slug: examples/fast-api
+ - page: Basic Hono Server
+ path: pages/dist/examples/hono.mdx
+ slug: examples/hono
+ - section: Productivity & Automation
+ icon: fa-light fa-bolt
+ skip-slug: true
+ contents:
+ - page: Gmail Labeller
+ path: pages/dist/examples/utility_agents/gmail_labeler.mdx
+ slug: examples/gmail-labeler
+ - page: Slack summariser
+ path: pages/dist/examples/utility_agents/slack_summariser.mdx
+ slug: examples/slack-summariser
+ - page: Supabase SQL Agent
+ path: pages/dist/examples/utility_agents/supabase_sql_agent.mdx
+ slug: examples/supabase-sql-agent
+ - section: Full Stack Applications
+ icon: fa-light fa-globe
+ skip-slug: true
+ contents:
+ - page: Full Stack Chat App
+ path: pages/dist/examples/chat_applications/vercel_chat.mdx
+ slug: examples/vercel-chat
+ - section: Behind the curtain
+ icon: fa-light fa-person-booth
+ skip-slug: true
+ contents:
+ - page: Tool Generator
+ path: pages/dist/examples/tool-generator/tool-generator.mdx
+ slug: examples/tool-generator
diff --git a/fern/llms-txt-worker/src/index.ts b/fern/llms-txt-worker/src/index.ts
index 9f5f0df4f..4a9899047 100644
--- a/fern/llms-txt-worker/src/index.ts
+++ b/fern/llms-txt-worker/src/index.ts
@@ -13,9 +13,11 @@ export default {
async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
const url = new URL(request.url);
- // Serve static llms.txt
- if (url.pathname === '/llms.txt') {
- return env.ASSETS.fetch(request);
+ // Serve static llms.txt for both /llm.txt and /llms.txt
+ if (url.pathname === '/llms.txt' || url.pathname === '/llm.txt') {
+ // Always fetch the llms.txt file, regardless of which path was requested
+ const llmsRequest = new Request(new URL('/llms.txt', request.url).toString(), request);
+ return env.ASSETS.fetch(llmsRequest);
}
// Serve robots-only/tools.json
diff --git a/fern/pages/src/authentication/custom-auth-configs.mdx b/fern/pages/src/authentication/custom-auth-configs.mdx
index a37015cdc..31e1824ff 100644
--- a/fern/pages/src/authentication/custom-auth-configs.mdx
+++ b/fern/pages/src/authentication/custom-auth-configs.mdx
@@ -20,7 +20,7 @@ You'll need to customize the auth config when you want to use different values t
<Tab title="Example: PostHog">
You may change the subdomain for the PostHog toolkit to match your own instance.
<Frame background="subtle" title="PostHog Auth Config Settings">
-<img src="../../../assets/images/custom-auth-posthog.png" />
+<img src="../../../assets/images/custom-auth-posthog.png" style={{ maxHeight: '400px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
</Tab>
<Tab title="Example: Hubspot">
@@ -29,7 +29,7 @@ For Hubspot you may customize everything here. For each auth scheme there is a d
If you choose to use your own developer app for the OAuth2 scheme, you will have to provide the client ID and client secret.
<Frame background="subtle" title="Hubspot Auth Config Settings">
-<img src="../../../assets/images/custom-auth-hubspot.png" />
+<img src="../../../assets/images/custom-auth-hubspot.png" style={{ maxHeight: '400px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
</Tab>
</Tabs>
@@ -56,12 +56,12 @@ Examples for Google and GitHub:
<Tabs>
<Tab title="Google">
<Frame background="subtle" caption="Google OAuth Configuration">
- <img src="../../../assets/images/google-oauth-config.png" />
+ <img src="../../../assets/images/google-oauth-config.png" style={{ maxHeight: '400px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
</Tab>
<Tab title="GitHub">
<Frame background="subtle" caption="GitHub OAuth Configuration">
- <img src="../../../assets/images/github-oauth-config.png" />
+ <img src="../../../assets/images/github-oauth-config.png" style={{ maxHeight: '400px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
</Tab>
</Tabs>
@@ -84,7 +84,7 @@ Once you have the OAuth credentials, you can add them to the auth config in the
4. Click Create!
<Frame background="subtle" title="Auth Config Settings">
- <img src="../../../assets/images/integration-step-3-0.png" />
+ <img src="../../../assets/images/integration-step-3-0.png" style={{ maxHeight: '450px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
@@ -126,7 +126,7 @@ console.log(connection);
By default the users will see an OAuth screen like the one below:
<Frame background="subtle" caption="Composio's Domain in OAuth Consent Screen">
- <img src="../../../assets/images/oauth-branding.png" />
+ <img src="../../../assets/images/oauth-branding.png" style={{ maxHeight: '350px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
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.
@@ -205,7 +205,7 @@ res.redirect(302, redirectUrl);
Specify your custom redirect URI in the auth config settings!
<Frame background="subtle" title="Auth Config Settings">
-<img src="../../../assets/images/custom-redirect-uri.png" />
+<img src="../../../assets/images/custom-redirect-uri.png" style={{ maxHeight: '400px', width: 'auto', display: 'block', margin: '0 auto' }} />
</Frame>
</Step>
</Steps>
diff --git a/fern/pages/src/get-started/dev-setup.mdx b/fern/pages/src/get-started/dev-setup.mdx
index 66c1f869b..b1118c00a 100644
--- a/fern/pages/src/get-started/dev-setup.mdx
+++ b/fern/pages/src/get-started/dev-setup.mdx
@@ -9,6 +9,10 @@ hide-nav-links: false
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.
+<Tip>
+For LLMs: Use [llms.txt](https://docs.composio.dev/llms.txt) to index our documentation
+</Tip>
+
## Cursor
Cursor is an AI-powered code editor that can significantly accelerate your development with Composio. Here's how to set it up optimally.
@@ -51,6 +55,9 @@ To get the best experience building with Composio, add custom instructions to Cu
Below is a list of Composio documentation. Use your web and fetch capabilities to read the documentation you need.
[Composio Documentation](https://docs.composio.dev)
+For AI agents and LLMs, we also provide a structured documentation index at:
+[LLMs Text Documentation](https://docs.composio.dev/llms.txt)
+
- [Quickstart](https://docs.composio.dev/docs/quickstart.mdx): Add authenticated tool-calling to any LLM agent in three steps.
- [Configuration](https://docs.composio.dev/docs/configuration.mdx)
- [Providers](https://docs.composio.dev/docs/providers.mdx)
diff --git a/fern/pages/src/providers/py-custom.mdx b/fern/pages/src/providers/py-custom.mdx
index 9b805e105..5deb934a8 100644
--- a/fern/pages/src/providers/py-custom.mdx
+++ b/fern/pages/src/providers/py-custom.mdx
@@ -1,7 +1,7 @@
---
-title: Python custom provider
+title: Python Custom Provider
subtitle: Learn how to create custom providers for any AI framework in Python
-image: "https://og.composio.dev/api/og?title=Python%20custom%20provider" # image for socials
+image: "https://og.composio.dev/api/og?title=Python%20Custom%20Provider" # image for socials
keywords: ""
hide-nav-links: false
---
diff --git a/fern/pages/src/tool-calling/after-execution-modifiers.mdx b/fern/pages/src/tools-and-triggers/after-execution-modifiers.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/after-execution-modifiers.mdx
rename to fern/pages/src/tools-and-triggers/after-execution-modifiers.mdx
diff --git a/fern/pages/src/tool-calling/authenticating-tools.mdx b/fern/pages/src/tools-and-triggers/authenticating-tools.mdx
similarity index 95%
rename from fern/pages/src/tool-calling/authenticating-tools.mdx
rename to fern/pages/src/tools-and-triggers/authenticating-tools.mdx
index 4d3ac0de0..3dfe958e9 100644
--- a/fern/pages/src/tool-calling/authenticating-tools.mdx
+++ b/fern/pages/src/tools-and-triggers/authenticating-tools.mdx
@@ -43,6 +43,10 @@ An **Auth Config** is a _blueprint_ that defines how authentication works for a
**For custom authentication schemes:**
You must provide your own credentials regardless of environment.
+
+ <Tip>
+ Want to remove Composio branding from OAuth screens? See [Custom Auth Configs](/docs/custom-auth-configs#white-labeling-the-oauth-consent-screen) for white-labeling options.
+ </Tip>
</Step>
<Step title="**You are all set!**">
Click "**Create Auth Configuration**" button and you have completed your first step! Now you can
@@ -64,10 +68,15 @@ You should create multiple auth configs for the same toolkit when you need:
- **Different OAuth apps** - Using separate client credentials for different environments
- **Different permission levels** - Limiting actions for specific use cases
+<CardGroup cols={2}>
<Card title="Programmatic creation" href="/docs/programmatic-auth-configs" icon="fa-solid fa-code">
For managing auth configs across multiple projects, you can create them programmatically via the
API
</Card>
+<Card title="Production white-labeling" href="/docs/custom-auth-configs#white-labeling-the-oauth-consent-screen" icon="fa-solid fa-palette">
+ Remove Composio branding from OAuth screens for a fully white-labeled authentication experience
+</Card>
+</CardGroup>
## Connecting an account
@@ -122,6 +131,12 @@ By default, users will see a Composio-branded authentication experience when con
These settings will apply to all authentication flows using Connect Link, providing a white-labeled experience that maintains your brand identity throughout the authentication process.
+<Note>
+For complete white-labeling including OAuth consent screens (removing Composio's domain), see [Custom Auth Configs - White-labeling](/docs/custom-auth-configs#white-labeling-the-oauth-consent-screen).
+</Note>
+
+
+
### Direct SDK Integration
**Choose the section below that matches your toolkit's authentication method:**
diff --git a/fern/pages/src/tool-calling/before-execution-modifiers.mdx b/fern/pages/src/tools-and-triggers/before-execution-modifiers.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/before-execution-modifiers.mdx
rename to fern/pages/src/tools-and-triggers/before-execution-modifiers.mdx
diff --git a/fern/pages/src/tool-calling/custom-tools.mdx b/fern/pages/src/tools-and-triggers/custom-tools.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/custom-tools.mdx
rename to fern/pages/src/tools-and-triggers/custom-tools.mdx
diff --git a/fern/pages/src/tool-calling/executing-tools.mdx b/fern/pages/src/tools-and-triggers/executing-tools.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/executing-tools.mdx
rename to fern/pages/src/tools-and-triggers/executing-tools.mdx
diff --git a/fern/pages/src/tool-calling/fetching-tools.mdx b/fern/pages/src/tools-and-triggers/fetching-tools.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/fetching-tools.mdx
rename to fern/pages/src/tools-and-triggers/fetching-tools.mdx
diff --git a/fern/pages/src/tool-calling/schema-modifiers.mdx b/fern/pages/src/tools-and-triggers/schema-modifiers.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/schema-modifiers.mdx
rename to fern/pages/src/tools-and-triggers/schema-modifiers.mdx
diff --git a/fern/pages/src/tool-calling/toolkit-versioning.mdx b/fern/pages/src/tools-and-triggers/toolkit-versioning.mdx
similarity index 100%
rename from fern/pages/src/tool-calling/toolkit-versioning.mdx
rename to fern/pages/src/tools-and-triggers/toolkit-versioning.mdx
diff --git a/fern/pages/src/triggers/using-triggers.mdx b/fern/pages/src/tools-and-triggers/using-triggers.mdx
similarity index 98%
rename from fern/pages/src/triggers/using-triggers.mdx
rename to fern/pages/src/tools-and-triggers/using-triggers.mdx
index 2e227dca6..c59efdf7f 100644
--- a/fern/pages/src/triggers/using-triggers.mdx
+++ b/fern/pages/src/tools-and-triggers/using-triggers.mdx
@@ -47,8 +47,7 @@ Some triggers require additional configuration. The dashboard will prompt you fo
<img
src="../../../assets/images/trigger-config.png"
alt="Trigger configuration example"
- width="400px"
- height="auto"
+ style={{ maxHeight: '400px', width: 'auto', display: 'block', margin: '0 auto' }}
/>
</Frame>