Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/generate-toolkit-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ jobs:
--llm-concurrency 15 \
--exclude-file ./remove-toolkits.txt \
--ignore-file ./skip-toolkits.txt \
--custom-sections ./curation \
Comment thread
cursor[bot] marked this conversation as resolved.
--output data/toolkits
working-directory: toolkit-docs-generator
env:
Expand Down
1 change: 1 addition & 0 deletions biome.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
"!node_modules",
"!public",
"!toolkit-docs-generator/data/toolkits",
"!toolkit-docs-generator/curation",
"!scripts",
"!agents",
"!.vscode",
Expand Down
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/airtableapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
14 changes: 14 additions & 0 deletions toolkit-docs-generator/curation/arcadeengineapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"documentationChunks": [
{
"type": "section",
"location": "custom_section",
"position": "after",
"content": "## Secrets\n\nThis MCP Server requires the `ARCADE_API_KEY` secret to be configured. Learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets).\n\n### Getting your Arcade API Key\n\nTo use the Arcade Engine API MCP Server, you need an Arcade API key. This key authenticates your requests to the Arcade Engine.\n\nLearn how to create and manage your Arcade API keys in the [API Keys documentation](/get-started/setup/api-keys).",
"header": "## Secrets"
}
],
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
10 changes: 10 additions & 0 deletions toolkit-docs-generator/curation/asana.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The Arcade Asana MCP Server uses the [Asana auth provider](/references/auth-providers/asana) to connect to users' Asana accounts."
}
]
}
14 changes: 14 additions & 0 deletions toolkit-docs-generator/curation/asanaapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The AsanaApi MCP Server uses the Auth Provider with id `arcade-asana` to connect to users' AsanaApi accounts. In order to use the MCP Server, you will need to configure the `arcade-asana` auth provider.\nFor detailed information on configuring the Asana OAuth provider with Arcade, see the [Asana Auth Provider documentation](/references/auth-providers/asana).",
"header": "## Auth"
}
],
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/ashbyapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/boxapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
11 changes: 11 additions & 0 deletions toolkit-docs-generator/curation/brightdata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"documentationChunks": [
{
"type": "section",
"location": "custom_section",
"position": "after",
"content": "## Secrets\n\nThis tool requires the following secrets:\n\n- `BRIGHTDATA_API_KEY`\n- `BRIGHTDATA_ZONE`\n\n### Auth\n\nThe Arcade Bright Data MCP Server uses [Bright Data](https://brightdata.com/) to access proxy networks and web scraping infrastructure.\n\n**Global Environment Variables:**\n\n- `BRIGHTDATA_API_KEY`: Your Bright Data API key. You can generate this from your [Bright Data dashboard](https://brightdata.com/cp/zones) under Account Settings → API Access.\n\n- `BRIGHTDATA_ZONE`: Your Bright Data zone name (e.g., `residential_proxy1`). This is the zone identifier you created in your Bright Data dashboard under Proxies & Scraping Infrastructure → Zones.\n\n**How to get your credentials:**\n\n1. **API Key**: Navigate to your [Bright Data Control Panel](https://brightdata.com/cp) → Settings → API Access → Generate API Token\n2. **Zone**: Go to Zones section in your dashboard, find your zone name in the format shown in the zone username: `brd-customer-{customer_id}-zone-{zone_name}`\n\nFor more details, see the [Bright Data API Documentation](https://docs.brightdata.com/api-reference).",
"header": "## Secrets"
}
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/calendlyapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
25 changes: 25 additions & 0 deletions toolkit-docs-generator/curation/clickup.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"documentationChunks": [
{
"type": "section",
"location": "custom_section",
"position": "after",
"content": "## TaskPriority\n\n- **URGENT**: `URGENT`\n- **HIGH**: `HIGH`\n- **NORMAL**: `NORMAL`\n- **LOW**: `LOW`",
"header": "## TaskPriority"
},
{
"type": "section",
"location": "custom_section",
"position": "after",
"content": "## TaskOrderBy\n\n- **CREATED**: `created`\n- **UPDATED**: `updated`\n- **DUE_DATE**: `due_date`",
"header": "## TaskOrderBy"
},
{
"type": "section",
"location": "custom_section",
"position": "after",
"content": "## CommentResolution\n\n- **SET_AS_RESOLVED**: `resolved`\n- **SET_AS_UNRESOLVED**: `unresolved`",
"header": "## CommentResolution"
}
]
}
14 changes: 14 additions & 0 deletions toolkit-docs-generator/curation/clickupapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The ClickupApi MCP Server uses the Auth Provider with id `arcade-clickup` to connect to users' ClickupApi accounts. In order to use the MCP Server, you will need to configure the `arcade-clickup` auth provider.\nFor detailed information on configuring the ClickUp OAuth provider with Arcade, see the [ClickUp Auth Provider documentation](/references/auth-providers/clickup).",
"header": "## Auth"
}
],
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
10 changes: 10 additions & 0 deletions toolkit-docs-generator/curation/confluence.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The Arcade Confluence MCP Server uses the [Atlassian auth provider](/references/auth-providers/atlassian) to connect to users' Atlassian accounts.\n---"
}
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/cursoragentsapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/customerioapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/customeriopipelinesapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/customeriotrackapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
14 changes: 14 additions & 0 deletions toolkit-docs-generator/curation/datadogapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"documentationChunks": [
{
"type": "section",
"location": "before_available_tools",
"position": "after",
"content": "## Authentication\n\nThe Arcade Datadog API MCP Server requires three environment variables to authenticate with the [Datadog API](https://docs.datadoghq.com/api/latest/):\n\n- `DATADOG_API_KEY`\n- `DATADOG_APPLICATION_KEY`\n- `DATADOG_BASE_URL`\n\n**How to obtain your credentials:**\n\n1. Log in to your [Datadog dashboard](https://app.datadoghq.com/)\n2. Navigate to **Organization Settings** (click your profile icon in the bottom left)\n3. Go to **API Keys** → click **New Key** → provide a name and click **Create Key**\n4. Go to **Application Keys** → click **New Key** → provide a name and click **Create Key**\n5. Determine your **Base URL** based on your Datadog site (check the URL in your browser):\n - US1: `api.datadoghq.com`\n - US3: `api.us3.datadoghq.com`\n - US5: `api.us5.datadoghq.com`\n - EU1: `api.datadoghq.eu`\n - AP1: `api.ap1.datadoghq.com`\n - GOV: `api.ddog-gov.com`\n\nFor more details, see the [Datadog API and Application Keys documentation](https://docs.datadoghq.com/account_management/api-app-keys/).",
"header": "## Authentication"
}
],
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
10 changes: 10 additions & 0 deletions toolkit-docs-generator/curation/dropbox.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The Arcade Dropbox MCP Server uses the [Dropbox auth provider](/references/auth-providers/dropbox) to connect to users' Dropbox accounts."
}
]
}
10 changes: 10 additions & 0 deletions toolkit-docs-generator/curation/e2b.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The Arcade E2B MCP Server uses [E2B](https://e2b.dev/) to run code in a sandboxed environment.\n**Global Environment Variables:**\n- `E2B_API_KEY`: Your [E2B](https://e2b.dev/) API key."
}
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/exaapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
10 changes: 10 additions & 0 deletions toolkit-docs-generator/curation/figma.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "<Callout type=\"warning\" title=\"Private OAuth app requirement\">\nThe `projects:read` scope is **ONLY available in private Figma OAuth apps**. This scope is required for the navigation tools (`GetTeamProjects` and `GetProjectFiles`). \nIf you need these navigation tools, you must create a private OAuth app through your Figma organization settings. All other tools work with public OAuth apps.\n</Callout>"
}
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/figmaapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
10 changes: 10 additions & 0 deletions toolkit-docs-generator/curation/firecrawl.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"documentationChunks": [
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The Arcade Firecrawl MCP Server uses [Firecrawl](https://www.firecrawl.dev/) to scrape, crawl, and map websites.\n**Global Environment Variables:**\n- `FIRECRAWL_API_KEY`: Your [Firecrawl](https://www.firecrawl.dev/) API key."
}
]
}
5 changes: 5 additions & 0 deletions toolkit-docs-generator/curation/freshserviceapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
40 changes: 40 additions & 0 deletions toolkit-docs-generator/curation/github.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"documentationChunks": [
{
"type": "warning",
"location": "description",
"position": "after",
"content": "<Callout type=\"warning\">\n **Critical**: This MCP Server is built for **GitHub Apps**, not OAuth Apps.\n \n You **must** create a GitHub App (not an OAuth App) to use this server properly. \n \n 👉 [Complete GitHub App Setup Guide](/references/auth-providers/github)\n</Callout>"
},
{
"type": "info",
"location": "description",
"position": "after",
"content": "<Callout type=\"info\">\n **Configuration**: On Arcade Cloud, these tools work out of the box. Self-hosted and GitHub Enterprise Server users can set the `GITHUB_SERVER_URL` secret in Arcade Dashboard. See [Secrets Setup](#secrets-setup) below.\n</Callout>"
},
{
"type": "info",
"location": "before_available_tools",
"position": "after",
"content": "## GitHub Enterprise Support\n\n<Callout type=\"info\">\n This MCP Server fully supports **GitHub Enterprise Server 2.22+**\n</Callout>\n\n**Default Configuration:**\n- If no `GITHUB_SERVER_URL` is configured, the default is `https://api.github.com` (GitHub.com)\n- All tools work with GitHub.com out of the box\n\n**For GitHub Enterprise Server:**\n\n1. Create your GitHub App on your Enterprise instance (not github.com)\n2. Configure the `GITHUB_SERVER_URL` secret in Arcade Dashboard (see [Secrets Setup](#secrets-setup) below)\n3. Use your Enterprise server's API endpoint\n\n**Example Enterprise Server URLs:**\n- `https://github.yourcompany.com/api/v3`\n- `https://enterprise.yourorg.com/api/v3`\n- `https://git.company.internal/api/v3`\n\n<Callout>\n **Note**: GitHub Enterprise Server uses the `/api/v3` path after the hostname. GitHub.com uses `https://api.github.com` (no `/api/v3` suffix).\n</Callout>\n\n---",
"header": "## GitHub Enterprise Support"
},
{
"type": "section",
"location": "before_available_tools",
"position": "after",
"content": "## GitHub App Permissions Summary\n\nWhen creating your GitHub App, you'll need to grant specific permissions. Here's a quick reference of which tools require which permissions:\n\n### Repository Permissions\n\n| Permission | Level | Required For |\n|------------|-------|--------------|\n| **Contents** | Read | All repository and pull request tools, getting file contents |\n| **Contents** | Write | Creating/updating files, creating branches, merging PRs |\n| **Issues** | Read & Write | Issue management, PR assignments, managing labels (Issues) |\n| **Pull requests** | Read & Write | Pull request management, reviews, managing labels (PRs) |\n| **Metadata** | Read | All tools (automatically granted) |\n| **Statuses** | Read | `CheckPullRequestMergeStatus` |\n\n### Organization Permissions\n\n| Permission | Level | Required For |\n|------------|-------|--------------|\n| **Members** | Read | Projects, collaborators, org repos, user search |\n| **Projects** | Read & Write | All Projects V2 tools |\n\n### User Permissions\n\n| Permission | Level | Required For |\n|------------|-------|--------------|\n| **Read user profile** | Read | User context tools, review workload |\n| **Act on behalf of user** | Enabled | `SetStarred` (starring repositories) |\n\n### Tools by Permission Requirements\n\n<details>\n<summary><b>Basic Repository Access</b> (Contents Read + Metadata)</summary>\n\n- `GetRepository`\n- `CountStargazers`\n- `ListStargazers`\n- `ListRepositoryActivities`\n- `GetFileContents`\n\n</details>\n\n<details>\n<summary><b>Repository Write</b> (Contents Write + Metadata)</summary>\n\n- `CreateBranch`\n- `CreateOrUpdateFile`\n- `UpdateFileLines`\n\n</details>\n\n<details>\n<summary><b>Issue Management</b> (Contents Read + Issues + Metadata)</summary>\n\n- `CreateIssue`\n- `UpdateIssue`\n- `GetIssue`\n- `ListIssues`\n- `CreateIssueComment`\n- `ListRepositoryLabels`\n- `ManageLabels` (for issues)\n\n</details>\n\n<details>\n<summary><b>Pull Request Read</b> (Contents + Pull requests Read + Metadata)</summary>\n\n- `ListPullRequests`\n- `GetPullRequest`\n- `ListPullRequestCommits`\n- `ListReviewCommentsOnPullRequest`\n- `CheckPullRequestMergeStatus` (+ Statuses)\n\n</details>\n\n<details>\n<summary><b>Pull Request Write</b> (Contents Read + Pull requests Write + Metadata)</summary>\n\n- `UpdatePullRequest`\n- `CreatePullRequest`\n- `SubmitPullRequestReview`\n- `ManagePullRequest`\n- `ManagePullRequestReviewers`\n- `CreateReviewComment`\n- `CreateReplyForReviewComment`\n- `ResolveReviewThread`\n- `ManageLabels` (for pull requests)\n- `MergePullRequest` (+ Contents Write)\n\n</details>\n\n<details>\n<summary><b>Organization Tools</b> (Contents + Metadata + Members)</summary>\n\n- `ListOrgRepositories`\n- `SearchMyRepos`\n- `ListRepositoryCollaborators`\n- `AssignPullRequestUser` (+ Issues Write)\n\n</details>\n\n<details>\n<summary><b>Projects V2</b> (Contents + Metadata + Projects + Members)</summary>\n\n- `ListProjects`\n- `ListProjectItems`\n- `SearchProjectItem`\n- `ListProjectFields`\n- `UpdateProjectItem` (Projects Write)\n\n</details>\n\n<details>\n<summary><b>User Context</b> (Contents + Metadata + Read user profile)</summary>\n\n- `WhoAmI` (+ Members)\n- `GetUserRecentActivity`\n- `GetUserOpenItems`\n- `GetReviewWorkload` (+ Pull requests Read)\n\n</details>\n\n---",
"header": "## GitHub App Permissions Summary"
},
{
"type": "warning",
"location": "custom_section",
"position": "after",
"content": "## Configuration & Setup\n\n### Authentication\n\n<Callout type=\"warning\">\n **Critical**: This MCP Server uses **GitHub Apps** authentication, not OAuth Apps.\n \n You **must** create a GitHub App to use this server. OAuth Apps are not supported.\n</Callout>\n\nThe Arcade GitHub MCP Server uses the [GitHub auth provider](/references/auth-providers/github) to connect to users' GitHub accounts.\n\n**For Arcade Cloud:**\n- No configuration needed\n- Your users will see `Arcade` as the requesting application\n- All tools work out of the box\n\n**For Self-Hosted:**\n- You must [create your own GitHub App](/references/auth-providers/github#creating-a-github-app)\n- [Configure the GitHub auth provider](/references/auth-providers/github#configuring-github-auth-in-arcade) with your app credentials\n- Your users will see your application name\n\n<Callout type=\"info\">\n **New to GitHub Apps?** Read [Why Arcade Uses GitHub Apps](/references/auth-providers/github#why-arcade-uses-github-apps-not-oauth-apps) \n to understand the security and compliance benefits.\n</Callout>\n\n### Secrets Setup\n\nGitHub tools read an optional `GITHUB_SERVER_URL` secret from the Arcade Dashboard. It defaults to `https://api.github.com`, so you only need to set it for GitHub Enterprise Server.\n\n**Steps:**\n\n1. Go to [Arcade Dashboard](https://api.arcade.dev/dashboard)\n2. Navigate to **Secrets** in the left sidebar\n3. Click **Add Secret**\n4. Add the following secrets:\n\n| Secret Name | Value | Required For |\n|-------------|-------|--------------|\n| `GITHUB_SERVER_URL` | `https://api.github.com` (default for GitHub.com) | All tools |\n\n<Callout type=\"info\">\n **Default**: If `GITHUB_SERVER_URL` is not configured, it defaults to `https://api.github.com` (GitHub.com)\n \n **GitHub Enterprise Users**: Set `GITHUB_SERVER_URL` to your Enterprise server's API endpoint (e.g., `https://github.yourcompany.com/api/v3`). Note that Enterprise uses `/api/v3` path. See [GitHub Enterprise Support](#github-enterprise-support) for details.\n</Callout>\n\n---",
"header": "## Configuration & Setup"
}
],
"customImports": [
"import { Callout, Tabs } from \"nextra/components\";"
]
}
21 changes: 21 additions & 0 deletions toolkit-docs-generator/curation/githubapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"documentationChunks": [
{
"type": "section",
"location": "custom_section",
"position": "after",
"content": "## Secrets\n\nAll tools in this toolset require the following secret: `GIT_SERVER_URL` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))\n\nThe `GIT_SERVER_URL` secret specifies the GitHub server URL. Use `https://api.github.com` for regular GitHub.com accounts, or your GitHub Enterprise server URL (e.g., `https://github.your-company.com/api/v3`) for GitHub Enterprise deployments.",
"header": "## Secrets"
},
{
"type": "markdown",
"location": "auth",
"position": "after",
"content": "The GithubApi MCP Server uses the Auth Provider with id `arcade-github` to connect to users' GithubApi accounts. In order to use the MCP Server, you will need to configure the `arcade-github` auth provider.\nFor detailed information on configuring the GitHub OAuth provider with Arcade, see the [GitHub Auth Provider documentation](/references/auth-providers/github).",
"header": "## Auth"
}
],
"customImports": [
"import StarterToolInfo from \"@/app/_components/starter-tool-info\";"
]
}
Loading
Loading