From 18f22ee336a8525f986f0b8f2dd5b12200e91031 Mon Sep 17 00:00:00 2001 From: Rachel Lee Nabors Date: Fri, 23 Jan 2026 18:04:00 +0000 Subject: [PATCH 1/3] Reorganize docs with goal-based navigation for LLM-friendly routing This PR restructures the documentation to help users (especially AI coding agents) quickly identify which path to take when learning Arcade. Key changes: - Add "What do you want to do?" decision tree on homepage - Create goal-based top-level sections: Use Tools, Build Tools, Tool Catalog - Separate Auth Providers from References with clarifying callouts - Add new Help section with Troubleshooting guide - Add clarifying notes distinguishing OAuth config from tool integrations New sections: - /use-tools/ide - For IDE/MCP client users (recommends MCP Gateways) - /use-tools/agent - For app builders (includes auth patterns guide) - /build-tools - For custom tool creators - /auth-providers - Separated OAuth config with clear distinction from tools - /tool-catalog - Renamed integrations entry point - /security - Elevated security content - /help - Consolidated help resources with troubleshooting This addresses confusion between OAuth providers and tool integrations, and provides clear routing for different user goals. Co-Authored-By: Claude Opus 4.5 --- app/en/_meta.tsx | 36 ++++- app/en/auth-providers/_meta.tsx | 8 + app/en/auth-providers/page.mdx | 72 +++++++++ app/en/build-tools/_meta.tsx | 21 +++ .../build-tools/add-authentication/page.mdx | 28 ++++ app/en/build-tools/deploy/page.mdx | 29 ++++ app/en/build-tools/mcp-server-basics/page.mdx | 27 ++++ app/en/build-tools/page.mdx | 92 +++++++++++ app/en/build-tools/quickstart/page.mdx | 103 +++++++++++++ app/en/build-tools/test-evaluate/page.mdx | 28 ++++ app/en/help/_meta.tsx | 21 +++ app/en/help/contact-us/page.mdx | 16 ++ app/en/help/examples/page.mdx | 22 +++ app/en/help/faq/page.mdx | 16 ++ app/en/help/glossary/page.mdx | 16 ++ app/en/help/page.mdx | 27 ++++ app/en/help/troubleshooting/page.mdx | 144 ++++++++++++++++++ app/en/home/landing-page.tsx | 129 ++++++++++++++++ app/en/references/auth-providers/page.mdx | 7 + app/en/resources/integrations/page.mdx | 5 + app/en/security/_meta.tsx | 8 + app/en/security/page.mdx | 47 ++++++ app/en/tool-catalog/_meta.tsx | 8 + app/en/tool-catalog/page.mdx | 76 +++++++++ app/en/use-tools/_meta.tsx | 12 ++ app/en/use-tools/agent/_meta.tsx | 15 ++ app/en/use-tools/agent/auth-patterns/page.mdx | 121 +++++++++++++++ app/en/use-tools/agent/frameworks/page.mdx | 38 +++++ app/en/use-tools/agent/handle-auth/page.mdx | 86 +++++++++++ app/en/use-tools/agent/page.mdx | 75 +++++++++ app/en/use-tools/ide/_meta.tsx | 21 +++ app/en/use-tools/ide/claude-desktop/page.mdx | 20 +++ app/en/use-tools/ide/copilot-studio/page.mdx | 20 +++ app/en/use-tools/ide/cursor/page.mdx | 20 +++ app/en/use-tools/ide/mcp-gateways/page.mdx | 59 +++++++ app/en/use-tools/ide/page.mdx | 47 ++++++ .../use-tools/ide/visual-studio-code/page.mdx | 20 +++ app/en/use-tools/page.mdx | 42 +++++ 38 files changed, 1580 insertions(+), 2 deletions(-) create mode 100644 app/en/auth-providers/_meta.tsx create mode 100644 app/en/auth-providers/page.mdx create mode 100644 app/en/build-tools/_meta.tsx create mode 100644 app/en/build-tools/add-authentication/page.mdx create mode 100644 app/en/build-tools/deploy/page.mdx create mode 100644 app/en/build-tools/mcp-server-basics/page.mdx create mode 100644 app/en/build-tools/page.mdx create mode 100644 app/en/build-tools/quickstart/page.mdx create mode 100644 app/en/build-tools/test-evaluate/page.mdx create mode 100644 app/en/help/_meta.tsx create mode 100644 app/en/help/contact-us/page.mdx create mode 100644 app/en/help/examples/page.mdx create mode 100644 app/en/help/faq/page.mdx create mode 100644 app/en/help/glossary/page.mdx create mode 100644 app/en/help/page.mdx create mode 100644 app/en/help/troubleshooting/page.mdx create mode 100644 app/en/security/_meta.tsx create mode 100644 app/en/security/page.mdx create mode 100644 app/en/tool-catalog/_meta.tsx create mode 100644 app/en/tool-catalog/page.mdx create mode 100644 app/en/use-tools/_meta.tsx create mode 100644 app/en/use-tools/agent/_meta.tsx create mode 100644 app/en/use-tools/agent/auth-patterns/page.mdx create mode 100644 app/en/use-tools/agent/frameworks/page.mdx create mode 100644 app/en/use-tools/agent/handle-auth/page.mdx create mode 100644 app/en/use-tools/agent/page.mdx create mode 100644 app/en/use-tools/ide/_meta.tsx create mode 100644 app/en/use-tools/ide/claude-desktop/page.mdx create mode 100644 app/en/use-tools/ide/copilot-studio/page.mdx create mode 100644 app/en/use-tools/ide/cursor/page.mdx create mode 100644 app/en/use-tools/ide/mcp-gateways/page.mdx create mode 100644 app/en/use-tools/ide/page.mdx create mode 100644 app/en/use-tools/ide/visual-studio-code/page.mdx create mode 100644 app/en/use-tools/page.mdx diff --git a/app/en/_meta.tsx b/app/en/_meta.tsx index 5c171efd3..d45739595 100644 --- a/app/en/_meta.tsx +++ b/app/en/_meta.tsx @@ -2,9 +2,15 @@ import { Book, BookOpen, GraduationCap, + HelpCircle, Home, + KeyRound, + Monitor, Pencil, + Puzzle, Ruler, + Shield, + Wrench, } from "lucide-react"; import type { MetaRecord } from "nextra"; @@ -41,9 +47,23 @@ export const meta: MetaRecord = { "get-started": { title: Get Started, }, - resources: { - title: Resources, + // Goal-based navigation: USE TOOLS + "use-tools": { + title: Use Arcade Tools, + }, + // Goal-based navigation: BUILD TOOLS + "build-tools": { + title: Build Custom Tools, + }, + // Tool Catalog (formerly under Resources) + "tool-catalog": { + title: Tool Catalog, + }, + // Auth Providers (separated from References) + "auth-providers": { + title: Auth Providers, }, + // Keep existing sections guides: { title: Guides, }, @@ -53,6 +73,18 @@ export const meta: MetaRecord = { references: { title: References, }, + // Legacy Resources (integrations will redirect to tool-catalog) + resources: { + title: Resources, + }, + // Security (elevated from guides) + security: { + title: Security, + }, + // Help section + help: { + title: Help, + }, }; export default meta; diff --git a/app/en/auth-providers/_meta.tsx b/app/en/auth-providers/_meta.tsx new file mode 100644 index 000000000..4558eb4b4 --- /dev/null +++ b/app/en/auth-providers/_meta.tsx @@ -0,0 +1,8 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + // Individual providers are referenced via links to /references/auth-providers + // This is a top-level landing that clarifies the difference from integrations +}; + +export default meta; diff --git a/app/en/auth-providers/page.mdx b/app/en/auth-providers/page.mdx new file mode 100644 index 000000000..e444baa03 --- /dev/null +++ b/app/en/auth-providers/page.mdx @@ -0,0 +1,72 @@ +--- +title: "Auth Providers" +description: "Configure OAuth providers for Arcade authentication" +--- + +import { Callout } from "nextra/components"; + +# Auth Providers + + +**This section is for configuring OAuth connections, NOT for using pre-built tools.** + +- **Looking for ready-to-use tools?** → Go to [Tool Catalog](/tool-catalog) +- **Want to use Gmail, Slack, GitHub tools?** → Go to [Tool Catalog](/tool-catalog) +- **Need to configure custom OAuth?** → You're in the right place! + + +## What are Auth Providers? + +Auth Providers are OAuth configurations that enable Arcade to authenticate with external services. They define: + +- OAuth client credentials (client ID, secret) +- Authorization and token URLs +- Required scopes and permissions + +## When Do You Need This Section? + +You need to configure an auth provider when: + +1. **You're building custom tools** that require OAuth authentication +2. **You're self-hosting Arcade** and need to set up your own OAuth apps +3. **You need custom scopes** beyond what's available in pre-built tools +4. **The service you need** doesn't have a pre-built integration + + +**Most users don't need this section.** If you're using Arcade Cloud with pre-built integrations, OAuth is already configured for you. + + +## Supported Providers + +Arcade supports OAuth for 30+ services. See the full list in the [Auth Provider Reference](/references/auth-providers). + +### Popular Providers + +| Provider | Documentation | +|----------|---------------| +| Google | [Configure Google OAuth](/references/auth-providers/google) | +| Microsoft | [Configure Microsoft OAuth](/references/auth-providers/microsoft) | +| GitHub | [Configure GitHub OAuth](/references/auth-providers/github) | +| Slack | [Configure Slack OAuth](/references/auth-providers/slack) | +| Salesforce | [Configure Salesforce OAuth](/references/auth-providers/salesforce) | + +[See all 30+ providers →](/references/auth-providers) + +## Adding a Custom OAuth Provider + +If the service you need isn't in our list, you can add a custom OAuth 2.0 provider. + +[Add a custom OAuth provider →](/references/auth-providers/oauth2) + +## Common Confusion: Auth Providers vs Integrations + +| Auth Providers | Integrations (Tool Catalog) | +|----------------|---------------------------| +| OAuth configuration | Ready-to-use tools | +| For custom tools | For using existing tools | +| Technical setup | Just connect and use | +| "How to authenticate" | "What actions can I take" | + +**Example:** +- "I want to send emails via Gmail" → [Gmail Integration](/tool-catalog/productivity/gmail) (Tool Catalog) +- "I want to configure Google OAuth for my custom tool" → [Google Auth Provider](/references/auth-providers/google) (This section) diff --git a/app/en/build-tools/_meta.tsx b/app/en/build-tools/_meta.tsx new file mode 100644 index 000000000..f9bd4d3c5 --- /dev/null +++ b/app/en/build-tools/_meta.tsx @@ -0,0 +1,21 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + quickstart: { + title: "Quick Start: Your First Tool", + }, + "mcp-server-basics": { + title: "MCP Server Basics", + }, + "add-authentication": { + title: "Add Authentication", + }, + "test-evaluate": { + title: "Test & Evaluate", + }, + deploy: { + title: "Deploy Your Tools", + }, +}; + +export default meta; diff --git a/app/en/build-tools/add-authentication/page.mdx b/app/en/build-tools/add-authentication/page.mdx new file mode 100644 index 000000000..c3850144b --- /dev/null +++ b/app/en/build-tools/add-authentication/page.mdx @@ -0,0 +1,28 @@ +--- +title: "Add Authentication to Tools" +description: "Make your custom tools work with user credentials and OAuth" +--- + +import { Callout } from "nextra/components"; + +# Add Authentication to Tools + + +**Coming soon.** This page will cover adding authentication to your custom tools. + + +## What You'll Learn + +- Server-level vs Tool-level authentication +- Using existing OAuth providers (Google, GitHub, Slack, etc.) +- Adding custom OAuth providers +- Working with API keys and secrets + +## In the Meantime + +Check out these existing guides: + +- [Create a Tool with Auth](/guides/create-tools/tool-basics/create-tool-auth) +- [Create a Tool with Secrets](/guides/create-tools/tool-basics/create-tool-secrets) +- [Server vs Tool Level Auth](/learn/server-level-vs-tool-level-auth) +- [Auth Providers Reference](/references/auth-providers) diff --git a/app/en/build-tools/deploy/page.mdx b/app/en/build-tools/deploy/page.mdx new file mode 100644 index 000000000..ee8fd6208 --- /dev/null +++ b/app/en/build-tools/deploy/page.mdx @@ -0,0 +1,29 @@ +--- +title: "Deploy Your Tools" +description: "Get your custom tools running in production" +--- + +import { Callout } from "nextra/components"; + +# Deploy Your Tools + + +**Coming soon.** This page will cover deployment options for your tools. + + +## Deployment Options + +| Option | Best For | Complexity | +|--------|----------|------------| +| Arcade Cloud | Most users | Low | +| Arcade Deploy | Custom domains | Medium | +| Self-hosted | Enterprise/On-prem | High | + +## In the Meantime + +Check out these existing guides: + +- [Deployment Overview](/guides/deployment-hosting) +- [Arcade Cloud](/guides/deployment-hosting/arcade-cloud) +- [Configure Engine](/guides/deployment-hosting/configure-engine) +- [On-premise Deployment](/guides/deployment-hosting/on-prem) diff --git a/app/en/build-tools/mcp-server-basics/page.mdx b/app/en/build-tools/mcp-server-basics/page.mdx new file mode 100644 index 000000000..72f7655d4 --- /dev/null +++ b/app/en/build-tools/mcp-server-basics/page.mdx @@ -0,0 +1,27 @@ +--- +title: "MCP Server Basics" +description: "Learn how MCP servers work and how to structure your tools" +--- + +import { Callout } from "nextra/components"; + +# MCP Server Basics + + +**Coming soon.** This page will cover the fundamentals of MCP servers. + + +## What You'll Learn + +- What is an MCP server and how does it work? +- How Arcade extends MCP with authentication and hosting +- Local vs Cloud vs Self-hosted deployment options +- Best practices for structuring your tools + +## In the Meantime + +Check out these existing guides: + +- [Build an MCP Server](/guides/create-tools/tool-basics/build-mcp-server) +- [Compare MCP Server Types](/guides/create-tools/tool-basics/compare-server-types) +- [Organize Your Tools](/guides/create-tools/tool-basics/organize-mcp-tools) diff --git a/app/en/build-tools/page.mdx b/app/en/build-tools/page.mdx new file mode 100644 index 000000000..36fcc56b3 --- /dev/null +++ b/app/en/build-tools/page.mdx @@ -0,0 +1,92 @@ +--- +title: "Build Custom Tools" +description: "Create your own MCP servers and custom tools with Arcade" +--- + +import { Callout } from "nextra/components"; + +# Build Custom Tools + +Need tools that don't exist in the catalog? Build your own MCP servers with custom logic and authentication. + + +**Looking for pre-built tools?** Check the [Tool Catalog](/tool-catalog) first - we have 100+ integrations ready to use. + + +## When to Build Custom Tools + +- You need to integrate with an internal API +- You want custom business logic in your tools +- The service you need isn't in the tool catalog yet +- You want to combine multiple operations into a single tool + +## Getting Started + +### 1. Quick Start (5 minutes) + +Build your first tool to understand the basics. + +[Start the quick tutorial →](/build-tools/quickstart) + +### 2. MCP Server Basics + +Learn how MCP servers work and how to structure your tools. + +- [What is an MCP Server?](/guides/create-tools/tool-basics/compare-mcp-server-types) +- [Build an MCP Server](/guides/create-tools/tool-basics/build-mcp-server) +- [Organize your tools](/guides/create-tools/tool-basics/organize-tools) + +### 3. Add Authentication + +Make your tools work with user credentials. + +- [Create a tool with auth](/guides/create-tools/tool-basics/create-tool-with-auth) +- [Create a tool with secrets](/guides/create-tools/tool-basics/create-tool-with-secrets) +- [Server-level vs Tool-level auth](/learn/server-level-vs-tool-level-auth) + +### 4. Test & Evaluate + +Ensure your tools work correctly before deploying. + +- [Why evaluate tools?](/guides/create-tools/evaluate-tools/why-evaluate) +- [Create an evaluation suite](/guides/create-tools/evaluate-tools/create-evaluation-suite) +- [Run evaluations](/guides/create-tools/evaluate-tools/run-evaluations) + +### 5. Deploy + +Get your tools running in production. + +- [Deploy to Arcade Cloud](/guides/deployment-hosting/arcade-cloud) (easiest) +- [Self-host with Arcade Engine](/guides/deployment-hosting/configure-engine) +- [On-premise options](/guides/deployment-hosting/on-prem) + +## Example: Simple Custom Tool + +```python +from arcade.sdk import tool + +@tool +def calculate_shipping( + weight_kg: float, + destination_country: str +) -> dict: + """Calculate shipping cost based on weight and destination.""" + + # Your custom business logic here + base_rate = 5.00 + per_kg_rate = 2.50 + international_surcharge = 10.00 if destination_country != "US" else 0 + + total = base_rate + (weight_kg * per_kg_rate) + international_surcharge + + return { + "cost_usd": total, + "estimated_days": 5 if destination_country == "US" else 14 + } +``` + +## Next Steps + +1. [Start the quick tutorial](/build-tools/quickstart) +2. [Explore the MCP reference docs](/references/mcp) +3. [See example tools](https://github.com/ArcadeAI/arcade-ai/tree/main/examples) diff --git a/app/en/build-tools/quickstart/page.mdx b/app/en/build-tools/quickstart/page.mdx new file mode 100644 index 000000000..5e51fa217 --- /dev/null +++ b/app/en/build-tools/quickstart/page.mdx @@ -0,0 +1,103 @@ +--- +title: "Quick Start: Your First Custom Tool" +description: "Build your first custom tool in 5 minutes" +--- + +import { Steps, Callout } from "nextra/components"; + +# Quick Start: Your First Custom Tool + +Build a simple custom tool in under 5 minutes. This tutorial will help you understand the basics of creating MCP servers with Arcade. + +## Prerequisites + +- Python 3.10+ +- An [Arcade API key](/get-started/setup/api-keys) + + + +### Install the Arcade SDK + +```bash +pip install arcade-ai +``` + +### Create your tool file + +Create a new file called `my_tools.py`: + +```python +from arcade.sdk import tool + +@tool +def greet_user(name: str) -> str: + """ + Greet a user by name. + + Args: + name: The name of the person to greet + + Returns: + A friendly greeting message + """ + return f"Hello, {name}! Welcome to Arcade." + + +@tool +def add_numbers(a: float, b: float) -> float: + """ + Add two numbers together. + + Args: + a: The first number + b: The second number + + Returns: + The sum of a and b + """ + return a + b +``` + +### Test your tools locally + +```bash +arcade dev my_tools.py +``` + +This starts a local MCP server. You can test it with: + +```bash +arcade chat +``` + +Try asking: "Greet someone named Alice" or "Add 5 and 3" + +### Connect to your IDE (optional) + +Add your local server to your MCP client configuration: + +```json +{ + "mcpServers": { + "my-tools": { + "command": "arcade", + "args": ["dev", "my_tools.py"] + } + } +} +``` + + + +## What's Next? + +You've built your first custom tool! Here's where to go next: + +- [Add authentication](/guides/create-tools/tool-basics/create-tool-with-auth) to call external APIs +- [Add secrets](/guides/create-tools/tool-basics/create-tool-with-secrets) for API keys +- [Structure your MCP server](/guides/create-tools/tool-basics/organize-tools) as it grows +- [Deploy to production](/build-tools/deploy) + + +**See the full tutorial:** [Build an MCP Server](/guides/create-tools/tool-basics/build-mcp-server) for a more comprehensive guide. + diff --git a/app/en/build-tools/test-evaluate/page.mdx b/app/en/build-tools/test-evaluate/page.mdx new file mode 100644 index 000000000..c3c64d8f9 --- /dev/null +++ b/app/en/build-tools/test-evaluate/page.mdx @@ -0,0 +1,28 @@ +--- +title: "Test & Evaluate Tools" +description: "Ensure your tools work correctly before deploying" +--- + +import { Callout } from "nextra/components"; + +# Test & Evaluate Tools + + +**Coming soon.** This page will cover testing and evaluation strategies. + + +## What You'll Learn + +- Why tool evaluation matters for AI agents +- Creating comprehensive test suites +- Running evaluations locally and in CI +- Comparing tool versions + +## In the Meantime + +Check out these existing guides: + +- [Why Evaluate Tools?](/guides/create-tools/evaluate-tools/why-evaluate) +- [Create an Evaluation Suite](/guides/create-tools/evaluate-tools/create-evaluation-suite) +- [Run Evaluations](/guides/create-tools/evaluate-tools/run-evaluations) +- [Comparative Evaluations](/guides/create-tools/evaluate-tools/comparative-evaluations) diff --git a/app/en/help/_meta.tsx b/app/en/help/_meta.tsx new file mode 100644 index 000000000..174fc68bc --- /dev/null +++ b/app/en/help/_meta.tsx @@ -0,0 +1,21 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + troubleshooting: { + title: "Troubleshooting", + }, + faq: { + title: "FAQ", + }, + glossary: { + title: "Glossary", + }, + examples: { + title: "Examples", + }, + "contact-us": { + title: "Contact Us", + }, +}; + +export default meta; diff --git a/app/en/help/contact-us/page.mdx b/app/en/help/contact-us/page.mdx new file mode 100644 index 000000000..52e8939df --- /dev/null +++ b/app/en/help/contact-us/page.mdx @@ -0,0 +1,16 @@ +--- +title: "Contact Us" +description: "Get help and support for Arcade" +--- + +import { Callout } from "nextra/components"; + +# Contact Us + + +**Coming soon.** This page will have contact information. + + +## In the Meantime + +See the existing contact page: [Resources Contact](/resources/contact-us) diff --git a/app/en/help/examples/page.mdx b/app/en/help/examples/page.mdx new file mode 100644 index 000000000..2b268321e --- /dev/null +++ b/app/en/help/examples/page.mdx @@ -0,0 +1,22 @@ +--- +title: "Examples" +description: "Code examples and sample applications" +--- + +import { Callout } from "nextra/components"; + +# Examples + + +**Coming soon.** This page will showcase code examples. + + +## In the Meantime + +See the existing examples: [Resources Examples](/resources/examples) + +## Sample Applications + +- [Arcade Chat](https://chat.arcade.dev/) - A chatbot for daily tasks +- [Archer](https://github.com/ArcadeAI/ArcadeSlackAgent) - Slack bot that acts on your behalf +- [YouTube Summarizer](https://github.com/dforwardfeed/slack-AIpodcast-summaries) - Extracts and summarizes YouTube transcripts diff --git a/app/en/help/faq/page.mdx b/app/en/help/faq/page.mdx new file mode 100644 index 000000000..41e07e7a2 --- /dev/null +++ b/app/en/help/faq/page.mdx @@ -0,0 +1,16 @@ +--- +title: "FAQ" +description: "Frequently asked questions about Arcade" +--- + +import { Callout } from "nextra/components"; + +# Frequently Asked Questions + + +**Coming soon.** This page will consolidate common questions. + + +## In the Meantime + +See the existing FAQ: [Resources FAQ](/resources/faq) diff --git a/app/en/help/glossary/page.mdx b/app/en/help/glossary/page.mdx new file mode 100644 index 000000000..1fd82d794 --- /dev/null +++ b/app/en/help/glossary/page.mdx @@ -0,0 +1,16 @@ +--- +title: "Glossary" +description: "Definitions of terms used in Arcade documentation" +--- + +import { Callout } from "nextra/components"; + +# Glossary + + +**Coming soon.** This page will define key terms. + + +## In the Meantime + +See the existing glossary: [Resources Glossary](/resources/glossary) diff --git a/app/en/help/page.mdx b/app/en/help/page.mdx new file mode 100644 index 000000000..57aa141a6 --- /dev/null +++ b/app/en/help/page.mdx @@ -0,0 +1,27 @@ +--- +title: "Help" +description: "Get help with Arcade" +--- + +# Help + +Find answers, troubleshoot issues, and get support. + +## Quick Links + +- [Troubleshooting](/help/troubleshooting) - Common issues and fixes +- [FAQ](/help/faq) - Frequently asked questions +- [Glossary](/help/glossary) - Term definitions +- [Examples](/help/examples) - Code samples and demos +- [Contact Us](/help/contact-us) - Get in touch + +## Common Issues + +### Authentication Problems +Having trouble with OAuth or user authorization? See [Troubleshooting](/help/troubleshooting#authentication-issues). + +### Tool Call Errors +Tools not working as expected? See [Troubleshooting](/help/troubleshooting#tool-calling-issues). + +### MCP Client Setup +Issues connecting your IDE? See [Troubleshooting](/help/troubleshooting#mcp-client-issues). diff --git a/app/en/help/troubleshooting/page.mdx b/app/en/help/troubleshooting/page.mdx new file mode 100644 index 000000000..cf9652ea1 --- /dev/null +++ b/app/en/help/troubleshooting/page.mdx @@ -0,0 +1,144 @@ +--- +title: "Troubleshooting" +description: "Common issues and how to fix them" +--- + +import { Callout } from "nextra/components"; + +# Troubleshooting + +Quick solutions to common Arcade issues. + +## Authentication Issues + +### "User not authorized" error + +**Problem:** Tool call fails with authorization error. + +**Solution:** +1. Check if the user has completed OAuth for the service +2. Verify you're passing the correct `user_id` +3. Check auth status before calling tools: + +```python +status = client.auth.status(tool_name="Google.SendEmail", user_id="user_123") +if status.status == "not_authorized": + # Redirect to status.authorization_url +``` + +[Learn about auth patterns →](/use-tools/agent/auth-patterns) + +### OAuth popup doesn't appear + +**Problem:** User clicks authorize but nothing happens. + +**Solutions:** +- Check browser popup blocker settings +- Ensure the authorization URL is opened in a new window/tab +- Verify your OAuth redirect URI is correctly configured + +### Token expired errors + +**Problem:** Previously working tools now fail with token errors. + +**Solution:** Arcade handles token refresh automatically. If you're seeing this: +1. The refresh token may have been revoked by the user +2. Have the user re-authorize the service + +--- + +## Tool Calling Issues + +### "Tool not found" error + +**Problem:** Tool execution fails because the tool doesn't exist. + +**Solutions:** +1. Check the tool name is spelled correctly (case-sensitive) +2. Verify the tool is available in your plan +3. List available tools: `arcade tools list` + +### Tool returns unexpected results + +**Problem:** Tool works but returns wrong or incomplete data. + +**Solutions:** +1. Check the input parameters match the tool's expected schema +2. Verify the user has the required permissions in the target service +3. Check the [tool documentation](/tool-catalog) for specific requirements + +### Tool call timeout + +**Problem:** Tool execution takes too long and times out. + +**Solutions:** +1. Some operations (like large file uploads) may take longer +2. Increase timeout in your client configuration +3. For batch operations, consider breaking into smaller chunks + +--- + +## MCP Client Issues + +### Claude Desktop not connecting + +**Problem:** Claude Desktop can't connect to Arcade. + +**Solutions:** +1. Verify your configuration in `claude_desktop_config.json` +2. Restart Claude Desktop after config changes +3. Check that your API key is valid + +[Claude Desktop setup guide →](/use-tools/ide/claude-desktop) + +### Cursor not showing tools + +**Problem:** Tools don't appear in Cursor's tool list. + +**Solutions:** +1. Check MCP server configuration in Cursor settings +2. Verify the MCP gateway URL is correct +3. Restart Cursor after configuration changes + +[Cursor setup guide →](/use-tools/ide/cursor) + +### VS Code extension issues + +**Problem:** VS Code can't connect to Arcade MCP server. + +**Solutions:** +1. Check the extension is properly installed and enabled +2. Verify MCP configuration in settings +3. Check the extension output panel for error messages + +[VS Code setup guide →](/use-tools/ide/visual-studio-code) + +--- + +## MCP Server Issues (Custom Tools) + +### Server won't start + +**Problem:** `arcade dev` fails to start your server. + +**Solutions:** +1. Check Python version (requires 3.10+) +2. Verify all dependencies are installed +3. Check for syntax errors in your tool code + +### Tools not appearing in the server + +**Problem:** Server starts but your tools aren't registered. + +**Solutions:** +1. Ensure tools use the `@tool` decorator +2. Check that tool functions are imported correctly +3. Verify tool docstrings are properly formatted + +--- + +## Still Need Help? + +- Check the [FAQ](/help/faq) for more answers +- Browse the [Glossary](/help/glossary) for term definitions +- [Contact support](/help/contact-us) for additional assistance diff --git a/app/en/home/landing-page.tsx b/app/en/home/landing-page.tsx index a6cca53bb..91ffbf84f 100644 --- a/app/en/home/landing-page.tsx +++ b/app/en/home/landing-page.tsx @@ -7,6 +7,7 @@ import { Cog, FileText, HelpCircle, + KeyRound, Monitor, Puzzle, Rocket, @@ -284,6 +285,134 @@ export function LandingPage() { + {/* LLM-Friendly Decision Tree - What do you want to do? */} +
+
+
+

+ What do you want to do? +

+ {/* Decision tree - structured for both humans and LLMs */} +
+ {/* Path 1: Use tools in IDE */} + +
+
+ +
+
+

+ “I want AI tools in my IDE” +

+

+ Add tools to Cursor, VS Code, Claude Desktop via MCP + Gateways +

+ + Fastest setup (2 min) + + +
+
+ + + {/* Path 2: Build an app/agent */} + +
+
+ +
+
+

+ “I'm building an app with AI tools” +

+

+ Integrate with LangChain, OpenAI Agents, CrewAI, and more +

+ + Choose your framework + + +
+
+ + + {/* Path 3: Create custom tools */} + +
+
+ +
+
+

+ “I need to create custom tools” +

+

+ Build MCP servers with your own tool logic and + authentication +

+ + Start building + + +
+
+ + + {/* Path 4: Configure OAuth */} + +
+
+ +
+
+

+ “I want to configure OAuth for a service” +

+

+ Set up authentication providers (different from using + tools) +

+ + Configure auth + + +
+
+ +
+ {/* Clarification for LLMs */} +

+ Note: “Integrations” are ready-to-use + tools. “Auth Providers” are OAuth configurations. + These are different things. +

+
+
+
+ {/* Choose Your Path Section */}
diff --git a/app/en/references/auth-providers/page.mdx b/app/en/references/auth-providers/page.mdx index bc3c0151e..436f05747 100644 --- a/app/en/references/auth-providers/page.mdx +++ b/app/en/references/auth-providers/page.mdx @@ -5,8 +5,15 @@ description: Registry of all auth providers available in the Arcade ecosystem # Auth Providers +import { Callout } from "nextra/components"; import { ToolCard } from "@/app/_components/tool-card"; + +**This section is for configuring OAuth**, not for using pre-built tools. +- **Want to use Gmail, Slack, or GitHub tools?** → Go to [Tool Catalog](/tool-catalog) +- **Need to configure your own OAuth app?** → You're in the right place + + Auth providers enable users to seamlessly and securely allow Arcade tools to access their data. Arcade has several auth providers available in the Arcade Cloud Platform so you don't have to configure your own. However, using Arcade's auth providers means that your users will see the Arcade brand (name and logo) on the auth screen and your authentications will share any rate limits from those providers with other Arcade customers. diff --git a/app/en/resources/integrations/page.mdx b/app/en/resources/integrations/page.mdx index 79b047a74..ddb266216 100644 --- a/app/en/resources/integrations/page.mdx +++ b/app/en/resources/integrations/page.mdx @@ -3,6 +3,11 @@ title: MCP Servers description: Registry of all MCP Servers available in the Arcade ecosystem --- +import { Callout } from "nextra/components"; import Toolkits from "./components/toolkits"; + +**These are ready-to-use tools** that you can add to your agents. Looking to configure OAuth for custom tools? See [Auth Providers](/auth-providers) instead. + + diff --git a/app/en/security/_meta.tsx b/app/en/security/_meta.tsx new file mode 100644 index 000000000..02468d865 --- /dev/null +++ b/app/en/security/_meta.tsx @@ -0,0 +1,8 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + // Security guides are linked from the landing page + // This section provides a unified entry point for security topics +}; + +export default meta; diff --git a/app/en/security/page.mdx b/app/en/security/page.mdx new file mode 100644 index 000000000..0097c975d --- /dev/null +++ b/app/en/security/page.mdx @@ -0,0 +1,47 @@ +--- +title: "Security & Compliance" +description: "Security best practices for Arcade applications" +--- + +import { Callout } from "nextra/components"; + +# Security & Compliance + +Best practices for building secure applications with Arcade. + +## Key Security Topics + +### Secure Your MCP Server + +Best practices for securing custom MCP servers in production. + +[Secure your MCP server →](/guides/security/secure-mcp-server) + +### Secure Authentication in Production + +How to handle OAuth flows and token management securely in user-facing applications. + +[Production auth guide →](/guides/user-facing-agents/secure-auth-in-production) + +### Security Research Program + +Report security vulnerabilities and learn about our security practices. + +[Security research program →](/guides/security/security-research-program) + +## Quick Security Checklist + + +**Before deploying to production, ensure:** + + +- [ ] API keys are stored in environment variables, not code +- [ ] OAuth redirect URIs are restricted to your domains +- [ ] User tokens are properly scoped (minimal permissions) +- [ ] Error messages don't leak sensitive information +- [ ] Audit logs are enabled for sensitive operations + +## Additional Resources + +- [Securing Arcade MCP](/guides/security/securing-arcade-mcp) +- [Deployment security](/guides/deployment-hosting) diff --git a/app/en/tool-catalog/_meta.tsx b/app/en/tool-catalog/_meta.tsx new file mode 100644 index 000000000..29fbb6cb7 --- /dev/null +++ b/app/en/tool-catalog/_meta.tsx @@ -0,0 +1,8 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + // Categories link to /resources/integrations/* for now + // This is a landing page that clarifies these are ready-to-use tools +}; + +export default meta; diff --git a/app/en/tool-catalog/page.mdx b/app/en/tool-catalog/page.mdx new file mode 100644 index 000000000..5e11b0a1f --- /dev/null +++ b/app/en/tool-catalog/page.mdx @@ -0,0 +1,76 @@ +--- +title: "Tool Catalog" +description: "Browse 100+ ready-to-use AI tool integrations" +--- + +import { Callout } from "nextra/components"; + +# Tool Catalog + + +**These are ready-to-use tools**, not OAuth configurations. If you need to configure custom OAuth, see [Auth Providers](/auth-providers). + + +Browse 100+ pre-built integrations for your AI agents. Each integration includes tools that let your agents take real actions - send emails, create tasks, manage files, and more. + +## Browse by Category + +### Productivity & Docs +Gmail, Google Docs, Sheets, Drive, Notion, Jira, Linear, Asana, Confluence, and more. + +[Browse Productivity Tools →](/resources/integrations/productivity) + +### Developer Tools +GitHub, GitLab, Vercel, Datadog, Firecrawl, E2B, and more. + +[Browse Developer Tools →](/resources/integrations/development) + +### Search +Google Search, Google Maps, YouTube, Exa, and more. + +[Browse Search Tools →](/resources/integrations/search) + +### Sales & CRM +HubSpot, Salesforce, and more. + +[Browse Sales Tools →](/resources/integrations/sales) + +### Social & Communication +Slack, Discord, Microsoft Teams, X (Twitter), LinkedIn, and more. + +[Browse Social Tools →](/resources/integrations/social-communication) + +### Customer Support +Zendesk, Intercom, PagerDuty, Freshservice, and more. + +[Browse Support Tools →](/resources/integrations/customer-support) + +### Databases +PostgreSQL, MongoDB, ClickHouse, Weaviate, and more. + +[Browse Database Tools →](/resources/integrations/databases) + +### Payments & Finance +Stripe, and more. + +[Browse Payment Tools →](/resources/integrations/payments) + +## Can't Find What You Need? + +If the integration you need isn't here, you have two options: + +1. **Build a custom tool** - Create your own MCP server with custom logic. + [Learn how →](/build-tools) + +2. **Request an integration** - Let us know what you need. + [Contact us →](/resources/contact-us) + +## How to Use These Tools + +### In Your IDE +Connect tools to Cursor, VS Code, or Claude Desktop. +[Get started →](/use-tools/ide) + +### In Your App +Integrate with LangChain, OpenAI Agents, or other frameworks. +[Get started →](/use-tools/agent) diff --git a/app/en/use-tools/_meta.tsx b/app/en/use-tools/_meta.tsx new file mode 100644 index 000000000..7eccdc9e0 --- /dev/null +++ b/app/en/use-tools/_meta.tsx @@ -0,0 +1,12 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + ide: { + title: "In Your IDE", + }, + agent: { + title: "In Your Agent / App", + }, +}; + +export default meta; diff --git a/app/en/use-tools/agent/_meta.tsx b/app/en/use-tools/agent/_meta.tsx new file mode 100644 index 000000000..d72d74f02 --- /dev/null +++ b/app/en/use-tools/agent/_meta.tsx @@ -0,0 +1,15 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + frameworks: { + title: "Choose Your Framework", + }, + "auth-patterns": { + title: "User Authentication Patterns", + }, + "handle-auth": { + title: "Handle Auth Status & Errors", + }, +}; + +export default meta; diff --git a/app/en/use-tools/agent/auth-patterns/page.mdx b/app/en/use-tools/agent/auth-patterns/page.mdx new file mode 100644 index 000000000..0e0637ae0 --- /dev/null +++ b/app/en/use-tools/agent/auth-patterns/page.mdx @@ -0,0 +1,121 @@ +--- +title: "User Authentication Patterns" +description: "How to handle user authentication when building apps with Arcade" +--- + +import { Callout } from "nextra/components"; + +# User Authentication Patterns + +When building user-facing applications with Arcade, you need to decide how users will authenticate with the services your agent accesses. This page covers the three main patterns. + + +**This is critical for production apps.** Understanding these patterns will save you significant debugging time. + + +## Pattern 1: Pre-authorized (Your Credentials) + +Use your own API keys or OAuth tokens. The agent acts as you, not as the end user. + +**When to use:** +- Internal tools and automations +- Single-user applications +- Testing and development + +**Example:** A Slack bot that posts to your company's #announcements channel using your Slack credentials. + +```python +# You've already authorized during setup +# All requests use your stored credentials +response = client.tools.execute( + tool_name="Slack.SendMessage", + inputs={"channel": "#announcements", "message": "Hello!"} +) +``` + +## Pattern 2: User-facing (OAuth Popup) + +Each user authorizes their own accounts. The agent acts on behalf of each individual user. + +**When to use:** +- Multi-user SaaS applications +- Apps where users manage their own data +- Production applications + +**Example:** A productivity app where each user connects their own Gmail to summarize their emails. + +```python +# Check if user has authorized +auth_status = client.auth.status( + tool_name="Google.ListEmails", + user_id="user_123" +) + +if auth_status.status == "not_authorized": + # Redirect user to authorization URL + return redirect(auth_status.authorization_url) + +# User is authorized, execute the tool +response = client.tools.execute( + tool_name="Google.ListEmails", + user_id="user_123" +) +``` + +[See detailed OAuth flow guide →](/guides/tool-calling/custom-apps/auth-tool-calling) + +## Pattern 3: Headless / CLI (Device Flow) + +For command-line tools and environments without a browser. + +**When to use:** +- CLI applications +- Server-side batch jobs +- Environments without a UI + +**Example:** A CLI tool that posts to Twitter on your behalf. + +```python +# Start device authorization flow +auth = client.auth.start_device_flow( + tool_name="Twitter.PostTweet", + user_id="user_123" +) + +print(f"Go to {auth.verification_url} and enter code: {auth.user_code}") + +# Poll for completion +client.auth.wait_for_completion(auth.device_code) +``` + +## Comparison Table + +| Pattern | Multi-user | Requires UI | Complexity | +|---------|------------|-------------|------------| +| Pre-authorized | No | No | Low | +| User-facing OAuth | Yes | Yes | Medium | +| Headless/Device | Yes | No | Medium | + +## Working Examples + +See these patterns in action: + +- [LangChain with user auth](/get-started/agent-frameworks/langchain/auth-langchain-tools) +- [OpenAI Agents with auth interrupts](/get-started/agent-frameworks/openai-agents/user-auth-interrupts) +- [CrewAI custom auth flow](/get-started/agent-frameworks/crewai/custom-auth-flow) + +## Common Issues + +### "User not authorized" errors + +The user hasn't completed OAuth for the requested service. Check auth status before calling tools. + +### Token expiration + +OAuth tokens expire. Arcade handles refresh automatically, but you may see brief delays during token refresh. + +### Wrong user context + +Make sure you're passing the correct `user_id` to associate tool calls with the right user's credentials. + +[See troubleshooting guide →](/help/troubleshooting) diff --git a/app/en/use-tools/agent/frameworks/page.mdx b/app/en/use-tools/agent/frameworks/page.mdx new file mode 100644 index 000000000..fc8ea0b9a --- /dev/null +++ b/app/en/use-tools/agent/frameworks/page.mdx @@ -0,0 +1,38 @@ +--- +title: "Choose Your Framework" +description: "Integrate Arcade with your preferred agent framework" +--- + +import { Callout } from "nextra/components"; + +# Choose Your Framework + +Select your agent framework to get started with Arcade tools. + +## Supported Frameworks + +| Framework | Language | Best For | Guide | +|-----------|----------|----------|-------| +| **Python (Direct)** | Python | Full control, any LLM | [Setup Guide](/get-started/agent-frameworks/setup-arcade-with-your-llm-python) | +| **LangChain** | Python | Complex chains, retrieval | [Setup Guide](/get-started/agent-frameworks/langchain/use-arcade-with-langchain) | +| **OpenAI Agents SDK** | Python | OpenAI-native apps | [Setup Guide](/get-started/agent-frameworks/openai-agents/use-arcade-tools) | +| **CrewAI** | Python | Multi-agent collaboration | [Setup Guide](/get-started/agent-frameworks/crewai/use-arcade-tools) | +| **Google ADK** | Python | Google Cloud integration | [Setup Guide](/get-started/agent-frameworks/google-adk/use-arcade-tools) | +| **Vercel AI SDK** | TypeScript | Next.js, React apps | [Setup Guide](/get-started/agent-frameworks/vercelai) | +| **Mastra** | TypeScript | TypeScript-first agents | [Setup Guide](/get-started/agent-frameworks/mastra) | + +## Quick Comparison + + +**Not sure which to choose?** +- Building a simple Python app? → Start with **Python (Direct)** +- Building a web app with Next.js? → Use **Vercel AI SDK** +- Need complex agent workflows? → Consider **LangChain** or **CrewAI** + + +## Next Steps + +After setting up your framework: +1. [Understand auth patterns](/use-tools/agent/auth-patterns) for user-facing apps +2. [Handle auth errors](/use-tools/agent/handle-auth) gracefully +3. [Browse available tools](/tool-catalog) to see what you can build diff --git a/app/en/use-tools/agent/handle-auth/page.mdx b/app/en/use-tools/agent/handle-auth/page.mdx new file mode 100644 index 000000000..7f77877ff --- /dev/null +++ b/app/en/use-tools/agent/handle-auth/page.mdx @@ -0,0 +1,86 @@ +--- +title: "Handle Auth Status & Errors" +description: "Gracefully handle authentication in your agent applications" +--- + +import { Callout } from "nextra/components"; + +# Handle Auth Status & Errors + +When building user-facing applications, you need to check authentication status and handle errors gracefully. + +## Check Auth Status Before Calling Tools + +Always check if the user has authorized the required service before making tool calls: + +```python +from arcadepy import Arcade + +client = Arcade() + +# Check auth status first +status = client.auth.status( + tool_name="Google.SendEmail", + user_id="user_123" +) + +if status.status == "authorized": + # Safe to call the tool + result = client.tools.execute( + tool_name="Google.SendEmail", + user_id="user_123", + inputs={...} + ) +elif status.status == "not_authorized": + # Redirect user to authorize + print(f"Please authorize: {status.authorization_url}") +``` + +## Common Auth Errors + +### `AuthorizationRequired` + +**Cause:** User hasn't completed OAuth for this service. + +**Solution:** Check auth status and redirect to authorization URL. + +### `TokenExpired` + +**Cause:** The OAuth token has expired and couldn't be refreshed. + +**Solution:** Arcade handles refresh automatically. If this persists, have the user re-authorize. + +### `InsufficientScopes` + +**Cause:** The user authorized but with fewer permissions than the tool needs. + +**Solution:** Request re-authorization with the required scopes. + +## Error Handling Pattern + +```python +from arcadepy import Arcade +from arcadepy.exceptions import AuthorizationRequired, ToolExecutionError + +client = Arcade() + +try: + result = client.tools.execute( + tool_name="Google.SendEmail", + user_id="user_123", + inputs={...} + ) +except AuthorizationRequired as e: + # Handle missing authorization + return redirect(e.authorization_url) +except ToolExecutionError as e: + # Handle tool-specific errors + log.error(f"Tool failed: {e.message}") + return error_response(e.message) +``` + +## See Also + +- [User Authentication Patterns](/use-tools/agent/auth-patterns) +- [Troubleshooting](/help/troubleshooting) +- [Auth Tool Calling Guide](/guides/tool-calling/custom-apps/auth-tool-calling) diff --git a/app/en/use-tools/agent/page.mdx b/app/en/use-tools/agent/page.mdx new file mode 100644 index 000000000..17e0c1420 --- /dev/null +++ b/app/en/use-tools/agent/page.mdx @@ -0,0 +1,75 @@ +--- +title: "Use Arcade Tools in Your Agent or App" +description: "Integrate Arcade tools with LangChain, OpenAI Agents, CrewAI, and other frameworks" +--- + +import { Callout } from "nextra/components"; + +# Use Arcade Tools in Your Agent or App + +Build applications that can take real action using Arcade's 100+ pre-built integrations. Integrate with your favorite agent framework and let your AI send emails, manage tasks, and interact with APIs on behalf of users. + +## Choose Your Framework + +Select your agent framework to get started: + +| Framework | Best For | +|-----------|----------| +| [Python (Direct)](/get-started/agent-frameworks/setup-arcade-with-your-llm-python) | Full control, any LLM provider | +| [LangChain](/get-started/agent-frameworks/langchain/use-arcade-with-langchain) | Complex chains and retrieval | +| [OpenAI Agents SDK](/get-started/agent-frameworks/openai-agents/use-arcade-tools) | OpenAI-native applications | +| [CrewAI](/get-started/agent-frameworks/crewai/use-arcade-tools) | Multi-agent collaboration | +| [Google ADK](/get-started/agent-frameworks/google-adk/use-arcade-tools) | Google Cloud integration | +| [Vercel AI SDK](/get-started/agent-frameworks/vercelai) | Next.js and React apps | +| [Mastra](/get-started/agent-frameworks/mastra) | TypeScript-first agents | + +[See all framework guides →](/get-started/agent-frameworks) + +## Key Concepts + +### User Authentication + +When building user-facing applications, you'll need to handle authentication so your agent can act on behalf of users. + + +**Important:** Understanding authentication patterns is critical for production apps. Users need to authorize your app to access their Gmail, Slack, etc. + + +[Learn about authentication patterns →](/use-tools/agent/auth-patterns) + +### Available Tools + +Browse the tool catalog to see what integrations are available: + +- **Productivity:** Gmail, Slack, Notion, Jira, Linear +- **Development:** GitHub, GitLab, Vercel, Datadog +- **Documents:** Google Docs, Sheets, Drive, Dropbox +- **And 90+ more...** + +[Browse tool catalog →](/tool-catalog) + +## Quick Example (Python) + +```python +from arcadepy import Arcade + +# Initialize the client +client = Arcade() + +# Call a tool +response = client.tools.execute( + tool_name="Google.SendEmail", + inputs={ + "to": "user@example.com", + "subject": "Hello from Arcade", + "body": "This email was sent by an AI agent!" + }, + user_id="user_123" # The user whose credentials to use +) +``` + +## Next Steps + +1. [Choose your framework](/get-started/agent-frameworks) and follow the setup guide +2. [Understand auth patterns](/use-tools/agent/auth-patterns) for user-facing apps +3. [Handle auth status](/use-tools/agent/handle-auth) and errors gracefully diff --git a/app/en/use-tools/ide/_meta.tsx b/app/en/use-tools/ide/_meta.tsx new file mode 100644 index 000000000..ab7a70a9e --- /dev/null +++ b/app/en/use-tools/ide/_meta.tsx @@ -0,0 +1,21 @@ +import type { MetaRecord } from "nextra"; + +export const meta: MetaRecord = { + "mcp-gateways": { + title: "MCP Gateways (Recommended)", + }, + "claude-desktop": { + title: "Claude Desktop", + }, + cursor: { + title: "Cursor", + }, + "visual-studio-code": { + title: "VS Code", + }, + "copilot-studio": { + title: "Microsoft Copilot Studio", + }, +}; + +export default meta; diff --git a/app/en/use-tools/ide/claude-desktop/page.mdx b/app/en/use-tools/ide/claude-desktop/page.mdx new file mode 100644 index 000000000..160e56bc2 --- /dev/null +++ b/app/en/use-tools/ide/claude-desktop/page.mdx @@ -0,0 +1,20 @@ +--- +title: "Claude Desktop" +description: "Add Arcade tools to Claude Desktop" +--- + +import { Callout } from "nextra/components"; + +# Claude Desktop + + +**Coming soon.** This page will have streamlined Claude Desktop setup instructions. + + +## Quick Setup + +The fastest way to add Arcade tools to Claude Desktop is via [MCP Gateways](/use-tools/ide/mcp-gateways). + +## In the Meantime + +See the existing guide: [Claude Desktop Setup](/get-started/mcp-clients/claude-desktop) diff --git a/app/en/use-tools/ide/copilot-studio/page.mdx b/app/en/use-tools/ide/copilot-studio/page.mdx new file mode 100644 index 000000000..0b4865a47 --- /dev/null +++ b/app/en/use-tools/ide/copilot-studio/page.mdx @@ -0,0 +1,20 @@ +--- +title: "Microsoft Copilot Studio" +description: "Add Arcade tools to Microsoft Copilot Studio" +--- + +import { Callout } from "nextra/components"; + +# Microsoft Copilot Studio + + +**Coming soon.** This page will have streamlined Copilot Studio setup instructions. + + +## Quick Setup + +The fastest way to add Arcade tools to Copilot Studio is via [MCP Gateways](/use-tools/ide/mcp-gateways). + +## In the Meantime + +See the existing guide: [Copilot Studio Setup](/get-started/mcp-clients/copilot-studio) diff --git a/app/en/use-tools/ide/cursor/page.mdx b/app/en/use-tools/ide/cursor/page.mdx new file mode 100644 index 000000000..496e67c4f --- /dev/null +++ b/app/en/use-tools/ide/cursor/page.mdx @@ -0,0 +1,20 @@ +--- +title: "Cursor" +description: "Add Arcade tools to Cursor" +--- + +import { Callout } from "nextra/components"; + +# Cursor + + +**Coming soon.** This page will have streamlined Cursor setup instructions. + + +## Quick Setup + +The fastest way to add Arcade tools to Cursor is via [MCP Gateways](/use-tools/ide/mcp-gateways). + +## In the Meantime + +See the existing guide: [Cursor Setup](/get-started/mcp-clients/cursor) diff --git a/app/en/use-tools/ide/mcp-gateways/page.mdx b/app/en/use-tools/ide/mcp-gateways/page.mdx new file mode 100644 index 000000000..bac61b938 --- /dev/null +++ b/app/en/use-tools/ide/mcp-gateways/page.mdx @@ -0,0 +1,59 @@ +--- +title: "MCP Gateways" +description: "The fastest way to add Arcade tools to any MCP client" +--- + +import { Callout, Steps } from "nextra/components"; + +# MCP Gateways + +MCP Gateways are the **fastest way** to connect Arcade tools to your IDE or MCP client. Create a gateway in the dashboard and you'll have a connection URL in under 2 minutes. + + +**What is an MCP Gateway?** +An MCP Gateway is a hosted endpoint that gives your MCP client access to Arcade's tool catalog. No local server installation required. + + +## Quick Start + + +### Create a Gateway + +1. Go to the [Arcade Dashboard](https://api.arcade.dev/dashboard) +2. Click **Create Gateway** +3. Select the tools you want to enable +4. Copy the connection URL + +### Connect Your Client + +Add the gateway URL to your MCP client's configuration. See client-specific guides: + +- [Claude Desktop](/use-tools/ide/claude-desktop) +- [Cursor](/use-tools/ide/cursor) +- [VS Code](/use-tools/ide/visual-studio-code) + +### Start Using Tools + +Your AI assistant now has access to the tools you enabled. Try asking it to: +- "Check my Gmail for unread messages" +- "Create a new issue in Jira" +- "Send a message in Slack" + + + +## Create via AI + +You can also create MCP Gateways by describing what you want in natural language. + +[Create Gateway with AI →](/guides/mcp-gateways/create-via-ai) + +## Create via Dashboard + +For more control over your gateway configuration. + +[Create Gateway in Dashboard →](/guides/mcp-gateways/create-via-dashboard) + +## Next Steps + +- [Browse available tools](/tool-catalog) to see what integrations you can add +- [Configure authentication](/use-tools/agent/auth-patterns) if you need user-specific access diff --git a/app/en/use-tools/ide/page.mdx b/app/en/use-tools/ide/page.mdx new file mode 100644 index 000000000..8d09f0bf9 --- /dev/null +++ b/app/en/use-tools/ide/page.mdx @@ -0,0 +1,47 @@ +--- +title: "Use Arcade Tools in Your IDE" +description: "Add AI-powered tools to Cursor, VS Code, Claude Desktop, and other MCP clients" +--- + +import { Callout } from "nextra/components"; + +# Use Arcade Tools in Your IDE + +Add powerful AI tools to your favorite code editor or MCP client. This is the **fastest way to get started** with Arcade. + + +**Recommended:** Use [MCP Gateways](/use-tools/ide/mcp-gateways) for the quickest setup (2 minutes). + + +## Choose Your Setup Method + +### MCP Gateways (Recommended) + +The fastest way to add Arcade tools to your IDE. Create a gateway in the dashboard and get a connection URL instantly. + +- **Setup time:** 2 minutes +- **No local installation required** +- **Works with any MCP client** + +[Get started with MCP Gateways →](/use-tools/ide/mcp-gateways) + +### Direct MCP Client Setup + +Configure Arcade directly in your specific IDE or MCP client: + +- [Claude Desktop](/use-tools/ide/claude-desktop) - Anthropic's desktop app +- [Cursor](/use-tools/ide/cursor) - AI-first code editor +- [VS Code](/use-tools/ide/visual-studio-code) - Microsoft's code editor +- [Microsoft Copilot Studio](/use-tools/ide/copilot-studio) - Enterprise AI platform + +## What You Can Do + +Once connected, you'll have access to 100+ integrations including: + +- **Email & Calendar:** Gmail, Outlook, Google Calendar +- **Productivity:** Slack, Notion, Jira, Linear, Asana +- **Development:** GitHub, GitLab, Vercel +- **Documents:** Google Docs, Sheets, Drive, Dropbox +- **And many more...** + +[Browse all integrations →](/tool-catalog) diff --git a/app/en/use-tools/ide/visual-studio-code/page.mdx b/app/en/use-tools/ide/visual-studio-code/page.mdx new file mode 100644 index 000000000..14f33c2a1 --- /dev/null +++ b/app/en/use-tools/ide/visual-studio-code/page.mdx @@ -0,0 +1,20 @@ +--- +title: "VS Code" +description: "Add Arcade tools to Visual Studio Code" +--- + +import { Callout } from "nextra/components"; + +# VS Code + + +**Coming soon.** This page will have streamlined VS Code setup instructions. + + +## Quick Setup + +The fastest way to add Arcade tools to VS Code is via [MCP Gateways](/use-tools/ide/mcp-gateways). + +## In the Meantime + +See the existing guide: [VS Code Setup](/get-started/mcp-clients/visual-studio-code) diff --git a/app/en/use-tools/page.mdx b/app/en/use-tools/page.mdx new file mode 100644 index 000000000..997638df8 --- /dev/null +++ b/app/en/use-tools/page.mdx @@ -0,0 +1,42 @@ +--- +title: "Use Arcade Tools" +description: "Add AI-powered tools to your IDE or application" +--- + +# Use Arcade Tools + +Choose how you want to use Arcade's 100+ pre-built integrations. + +## Two Paths + +### In Your IDE / MCP Client + +Add tools directly to your code editor or AI assistant. + +- **Best for:** Developers who want AI tools while coding +- **Setup time:** 2-5 minutes +- **Examples:** Cursor, VS Code, Claude Desktop + +[Get started with IDE setup →](/use-tools/ide) + +--- + +### In Your Agent / Application + +Integrate tools into your own AI-powered applications. + +- **Best for:** Developers building apps with AI capabilities +- **Setup time:** 15-30 minutes +- **Examples:** LangChain agents, OpenAI Agents SDK, custom apps + +[Get started with agent integration →](/use-tools/agent) + +--- + +## Not Sure Which to Choose? + +| I want to... | Go to... | +|--------------|----------| +| Use AI tools while I code | [IDE Setup](/use-tools/ide) | +| Build an app that uses AI tools | [Agent Integration](/use-tools/agent) | +| Create tools that don't exist | [Build Custom Tools](/build-tools) | From b10ae704143f5cd0f7c9460671755d177da2b075 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 23 Jan 2026 18:05:21 +0000 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=A4=96=20Regenerate=20LLMs.txt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- public/llms.txt | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/public/llms.txt b/public/llms.txt index 405cd03ae..01be59b82 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -1,4 +1,4 @@ - + # Arcade @@ -62,6 +62,7 @@ Arcade delivers three core capabilities: Deploy agents even your security team w ## Documentation - [About Arcade](https://docs.arcade.dev/en/get-started/about-arcade.md): This documentation page explains how Arcade facilitates agent authorization for applications that require access to sensitive user data and services. It details the OAuth 2.0 authorization system that enables AI agents to securely act on behalf of users, perform tasks like sending emails or creating +- [Add Authentication to Tools](https://docs.arcade.dev/en/build-tools/add-authentication.md): This documentation page provides guidance on integrating authentication into custom tools, focusing on user credentials and OAuth. Users will learn about different authentication levels, how to utilize existing OAuth providers, and the process of adding custom providers, as well as managing API keys and secrets - [Add user authorization to your MCP tools](https://docs.arcade.dev/en/guides/create-tools/tool-basics/create-tool-auth.md): This documentation page guides users on how to implement user authorization in their custom MCP tools using Arcade, OAuth, and various authentication providers, such as Reddit. It covers the necessary prerequisites, the functioning of auth providers, and step-by-step instructions for creating an - [Adding Resource Server Auth to Your MCP Server](https://docs.arcade.dev/en/guides/security/secure-your-mcp-server.md): This documentation page provides guidance on securing your HTTP MCP server using OAuth 2.1 Resource Server authentication, ensuring that only authorized users can access your tools. It outlines the necessary prerequisites, explains the importance of Resource Server auth, and details how to configure - [Agentic Development](https://docs.arcade.dev/en/get-started/setup/connect-arcade-docs.md): This documentation page provides guidance on utilizing Agentic Development to enhance coding efficiency in AI-integrated IDEs by leveraging Arcade.dev's resources. It explains how to configure the LLMs.txt file for easy access to documentation and introduces Context7, a server @@ -79,11 +80,13 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Asana Reference](https://docs.arcade.dev/en/resources/integrations/productivity/asana/reference.md): The Asana Reference documentation provides a comprehensive list of enumerations related to tag colors, task sorting options, and sort orders used in the Asana MCP Server. Users can utilize this reference to understand and implement the various color codes and sorting parameters effectively in - [AsanaApi](https://docs.arcade.dev/en/resources/integrations/productivity/asana-api.md): The AsanaApi documentation provides users with tools and resources to effectively interact with the Asana API, enabling various actions such as managing access requests, allocations, custom fields, and goal relationships. It outlines a comprehensive set of functionalities that facilitate project management tasks - [AshbyApi](https://docs.arcade.dev/en/resources/integrations/productivity/ashby-api.md): The AshbyApi documentation provides a comprehensive guide for users to effectively manage recruitment processes within the Ashby platform using various API tools. It enables users to create and update job applications, retrieve candidate information, manage interview schedules, and streamline hiring workflows through a +- [Auth Providers](https://docs.arcade.dev/en/auth-providers.md): This documentation page provides guidance on configuring OAuth providers for Arcade authentication, specifically for users who need to set up custom OAuth connections for their tools or self-hosted instances. It outlines the necessary components for OAuth configuration, lists supported providers, and clarifies the - [Authorized Tool Calling](https://docs.arcade.dev/en/guides/tool-calling/custom-apps/auth-tool-calling.md): The "Authorized Tool Calling" documentation provides a comprehensive guide for developers on how to securely authorize AI agents to access external services using OAuth 2.0, API keys, and user tokens. It outlines the steps for initializing the Arcade client, obtaining user - [BoxApi](https://docs.arcade.dev/en/resources/integrations/productivity/box-api.md): The BoxApi documentation provides users with tools to manage and automate various aspects of Box content, including file management, metadata handling, collaboration, document generation, and enterprise operations. It outlines capabilities for interacting with Box's API, enabling users to build applications or - [Brightdata](https://docs.arcade.dev/en/resources/integrations/development/brightdata.md): The Brightdata documentation page provides users with tools and guidance for scraping, searching, and extracting structured data from various websites at scale without being blocked. It outlines specific functionalities such as scraping web pages in Markdown format, performing advanced searches across major search engines, - [Build a Tool](https://docs.arcade.dev/en/guides/create-tools/tool-basics.md): This documentation page provides a comprehensive guide on building custom tools using Arcade's MCP Server framework, enabling users to enhance AI agents with new functionalities. It serves as a starting point for those looking to create their first tool or expand existing capabilities. Users will learn - [Build an AI Chatbot with Arcade and Vercel AI SDK](https://docs.arcade.dev/en/get-started/agent-frameworks/vercelai.md): This documentation page provides a step-by-step guide for building a browser-based AI chatbot using the Vercel AI SDK and Arcade tools to integrate with Gmail and Slack. Users will learn how to set up a Next.js project, handle authentication, and implement +- [Build Custom Tools](https://docs.arcade.dev/en/build-tools.md): This documentation page guides users in building custom tools and MCP servers using Arcade, enabling them to create solutions tailored to their specific needs, such as integrating with internal APIs or implementing unique business logic. It provides a structured approach, including quick start tutorials, foundational - [Build MCP Server QuickStart](https://docs.arcade.dev/en/get-started/quickstarts/mcp-server-quickstart.md): The "Build MCP Server QuickStart" documentation provides a step-by-step guide for users to create and run a custom MCP Server using the Arcade MCP framework. It covers prerequisites, installation instructions, server setup, and how to connect and authorize tools, enabling - [CalendlyApi](https://docs.arcade.dev/en/resources/integrations/productivity/calendly-api.md): The CalendlyApi documentation provides tools and resources for developers to integrate and manage scheduling and event-related tasks within the Calendly platform using OAuth2 authentication. Users can learn how to create, retrieve, and update event types, manage invitees, and handle - [Call a tool in your IDE/MCP Client](https://docs.arcade.dev/en/get-started/quickstarts/call-tool-client.md): This documentation page guides users on how to create and utilize an MCP Gateway in their IDE or MCP Client to streamline the process of calling tools from multiple MCP servers. It covers the steps to set up the gateway, select relevant tools, and connect it to @@ -91,6 +94,8 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Calling tools in your agent with Arcade](https://docs.arcade.dev/en/get-started/quickstarts/call-tool-agent.md): This documentation page provides a comprehensive guide on how to use Arcade to enable AI agents to call various hosted tools, such as sending emails or updating documents. Users will learn to install the Arcade client, set up workflows, and implement authorization for tool calls. - [Capture mode](https://docs.arcade.dev/en/guides/create-tools/evaluate-tools/capture-mode.md): This documentation page explains how to use Capture mode to record tool calls without scoring, enabling users to bootstrap test expectations, debug model behavior, and explore new tools. It provides a step-by-step guide on setting up evaluations in Capture mode, reviewing captured outputs - [Checking Tool Authorization Status](https://docs.arcade.dev/en/guides/tool-calling/custom-apps/check-auth-status.md): This documentation page provides a comprehensive guide on how to check the authorization status of tools, enabling users to determine the necessary permissions and availability before execution. It includes instructions for initializing the client, checking the status for all tools or specific tools, and understanding various +- [Choose Your Framework](https://docs.arcade.dev/en/use-tools/agent/frameworks.md): This documentation page helps users select the appropriate agent framework to integrate with Arcade tools, providing a comparison of supported frameworks along with setup guides for each. It offers recommendations based on specific use cases, such as building simple apps or complex workflows. Additionally, it +- [Claude Desktop](https://docs.arcade.dev/en/use-tools/ide/claude-desktop.md): This documentation page provides users with information on how to add Arcade tools to Claude Desktop, including a quick setup guide through MCP Gateways. It also indicates that streamlined setup instructions are forthcoming and directs users to an existing setup guide in the meantime. - [Clickhouse](https://docs.arcade.dev/en/resources/integrations/databases/clickhouse.md): This documentation page provides users with a comprehensive guide to the Arcade Clickhouse MCP Server, which enables read-only interactions with Clickhouse databases. It outlines key features such as schema discovery, table exploration, and safe query execution, along with detailed instructions on using - [Clickhouse](https://docs.arcade.dev/en/resources/integrations/databases/postgres/clickhouse.md): This documentation page provides a comprehensive guide for using the Arcade Clickhouse MCP Server, which enables agents to interact with Clickhouse databases in a read-only capacity. Users can learn how to discover database schemas, explore table structures, and execute safe SELECT queries, - [Clickup](https://docs.arcade.dev/en/resources/integrations/productivity/clickup.md): This documentation page provides users with tools and guidance for integrating and interacting with ClickUp workspaces, enabling the creation, modification, and management of tasks, comments, and project structures. It outlines various functionalities available through the ClickUp MCP Server, including task @@ -103,15 +108,18 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Connect Arcade to your LLM](https://docs.arcade.dev/en/get-started/agent-frameworks/setup-arcade-with-your-llm-python.md): This documentation page provides a step-by-step guide for integrating Arcade with a Large Language Model (LLM) using Python. It outlines the necessary prerequisites, including API keys and package installations, and teaches users how to create a harness that facilitates communication between the - [Connect to MCP Clients](https://docs.arcade.dev/en/get-started/mcp-clients.md): This documentation page provides guidance on connecting MCP servers to various MCP-compatible clients and development environments, enabling users to enhance their agent workflows. - [Contact Us](https://docs.arcade.dev/en/resources/contact-us.md): This documentation page provides users with information on how to connect with the Arcade team for support through various channels. It aims to facilitate communication and assistance for users and their agents. +- [Contact Us](https://docs.arcade.dev/en/help/contact-us.md): This documentation page provides information on how users can seek help and support for Arcade. It indicates that a dedicated contact information section is forthcoming, while directing users to an existing contact page for immediate assistance. - [Create an evaluation suite](https://docs.arcade.dev/en/guides/create-tools/evaluate-tools/create-evaluation-suite.md): This documentation page provides a comprehensive guide on creating an evaluation suite to test AI models' tool usage through Arcade. Users will learn how to set up prerequisites, define evaluation files and suites, run evaluations, and interpret results, ensuring accurate tool selection and parameter - [Create an MCP tool with secrets](https://docs.arcade.dev/en/guides/create-tools/tool-basics/create-tool-secrets.md): This documentation page guides users on how to create custom MCP tools that securely handle sensitive information, or "secrets," using the Arcade platform. It covers the process of reading secrets from various sources, such as environment variables and the Arcade Dashboard, and provides - [Create via Dashboard](https://docs.arcade.dev/en/guides/mcp-gateways/create-via-dashboard.md): This documentation page guides users through the process of creating and configuring MCP Gateways using the Arcade dashboard, providing detailed instructions on selecting tools, setting authentication modes, and customizing gateway settings. It also outlines prerequisites for creating a gateway and offers post-creation steps - [Creating an MCP Server with Arcade](https://docs.arcade.dev/en/guides/create-tools/tool-basics/build-mcp-server.md): This documentation page provides a comprehensive guide for users to create, test, deploy, and publish a custom MCP Server using the Arcade framework. It details the installation of necessary tools, the scaffolding of a server project, and the setup of environment configurations, +- [Cursor](https://docs.arcade.dev/en/use-tools/ide/cursor.md): This documentation page provides an overview of how to integrate Arcade tools with Cursor, highlighting the upcoming streamlined setup instructions. Users can quickly add these tools through MCP Gateways and are directed to an existing guide for current setup procedures. - [CursorAgentsApi](https://docs.arcade.dev/en/resources/integrations/development/cursor-agents-api.md): The CursorAgentsApi documentation provides users with tools to manage and interact with background agents via the cursor_agents API, including functionalities for listing, inspecting, and deleting agents, retrieving their statuses and conversation histories, and accessing authentication and model recommendations. It serves as - [CustomerioApi](https://docs.arcade.dev/en/resources/integrations/customer-support/customerio-api.md): The CustomerioApi documentation provides users with a comprehensive set of tools to interact with the Customer.io platform, enabling management of customer communications and marketing campaigns. It outlines various functionalities, such as triggering broadcasts, sending transactional messages, and retrieving campaign metrics, all - [CustomerioPipelinesApi](https://docs.arcade.dev/en/resources/integrations/customer-support/customerio-pipelines-api.md): The CustomerioPipelinesApi documentation provides tools for integrating with the Customer.io Track API, enabling users to manage user data and track interactions effectively. It outlines various functionalities, such as identifying users, tracking events, and managing user groups, along with code - [CustomerioTrackApi](https://docs.arcade.dev/en/resources/integrations/customer-support/customerio-track-api.md): The CustomerioTrackApi documentation provides a comprehensive overview of tools that enable users to manage customer data and interactions within the Customer.io platform. It includes detailed descriptions of various functionalities, such as adding or updating customer profiles, deleting customers, and tracking events, - [DatadogApi](https://docs.arcade.dev/en/resources/integrations/development/datadog-api.md): The DatadogApi documentation provides users with tools and instructions for interacting with the Datadog API, enabling them to manage various aspects of Datadog services such as datastores and application keys. It includes guidance on authentication requirements and a comprehensive +- [Deploy Your Tools](https://docs.arcade.dev/en/build-tools/deploy.md): This documentation page provides an overview of deployment options for custom tools, helping users understand the best methods for getting their tools into production. It outlines various deployment strategies, including Arcade Cloud, Arcade Deploy, and self-hosted solutions, along with their complexity levels - [Deploying to the cloud with Arcade Deploy](https://docs.arcade.dev/en/guides/deployment-hosting/arcade-deploy.md): This documentation page provides a comprehensive guide on deploying an MCP server to the cloud using Arcade Deploy, enabling users to access their server from any MCP client and support multiple users without the complexities of local server management. It outlines the prerequisites, deployment steps, and - [Directly call third-party APIs](https://docs.arcade.dev/en/guides/tool-calling/call-third-party-apis.md): This documentation page provides a comprehensive guide on how to obtain user authorization tokens to directly call third-party APIs, specifically using the Gmail API as an example. Users will learn to manage authentication flows, handle authorization requests, and utilize tokens with external services, all - [Discord](https://docs.arcade.dev/en/resources/integrations/social-communication/discord.md): This documentation page provides guidance on configuring and using the Discord authentication provider with Arcade, enabling users to call the Discord API on behalf of their users. It outlines the steps for creating a Discord application, integrating it with the Arcade Dashboard, and utilizing the Discord @@ -121,15 +129,18 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Environment Variables](https://docs.arcade.dev/en/resources/integrations/social-communication/slack/environment-variables.md): This documentation page provides guidance on configuring environment variables related to Slack API interactions, specifically `SLACK_MAX_CONCURRENT_REQUESTS`, `MAX_PAGINATION_SIZE_LIMIT`, and `MAX_PAGINATION_TIMEOUT_SECONDS`. Users will learn how to adjust these settings - [Evaluate Tools](https://docs.arcade.dev/en/guides/create-tools/evaluate-tools.md): The "Evaluate Tools" documentation page provides guidance on systematically testing and enhancing tools using Arcade's evaluation framework. It helps users validate the performance of their tools after initial development and offers techniques for iterative improvements to ensure reliability in production. - [ExaApi](https://docs.arcade.dev/en/resources/integrations/search/exa-api.md): The ExaApi documentation provides users with a comprehensive guide to utilizing the Exa.ai Search API, enabling them to conduct searches, manage websets, and handle research requests effectively. It outlines various tools available within the API, detailing their functionalities such as +- [Examples](https://docs.arcade.dev/en/help/examples.md): This documentation page provides users with a preview of upcoming code examples and sample applications designed to demonstrate functionality. In the meantime, it directs users to existing resources and highlights specific applications such as a chatbot and a Slack bot. Users can explore these examples to better - [Figma](https://docs.arcade.dev/en/resources/integrations/development/figma.md): This documentation page provides users with a comprehensive guide to the Figma MCP Server, enabling interaction with Figma's design files, components, and collaboration features through the Figma REST API. Users can learn to access file structures, manage components, add comments - [FigmaApi](https://docs.arcade.dev/en/resources/integrations/productivity/figma-api.md): The FigmaApi documentation provides a comprehensive guide for developers to utilize tools that enable interaction with the Figma API, facilitating efficient management of design assets and collaboration on projects. Users can learn how to perform various actions such as retrieving Figma files, managing - [Firecrawl](https://docs.arcade.dev/en/resources/integrations/development/firecrawl.md): The Firecrawl documentation provides users with a comprehensive guide to utilizing the Arcade Firecrawl MCP Server, enabling them to build agents and AI applications for scraping, crawling, and mapping websites. It outlines available tools, including functionalities for scraping URLs, crawling websites, - [Frequently Asked Questions](https://docs.arcade.dev/en/resources/faq.md): This documentation page provides answers to frequently asked questions about the Arcade platform, helping users understand how to create and contribute tools, differentiate between various API keys and tools, and manage OAuth authentication. It guides users on building custom tools, collaborating effectively with project API +- [Frequently Asked Questions](https://docs.arcade.dev/en/help/faq.md): This documentation page serves as a placeholder for an upcoming FAQ section specifically about Arcade, aimed at consolidating common questions. In the meantime, users are directed to an existing FAQ resource for immediate assistance. - [FreshserviceApi](https://docs.arcade.dev/en/resources/integrations/customer-support/freshservice-api.md): The FreshserviceApi documentation provides a comprehensive set of tools for programmatically interacting with the Freshservice platform, enabling users to manage various aspects such as organizational data, assets, software, service catalogs, users, and tickets. It outlines specific API endpoints that - [Get Formatted Tool Definitions](https://docs.arcade.dev/en/guides/tool-calling/custom-apps/get-tool-definitions.md): This documentation page provides guidance on retrieving formatted tool definitions using the Arcade Client, enabling users to obtain single or multiple tool definitions in specific model provider formats, such as OpenAI. It also explains how to convert these definitions into Zod schemas for enhanced type - [Getting Your API Key](https://docs.arcade.dev/en/get-started/setup/api-keys.md): This documentation page guides users on how to obtain and manage their Arcade API key, detailing the steps for generating keys via both the Arcade dashboard and CLI. It emphasizes the importance of securely storing API keys, as they serve as administrator credentials for accessing Arcade services - [GitHub](https://docs.arcade.dev/en/resources/integrations/development/github.md): This documentation page provides a comprehensive guide for using the Arcade GitHub MCP Server, enabling users to build agents and AI applications that interact with GitHub repositories, issues, and pull requests. It outlines the necessary configurations, permissions, and features available for both - [GithubApi](https://docs.arcade.dev/en/resources/integrations/development/github-api.md): The GitHubApi documentation provides tools for users to interact with the GitHub API, facilitating the management of repositories, issues, pull requests, and various administrative tasks within GitHub Enterprise. It outlines a range of functionalities, including creating and managing webhooks +- [Glossary](https://docs.arcade.dev/en/help/glossary.md): This documentation page provides a glossary of key terms used in Arcade documentation, helping users understand specific terminology. Currently, it indicates that the full definitions are forthcoming and directs users to an existing resources glossary for immediate reference. - [Gmail](https://docs.arcade.dev/en/resources/integrations/productivity/gmail.md): This documentation page provides a comprehensive overview of the Arcade Gmail MCP Server, which enables users to build agents and AI applications that can send, read, and manage emails in Gmail. It details the available tools, their functionalities, and the necessary OAuth scopes required - [Gmail Reference](https://docs.arcade.dev/en/resources/integrations/productivity/gmail/reference.md): The Gmail Reference documentation provides users with a list of enumerations related to the Gmail MCP Server, specifically detailing options for reply recipients and date ranges. This reference helps users understand and utilize specific parameters effectively in their Gmail-related tools. - [Google Calendar](https://docs.arcade.dev/en/resources/integrations/productivity/google-calendar.md): This documentation page provides a comprehensive guide for developers to utilize the Arcade Google Calendar MCP Server, enabling them to create applications that interact with users' Google Calendar accounts. It outlines available tools for managing calendars and events, such as listing calendars, creating and updating @@ -150,7 +161,9 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [GoogleCalendar Reference](https://docs.arcade.dev/en/resources/integrations/productivity/google-calendar/reference.md): The GoogleCalendar Reference documentation provides a concise overview of key enumerations related to event visibility, update options for sending notifications, and managing Google Meet settings within the GoogleCalendar MCP Server. Users can reference these enumerations to effectively configure and manage calendar events and - [GoogleDocs Reference](https://docs.arcade.dev/en/resources/integrations/productivity/google-docs/reference.md): The GoogleDocs Reference documentation provides a comprehensive list of enumerations used in the GoogleDocs MCP Server, specifically focusing on sorting options and document formats. Users can learn about various order criteria, such as creation and modification times, as well as supported document formats - [GoogleSheets Reference](https://docs.arcade.dev/en/resources/integrations/productivity/google-sheets/reference.md): The GoogleSheets Reference documentation provides a comprehensive list of enumerations related to sorting and ordering data within the GoogleSheets MCP Server. Users can learn about various order criteria, such as creation time, modification time, and name, along with their corresponding identifiers for +- [Handle Auth Status & Errors](https://docs.arcade.dev/en/use-tools/agent/handle-auth.md): This documentation page provides guidance on managing authentication status and handling errors in user-facing applications. It outlines best practices for checking user authorization before tool calls, identifies common authentication errors, and offers solutions for each scenario. Users will learn how to ensure smooth authentication processes - [Handle Errors](https://docs.arcade.dev/en/guides/create-tools/error-handling.md): This documentation page teaches users how to implement effective error handling in their tools to enhance user experience and ensure resilience in production environments. It outlines strategies for managing various error types and encourages the adoption of robust patterns for improved reliability. +- [Help](https://docs.arcade.dev/en/help.md): This documentation page provides users with resources to find answers, troubleshoot issues, and receive support related to Arcade. It includes quick links to troubleshooting guides, FAQs, a glossary, code examples, and contact information for further assistance. Users can specifically address common issues - [Hosting Optoions Overview](https://docs.arcade.dev/en/guides/deployment-hosting.md): This documentation page provides an overview of the various hosting options available for the Arcade platform, including the Arcade Cloud service and on-premise deployments. Users can learn how to quickly set up and manage their applications with zero infrastructure through Arcade Cloud or configure on-prem - [How to contribute a MCP Server](https://docs.arcade.dev/en/resources/integrations/contribute-a-server.md): This documentation page provides a step-by-step guide for developers on how to contribute their MCP Server to the Arcade documentation. It outlines the prerequisites for submission, including building and publishing the MCP Server, and details the process for opening a pull request and ensuring it - [Hubspot](https://docs.arcade.dev/en/resources/integrations/sales/hubspot.md): This documentation page provides users with tools and guidance for integrating and automating interactions with HubSpot CRM through the HubSpot MCP Server. Users can learn how to perform various actions such as creating, updating, and retrieving data related to users, contacts, deals @@ -176,6 +189,9 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [LumaApi](https://docs.arcade.dev/en/resources/integrations/productivity/luma-api.md): The LumaApi documentation provides users with tools and guidance for managing events and calendars within the Luma platform via its API. It covers functionalities such as creating and updating events, managing guest information, and handling invitations and coupons, all aimed at enhancing event - [MailchimpMarketingApi](https://docs.arcade.dev/en/resources/integrations/productivity/mailchimp-marketing-api.md): The Mailchimp Marketing API documentation provides users with a set of tools for managing and optimizing their email marketing campaigns through direct interaction with the Mailchimp platform. Users can learn how to retrieve account information, manage audience contacts, create and automate marketing workflows, and - [MCP Gateways](https://docs.arcade.dev/en/guides/mcp-gateways.md): This documentation page provides guidance on using MCP Gateways to connect multiple MCP servers to an agent, application, or IDE, enabling users to federate tools for streamlined management and access. It outlines the benefits of using MCP Gateways, details the creation process +- [MCP Gateways](https://docs.arcade.dev/en/use-tools/ide/mcp-gateways.md): The MCP Gateways documentation provides users with a quick and efficient method to connect Arcade tools to their MCP clients without the need for local server installations. It guides users through the process of creating a gateway in the Arcade Dashboard, connecting it to their IDE, +- [MCP Server Basics](https://docs.arcade.dev/en/build-tools/mcp-server-basics.md): The "MCP Server Basics" documentation page provides an overview of MCP servers, including their functionality, deployment options, and best practices for tool organization. Users will learn about the integration of authentication and hosting through Arcade, as well as how to effectively structure +- [Microsoft Copilot Studio](https://docs.arcade.dev/en/use-tools/ide/copilot-studio.md): The Microsoft Copilot Studio documentation page provides users with upcoming setup instructions for integrating Arcade tools into Copilot Studio. It highlights the quickest method to achieve this through MCP Gateways and offers a link to the existing setup guide for immediate assistance. - [Microsoft Teams](https://docs.arcade.dev/en/resources/integrations/social-communication/microsoft-teams.md): This documentation page provides users with a comprehensive guide to the Microsoft Teams MCP Server, enabling them to effectively manage teams, channels, and chats within Microsoft Teams. Users can learn how to retrieve information, send messages, and manage users and interactions, streamlining - [MicrosoftTeams Reference](https://docs.arcade.dev/en/resources/integrations/social-communication/microsoft-teams/reference.md): The MicrosoftTeams Reference documentation provides a comprehensive overview of key enumerations used in the MicrosoftTeams MCP Server, including types for matching criteria and team membership. Users can learn about specific values such as `PARTIAL_ALL`, `EXACT`, and `DIRECT - [Migrate from toolkits to MCP servers](https://docs.arcade.dev/en/guides/create-tools/migrate-toolkits.md): This documentation page provides a comprehensive guide for users looking to migrate their existing Arcade toolkits to the new MCP Server framework. It outlines the necessary changes in terminology, package dependencies, and code structure, while offering step-by-step instructions for updating imports, creating @@ -203,6 +219,7 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Provide the tool manager callback to the ArcadeToolManager](https://docs.arcade.dev/en/get-started/agent-frameworks/crewai/custom-auth-flow.md): This documentation page provides a comprehensive guide on creating a custom authorization flow for the ArcadeToolManager within a CrewAI agent team. It outlines the necessary prerequisites, setup steps, and code examples to help users implement tailored authorization processes for executing Arcade tools. By - [Providing useful tool errors](https://docs.arcade.dev/en/guides/create-tools/error-handling/useful-tool-errors.md): This documentation page teaches developers how to effectively handle errors when building tools with Arcade MCP, emphasizing the automatic error adaptation feature that reduces boilerplate code. It outlines the error handling philosophy, explains the use of error adapters, and provides guidance on when to raise - [Pylon](https://docs.arcade.dev/en/resources/integrations/customer-support/pylon.md): The Pylon documentation provides agents with the necessary tools and API functionalities to manage issues, contacts, users, and teams within the Pylon MCP Server. Users can learn how to list and search issues, assign ownership, and interact with user and team data +- [Quick Start: Your First Custom Tool](https://docs.arcade.dev/en/build-tools/quickstart.md): This documentation page provides a quick tutorial for users to build their first custom tool using the Arcade platform in under five minutes. It outlines the necessary prerequisites, step-by-step instructions for installation, tool creation, and local testing, while also suggesting next steps for - [Reddit](https://docs.arcade.dev/en/resources/integrations/social-communication/reddit.md): This documentation page provides users with a comprehensive guide to the Arcade Reddit MCP Server, which enables the development of agents and AI applications that can interact with Reddit. It details various tools available for actions such as submitting posts, commenting, retrieving content, and checking - [Reference](https://docs.arcade.dev/en/resources/integrations/social-communication/slack/reference.md): This documentation page provides a reference for the enumerations related to conversation types used in the Slack MCP Server, including definitions for public channels, private channels, multi-person direct messages, and direct messages. Users can refer to this information to understand the different conversation - [Reference](https://docs.arcade.dev/en/resources/integrations/social-communication/twilio/reference.md): This documentation page provides a reference for the `arcade_twilio` package, which enables users to integrate Twilio services for sending SMS and WhatsApp messages. It includes installation instructions, a brief description of the package, and detailed usage guidelines for the @@ -213,6 +230,7 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Secure and Brand the Auth Flow in Production](https://docs.arcade.dev/en/guides/user-facing-agents/secure-auth-production.md): This documentation page guides users on how to secure and customize their authentication flows using Arcade.dev in production environments. It explains the use of the default Arcade user verifier for development and the implementation of a custom user verifier for production applications, ensuring user verification and enhancing - [Securing Arcade MCP Deployments](https://docs.arcade.dev/en/guides/security/securing-arcade-mcp.md): This documentation page provides guidance on securing Arcade MCP deployments, detailing two primary methods: deploying the MCP server to the Arcade platform for built-in security features and implementing OAuth 2.1 Resource Server authentication for self-hosted environments. Users will learn how to - [Security](https://docs.arcade.dev/en/guides/security.md): This documentation page provides users with best practices for ensuring the security of MCP servers and Arcade tools, particularly when handling sensitive data or operating in production environments. It also highlights the importance of security in tool development and outlines the resources available for implementing robust security measures +- [Security & Compliance](https://docs.arcade.dev/en/security.md): This documentation page provides best practices for ensuring the security and compliance of Arcade applications, focusing on securing MCP servers, managing authentication processes, and reporting vulnerabilities. It includes a quick security checklist to help users prepare their applications for production deployment. Additionally, it offers - [Security Research Program](https://docs.arcade.dev/en/guides/security/security-research-program.md): The Security Research Program documentation page outlines how users can report security vulnerabilities in Arcade's tools and services, emphasizing the importance of community involvement in enhancing security. It details the types of vulnerabilities sought, the reporting process, and guidelines for responsible disclosure. Additionally, - [Server-Level vs Tool-Level Authorization](https://docs.arcade.dev/en/learn/server-level-vs-tool-level-auth.md): This documentation page explains the differences between server-level authorization (Resource Server auth) and tool-level authorization in Arcade MCP servers, highlighting their roles in securing access to the server and third-party APIs. It provides guidance on when to implement each type of authorization, - [Set your API key](https://docs.arcade.dev/en/get-started/agent-frameworks/openai-agents/user-auth-interrupts.md): This documentation page provides a comprehensive guide on managing user authorization for Arcade tools within OpenAI Agents applications. It outlines the steps to obtain an API key, configure the environment, handle authorization errors, and implement a complete authorization flow. Users will learn how to @@ -227,11 +245,14 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Stripe](https://docs.arcade.dev/en/resources/integrations/payments/stripe.md): This documentation page provides users with tools and guidance to interact with the Stripe API, enabling the creation and management of customers, products, invoices, and payment processing. Users can learn how to implement various functionalities, such as creating customers or products, listing invoices - [StripeApi](https://docs.arcade.dev/en/resources/integrations/payments/stripe_api.md): The StripeApi documentation provides tools for developers to interact with the Stripe API, enabling them to manage accounts, customers, payments, billing, and various Stripe resources programmatically. Users can perform a wide range of operations, including retrieving account details, managing payment - [Teams Reference](https://docs.arcade.dev/en/resources/integrations/social-communication/teams/reference.md): The Teams Reference documentation provides a comprehensive list of enumerations related to matching types and team membership within the Teams MCP Server. Users can learn about different match criteria, such as exact and partial matches, as well as the types of team memberships available. This +- [Test & Evaluate Tools](https://docs.arcade.dev/en/build-tools/test-evaluate.md): The "Test & Evaluate Tools" documentation page provides guidance on the importance of evaluating tools for AI agents, including strategies for creating test suites, running evaluations, and comparing tool versions. Although the main content is forthcoming, users can access existing guides to learn - [The Arcade Registry](https://docs.arcade.dev/en/resources/registry-early-access.md): The Arcade Registry documentation page provides an overview of the Arcade Registry, a platform for developers to share and monetize their tools for agentic applications. It explains how the registry collects usage metrics and feedback to enhance tool effectiveness, while inviting users to participate in the - [TicktickApi](https://docs.arcade.dev/en/resources/integrations/productivity/ticktick-api.md): The TicktickApi documentation provides a set of tools for developers to manage tasks and projects within the Ticktick platform using OAuth2 authentication. Users can learn how to create, update, delete, and retrieve tasks and projects through various API endpoints, enabling seamless +- [Tool Catalog](https://docs.arcade.dev/en/tool-catalog.md): The Tool Catalog documentation page provides users with access to over 100 ready-to-use AI tool integrations across various categories, enabling their AI agents to perform actions such as sending emails and managing files. Users can browse tools by category, learn how to integrate them - [Tool error handling](https://docs.arcade.dev/en/guides/tool-calling/error-handling.md): This documentation page provides guidance on effectively handling errors when using tools with Arcade's Tool Development Kit (TDK). It outlines the error handling philosophy, describes various error types, and offers best practices for implementing robust error management in applications. Users will learn how - [Tools](https://docs.arcade.dev/en/resources/tools.md): This documentation page provides an overview of Arcade's ecosystem of AI tools, enabling users to explore a catalog of pre-built integrations, create custom tools, and contribute to the community. It outlines the benefits of using Arcade tools, including built-in authentication and universal - [TrelloApi](https://docs.arcade.dev/en/resources/integrations/productivity/trello-api.md): The TrelloApi documentation provides users with a comprehensive set of tools for interacting with the Trello API, enabling efficient management of boards, cards, lists, and members. It outlines various functionalities, such as fetching and updating actions, retrieving board details, +- [Troubleshooting](https://docs.arcade.dev/en/help/troubleshooting.md): This documentation page provides users with troubleshooting guidance for common issues encountered in the Arcade platform, including authentication, tool calling, and client/server connectivity problems. It outlines specific problems, their potential causes, and step-by-step solutions to help users resolve these issues effectively - [Twilio](https://docs.arcade.dev/en/resources/integrations/social-communication/twilio.md): This documentation page provides users with a comprehensive guide to using Twilio for sending SMS and WhatsApp messages through an MCP Server, including setup prerequisites and configuration details. It outlines the necessary credentials required for integration and offers practical usage examples to demonstrate the server's - [Twitch auth provider](https://docs.arcade.dev/en/resources/integrations/entertainment/twitch.md): The Twitch auth provider documentation page guides users in creating a custom authentication provider to access the Twitch API using their own OAuth 2.0 credentials. It outlines the steps to configure Twitch authentication within the Arcade platform, including creating a Twitch application and integrating it - [Types of Tools](https://docs.arcade.dev/en/guides/create-tools/improve/types-of-tools.md): This documentation page explains the two types of tools offered by Arcade: Optimized tools and Starter tools. It highlights the differences in design and functionality, emphasizing that Optimized tools are tailored for AI-powered chat interfaces to improve performance, while Starter tools provide more @@ -240,7 +261,12 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Use Arcade in Cursor](https://docs.arcade.dev/en/get-started/mcp-clients/cursor.md): This documentation page provides a step-by-step guide for connecting Cursor to an Arcade MCP Gateway, enabling users to utilize Arcade tools within the Cursor environment. It outlines the prerequisites for setup, including creating an Arcade account and obtaining an API key, as well as - [Use Arcade in Microsoft Copilot Studio](https://docs.arcade.dev/en/get-started/mcp-clients/copilot-studio.md): This documentation page guides users on how to connect Microsoft Copilot Studio to an Arcade MCP Gateway, enabling the integration of Arcade tools into their agents. It outlines the prerequisites, step-by-step instructions for creating or opening an agent, adding an MCP tool, - [Use Arcade in Visual Studio Code](https://docs.arcade.dev/en/get-started/mcp-clients/visual-studio-code.md): This documentation page provides a step-by-step guide for connecting Visual Studio Code to an Arcade MCP Gateway, enabling users to set up and run an MCP server within the IDE. It outlines prerequisites, setup instructions, and authentication processes to ensure successful integration. By +- [Use Arcade Tools](https://docs.arcade.dev/en/use-tools.md): This documentation page guides users on how to integrate Arcade's AI-powered tools into their development environments, either directly within their IDEs or into their own applications. It outlines two main paths for setup, catering to developers who want to enhance their coding experience or +- [Use Arcade Tools in Your Agent or App](https://docs.arcade.dev/en/use-tools/agent.md): This documentation page guides users on how to integrate Arcade tools with various agent frameworks, enabling applications to perform actions like sending emails and managing tasks on behalf of users. It provides a selection of frameworks, key concepts such as user authentication, and a catalog of +- [Use Arcade Tools in Your IDE](https://docs.arcade.dev/en/use-tools/ide.md): This documentation page guides users on how to integrate AI-powered Arcade tools into their preferred code editors or MCP clients, such as Cursor, VS Code, and Claude Desktop. It outlines the quickest setup method using MCP Gateways and provides options for direct configuration in +- [User Authentication Patterns](https://docs.arcade.dev/en/use-tools/agent/auth-patterns.md): This documentation page provides guidance on user authentication patterns for building applications with Arcade, outlining three main methods: pre-authorized credentials, user-facing OAuth, and headless/device flow. It helps developers choose the appropriate authentication strategy based on their application's requirements, whether - [VercelApi](https://docs.arcade.dev/en/resources/integrations/development/vercel-api.md): The VercelApi documentation provides a comprehensive guide for users to manage their Vercel projects, domains, and integrations through various API tools. It outlines available functionalities such as creating and managing access groups, handling deployments, and managing DNS records, enabling +- [VS Code](https://docs.arcade.dev/en/use-tools/ide/visual-studio-code.md): This documentation page provides information on how to integrate Arcade tools into Visual Studio Code, with a focus on quick setup through MCP Gateways. It also indicates that streamlined setup instructions will be available soon and directs users to an existing guide for current setup procedures. - [Walmart Search](https://docs.arcade.dev/en/resources/integrations/search/walmart.md): The Walmart Search documentation provides tools for developers to integrate product search and details retrieval from Walmart into their applications. It outlines how to use the `Walmart.SearchProducts` and `Walmart.GetProductDetails` tools, including parameters for customizing searches and retrieving - [WeaviateApi](https://docs.arcade.dev/en/resources/integrations/databases/weaviate-api.md): The WeaviateApi documentation provides users with essential tools and instructions for managing and interacting with the Weaviate vector search engine via its API. It covers authentication requirements, including obtaining API keys, and offers a comprehensive list of available API endpoints for various - [What are tools?](https://docs.arcade.dev/en/guides/tool-calling.md): This documentation page provides an overview of tool calling in language models, explaining how users can leverage external tools to enhance the capabilities of AI models for tasks like data retrieval, scheduling, and email communication. It outlines the process of integrating these tools through the Arcade From dc87c18b333a5e65dbb553436580b98c7688110c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 23 Jan 2026 18:05:56 +0000 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=A4=96=20Regenerate=20LLMs.txt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- public/llms.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/public/llms.txt b/public/llms.txt index 01be59b82..0a8140064 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -107,8 +107,8 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Confluence](https://docs.arcade.dev/en/resources/integrations/productivity/confluence.md): This documentation page provides a comprehensive overview of the Arcade Confluence MCP Server, which enables users to build agents and AI applications that interact with Confluence. It details various tools available for managing pages, spaces, and attachments, as well as searching for content - [Connect Arcade to your LLM](https://docs.arcade.dev/en/get-started/agent-frameworks/setup-arcade-with-your-llm-python.md): This documentation page provides a step-by-step guide for integrating Arcade with a Large Language Model (LLM) using Python. It outlines the necessary prerequisites, including API keys and package installations, and teaches users how to create a harness that facilitates communication between the - [Connect to MCP Clients](https://docs.arcade.dev/en/get-started/mcp-clients.md): This documentation page provides guidance on connecting MCP servers to various MCP-compatible clients and development environments, enabling users to enhance their agent workflows. -- [Contact Us](https://docs.arcade.dev/en/resources/contact-us.md): This documentation page provides users with information on how to connect with the Arcade team for support through various channels. It aims to facilitate communication and assistance for users and their agents. - [Contact Us](https://docs.arcade.dev/en/help/contact-us.md): This documentation page provides information on how users can seek help and support for Arcade. It indicates that a dedicated contact information section is forthcoming, while directing users to an existing contact page for immediate assistance. +- [Contact Us](https://docs.arcade.dev/en/resources/contact-us.md): This documentation page provides users with information on how to connect with the Arcade team for support through various channels. It aims to facilitate communication and assistance for users and their agents. - [Create an evaluation suite](https://docs.arcade.dev/en/guides/create-tools/evaluate-tools/create-evaluation-suite.md): This documentation page provides a comprehensive guide on creating an evaluation suite to test AI models' tool usage through Arcade. Users will learn how to set up prerequisites, define evaluation files and suites, run evaluations, and interpret results, ensuring accurate tool selection and parameter - [Create an MCP tool with secrets](https://docs.arcade.dev/en/guides/create-tools/tool-basics/create-tool-secrets.md): This documentation page guides users on how to create custom MCP tools that securely handle sensitive information, or "secrets," using the Arcade platform. It covers the process of reading secrets from various sources, such as environment variables and the Arcade Dashboard, and provides - [Create via Dashboard](https://docs.arcade.dev/en/guides/mcp-gateways/create-via-dashboard.md): This documentation page guides users through the process of creating and configuring MCP Gateways using the Arcade dashboard, providing detailed instructions on selecting tools, setting authentication modes, and customizing gateway settings. It also outlines prerequisites for creating a gateway and offers post-creation steps @@ -133,8 +133,8 @@ Arcade delivers three core capabilities: Deploy agents even your security team w - [Figma](https://docs.arcade.dev/en/resources/integrations/development/figma.md): This documentation page provides users with a comprehensive guide to the Figma MCP Server, enabling interaction with Figma's design files, components, and collaboration features through the Figma REST API. Users can learn to access file structures, manage components, add comments - [FigmaApi](https://docs.arcade.dev/en/resources/integrations/productivity/figma-api.md): The FigmaApi documentation provides a comprehensive guide for developers to utilize tools that enable interaction with the Figma API, facilitating efficient management of design assets and collaboration on projects. Users can learn how to perform various actions such as retrieving Figma files, managing - [Firecrawl](https://docs.arcade.dev/en/resources/integrations/development/firecrawl.md): The Firecrawl documentation provides users with a comprehensive guide to utilizing the Arcade Firecrawl MCP Server, enabling them to build agents and AI applications for scraping, crawling, and mapping websites. It outlines available tools, including functionalities for scraping URLs, crawling websites, -- [Frequently Asked Questions](https://docs.arcade.dev/en/resources/faq.md): This documentation page provides answers to frequently asked questions about the Arcade platform, helping users understand how to create and contribute tools, differentiate between various API keys and tools, and manage OAuth authentication. It guides users on building custom tools, collaborating effectively with project API - [Frequently Asked Questions](https://docs.arcade.dev/en/help/faq.md): This documentation page serves as a placeholder for an upcoming FAQ section specifically about Arcade, aimed at consolidating common questions. In the meantime, users are directed to an existing FAQ resource for immediate assistance. +- [Frequently Asked Questions](https://docs.arcade.dev/en/resources/faq.md): This documentation page provides answers to frequently asked questions about the Arcade platform, helping users understand how to create and contribute tools, differentiate between various API keys and tools, and manage OAuth authentication. It guides users on building custom tools, collaborating effectively with project API - [FreshserviceApi](https://docs.arcade.dev/en/resources/integrations/customer-support/freshservice-api.md): The FreshserviceApi documentation provides a comprehensive set of tools for programmatically interacting with the Freshservice platform, enabling users to manage various aspects such as organizational data, assets, software, service catalogs, users, and tickets. It outlines specific API endpoints that - [Get Formatted Tool Definitions](https://docs.arcade.dev/en/guides/tool-calling/custom-apps/get-tool-definitions.md): This documentation page provides guidance on retrieving formatted tool definitions using the Arcade Client, enabling users to obtain single or multiple tool definitions in specific model provider formats, such as OpenAI. It also explains how to convert these definitions into Zod schemas for enhanced type - [Getting Your API Key](https://docs.arcade.dev/en/get-started/setup/api-keys.md): This documentation page guides users on how to obtain and manage their Arcade API key, detailing the steps for generating keys via both the Arcade dashboard and CLI. It emphasizes the importance of securely storing API keys, as they serve as administrator credentials for accessing Arcade services