From 9224ca4d877d2d755b59c8553682ea15df84cd0a Mon Sep 17 00:00:00 2001 From: Jakub Vacek Date: Thu, 25 Jun 2026 10:28:44 +0200 Subject: [PATCH 1/3] feat: open code docs --- sources/platform/integrations/ai/opencode.md | 124 ++++++++++++++++++ sources/platform/integrations/index.mdx | 7 + static/img/platform/integrations/opencode.svg | 1 + 3 files changed, 132 insertions(+) create mode 100644 sources/platform/integrations/ai/opencode.md create mode 100644 static/img/platform/integrations/opencode.svg diff --git a/sources/platform/integrations/ai/opencode.md b/sources/platform/integrations/ai/opencode.md new file mode 100644 index 0000000000..e8537c1b87 --- /dev/null +++ b/sources/platform/integrations/ai/opencode.md @@ -0,0 +1,124 @@ +--- +title: OpenCode integration +sidebar_label: OpenCode +description: Learn how to install the Apify plugin for opencode to discover, run, and build Actors with the Apify MCP server directly from your terminal. +slug: /integrations/opencode +--- + +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; + +[opencode](https://opencode.ai) is an open-source AI coding agent that runs in your terminal. It reads and edits your codebase, runs commands, and completes multi-step development tasks. + +The [Apify plugin for opencode](https://www.npmjs.com/package/opencode-apify) connects opencode to Apify's library of [Actors](https://apify.com/store) by bundling the [Apify MCP server](/platform/integrations/mcp) for searching the Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). + + + +## Prerequisites + +- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. +- [opencode](https://opencode.ai) - installed and authenticated locally. + +## Install the plugin + +You can add the plugin with the opencode CLI or by editing your configuration file directly. + +Run the following command in your project: + +```bash +opencode plugin opencode-apify +``` + +Alternatively, add the plugin to your `opencode.json`: + +```json +{ + "$schema": "https://opencode.ai/config.json", + "plugin": ["opencode-apify"] +} +``` + +## Authenticate to Apify + +The plugin bundles the Apify MCP server. Read-only tools like searching the Store and fetching Actor details work without signing in, but you need to authenticate to run Actors and access your account data. + +1. List the configured MCP servers: + + ```bash + opencode mcp list + ``` + + The Apify MCP server appears as **not connected** until you authenticate. + +1. Start the Apify OAuth flow: + + ```bash + opencode mcp auth apify + ``` + + opencode opens a browser tab for the Apify OAuth flow. + +1. Review the permissions and click **Allow access**. + + :::caution Dynamic registration warning + + The OAuth page shows a warning that the application was registered dynamically and wasn't verified by Apify. This is expected for the current plugin release - the plugin uses dynamic OAuth client registration. Make sure you trust this installation before allowing access. + + ::: + +After you complete the flow, the Apify MCP server shows as connected and you're all set. + +:::tip Session persistence + +The connection stays authenticated for future sessions. You can revoke access at any time in [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). + +::: + +## Run your first prompt + +Describe what you want in natural language. opencode routes the request to the Apify MCP server, so you don't need to name tools yourself. + +> "Use Apify to find a good Actor for scraping Google Maps places. Show me the best option, its input requirements, pricing model, and what kind of dataset output it returns. Do not run the Actor yet." + +opencode searches Apify Store, fetches the top Actor's details through the Apify MCP server, and summarizes its inputs, pricing, and output - all without running the Actor. + +## Troubleshooting + +### The Apify MCP server shows as not connected + +Run `opencode mcp list` to confirm the server is registered. If it appears as not connected, authenticate with `opencode mcp auth apify` and complete the OAuth flow. See [Authenticate to Apify](#authenticate-to-apify). + +### The plugin isn't loaded + +Print the resolved opencode configuration to confirm the plugin is registered: + +```bash +opencode debug config +``` + +Check that `opencode-apify` is listed under `plugin`. If it's missing, add it to your `opencode.json` or run `opencode plugin opencode-apify` again. + +### Browser doesn't open, or OAuth fails + +If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. + +If you're running opencode in a headless environment (SSH, remote container) or the OAuth flow still fails, authenticate with an API token instead. Copy your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations) and set it before starting opencode: + +```bash +export APIFY_TOKEN= +``` + +## Limitations + +- Long-running Actors may exceed the time a single tool call waits for completion. Reduce the scope or split the work across multiple prompts. +- Each Actor run consumes Apify platform usage from your plan in addition to any opencode usage. See [Billing](/platform/console/billing) for details. + +## Related integrations + +- [Claude Code CLI integration](/platform/integrations/claude-code-cli) - Install the Apify plugin for Claude Code CLI +- [MCP server integration](/platform/integrations/mcp) - Use the Apify MCP server with other clients + +## Resources + +- [Apify plugin for opencode](https://www.npmjs.com/package/opencode-apify) - Plugin package and setup notes +- [opencode documentation](https://opencode.ai/docs) - Official opencode docs +- [Apify Store](https://apify.com/store) - Browse Actors you can run from opencode diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index 17a611c06d..f512720267 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -122,6 +122,13 @@ Plug Apify Actors into the AI stack - chat clients like Claude and ChatGPT via t imageUrl="/img/platform/integrations/pinecone.svg" smallImage /> + [See all AI integrations →](/platform/integrations/ai) diff --git a/static/img/platform/integrations/opencode.svg b/static/img/platform/integrations/opencode.svg new file mode 100644 index 0000000000..b79c7332e2 --- /dev/null +++ b/static/img/platform/integrations/opencode.svg @@ -0,0 +1 @@ + \ No newline at end of file From 9e27c4433ceb2419d2e7a082d61da266687bef77 Mon Sep 17 00:00:00 2001 From: Jakub Vacek Date: Mon, 29 Jun 2026 13:09:14 +0200 Subject: [PATCH 2/3] fix: wording --- sources/platform/integrations/ai/opencode.md | 28 ++++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/sources/platform/integrations/ai/opencode.md b/sources/platform/integrations/ai/opencode.md index e8537c1b87..ce2c21d058 100644 --- a/sources/platform/integrations/ai/opencode.md +++ b/sources/platform/integrations/ai/opencode.md @@ -1,26 +1,26 @@ --- title: OpenCode integration sidebar_label: OpenCode -description: Learn how to install the Apify plugin for opencode to discover, run, and build Actors with the Apify MCP server directly from your terminal. +description: Learn how to install the Apify plugin for OpenCode to discover, search, run, and build Actors with the Apify MCP server directly from your terminal. slug: /integrations/opencode --- import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; -[opencode](https://opencode.ai) is an open-source AI coding agent that runs in your terminal. It reads and edits your codebase, runs commands, and completes multi-step development tasks. +[OpenCode](https://opencode.ai) is an open-source AI coding agent that runs in your terminal. It reads and edits your codebase, runs commands, and completes multi-step development tasks. -The [Apify plugin for opencode](https://www.npmjs.com/package/opencode-apify) connects opencode to Apify's library of [Actors](https://apify.com/store) by bundling the [Apify MCP server](/platform/integrations/mcp) for searching the Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). +The [Apify plugin for OpenCode](https://www.npmjs.com/package/opencode-apify) connects OpenCode to Apify's library of [Actors](https://apify.com/store) by bundling the [Apify MCP server](/platform/integrations/mcp) for searching the Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). ## Prerequisites - [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. -- [opencode](https://opencode.ai) - installed and authenticated locally. +- [OpenCode](https://opencode.ai) - installed and authenticated locally. ## Install the plugin -You can add the plugin with the opencode CLI or by editing your configuration file directly. +You can add the plugin with the OpenCode CLI or by editing your configuration file directly. Run the following command in your project: @@ -55,7 +55,7 @@ The plugin bundles the Apify MCP server. Read-only tools like searching the Stor opencode mcp auth apify ``` - opencode opens a browser tab for the Apify OAuth flow. + OpenCode opens a browser tab for the Apify OAuth flow. 1. Review the permissions and click **Allow access**. @@ -75,11 +75,11 @@ The connection stays authenticated for future sessions. You can revoke access at ## Run your first prompt -Describe what you want in natural language. opencode routes the request to the Apify MCP server, so you don't need to name tools yourself. +Describe what you want in natural language. OpenCode routes the request to the Apify MCP server, so you don't need to name tools yourself. > "Use Apify to find a good Actor for scraping Google Maps places. Show me the best option, its input requirements, pricing model, and what kind of dataset output it returns. Do not run the Actor yet." -opencode searches Apify Store, fetches the top Actor's details through the Apify MCP server, and summarizes its inputs, pricing, and output - all without running the Actor. +OpenCode searches Apify Store, fetches the top Actor's details through the Apify MCP server, and summarizes its inputs, pricing, and output - all without running the Actor. ## Troubleshooting @@ -89,7 +89,7 @@ Run `opencode mcp list` to confirm the server is registered. If it appears as no ### The plugin isn't loaded -Print the resolved opencode configuration to confirm the plugin is registered: +Print the resolved OpenCode configuration to confirm the plugin is registered: ```bash opencode debug config @@ -101,7 +101,7 @@ Check that `opencode-apify` is listed under `plugin`. If it's missing, add it to If the browser doesn't open automatically, copy the OAuth URL shown in the terminal and paste it into your browser manually. -If you're running opencode in a headless environment (SSH, remote container) or the OAuth flow still fails, authenticate with an API token instead. Copy your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations) and set it before starting opencode: +If you're running OpenCode in a headless environment (SSH, remote container) or the OAuth flow still fails, authenticate with an API token instead. Copy your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations) and set it before starting OpenCode: ```bash export APIFY_TOKEN= @@ -110,7 +110,7 @@ export APIFY_TOKEN= ## Limitations - Long-running Actors may exceed the time a single tool call waits for completion. Reduce the scope or split the work across multiple prompts. -- Each Actor run consumes Apify platform usage from your plan in addition to any opencode usage. See [Billing](/platform/console/billing) for details. +- Each Actor run consumes Apify platform usage from your plan in addition to any OpenCode usage. See [Billing](/platform/console/billing) for details. ## Related integrations @@ -119,6 +119,6 @@ export APIFY_TOKEN= ## Resources -- [Apify plugin for opencode](https://www.npmjs.com/package/opencode-apify) - Plugin package and setup notes -- [opencode documentation](https://opencode.ai/docs) - Official opencode docs -- [Apify Store](https://apify.com/store) - Browse Actors you can run from opencode +- [Apify plugin for OpenCode](https://www.npmjs.com/package/opencode-apify) - Plugin package and setup notes +- [OpenCode documentation](https://opencode.ai/docs) - Official OpenCode docs +- [Apify Store](https://apify.com/store) - Browse Actors you can run from OpenCode From e991d762ce1fa93cc3a5ad1c53cd0fec9cbea719 Mon Sep 17 00:00:00 2001 From: Jakub Vacek Date: Mon, 29 Jun 2026 13:27:46 +0200 Subject: [PATCH 3/3] fix: logos --- sources/platform/integrations/ai/opencode.md | 4 ++-- sources/platform/integrations/index.mdx | 1 + static/img/platform/integrations/opencode-white.svg | 1 + static/img/platform/integrations/opencode.svg | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 static/img/platform/integrations/opencode-white.svg diff --git a/sources/platform/integrations/ai/opencode.md b/sources/platform/integrations/ai/opencode.md index ce2c21d058..19a21612e5 100644 --- a/sources/platform/integrations/ai/opencode.md +++ b/sources/platform/integrations/ai/opencode.md @@ -9,7 +9,7 @@ import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integrati [OpenCode](https://opencode.ai) is an open-source AI coding agent that runs in your terminal. It reads and edits your codebase, runs commands, and completes multi-step development tasks. -The [Apify plugin for OpenCode](https://www.npmjs.com/package/opencode-apify) connects OpenCode to Apify's library of [Actors](https://apify.com/store) by bundling the [Apify MCP server](/platform/integrations/mcp) for searching the Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). +The [Apify plugin for OpenCode](https://www.npmjs.com/package/opencode-apify) connects OpenCode to Apify's library of [Actors](https://apify.com/store) by bundling the [Apify MCP server](/platform/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). @@ -39,7 +39,7 @@ Alternatively, add the plugin to your `opencode.json`: ## Authenticate to Apify -The plugin bundles the Apify MCP server. Read-only tools like searching the Store and fetching Actor details work without signing in, but you need to authenticate to run Actors and access your account data. +The plugin bundles the Apify MCP server. Read-only tools like searching Apify Store and fetching Actor details work without signing in, but you need to authenticate to run Actors and access your account data. 1. List the configured MCP servers: diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index f512720267..6d596f97e7 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -127,6 +127,7 @@ Plug Apify Actors into the AI stack - chat clients like Claude and ChatGPT via t desc="Install the Apify plugin in OpenCode to discover, run, and build Actors from the coding agent." to="/platform/integrations/opencode" imageUrl="/img/platform/integrations/opencode.svg" + imageUrlDarkTheme="/img/platform/integrations/opencode-white.svg" smallImage /> diff --git a/static/img/platform/integrations/opencode-white.svg b/static/img/platform/integrations/opencode-white.svg new file mode 100644 index 0000000000..b79c7332e2 --- /dev/null +++ b/static/img/platform/integrations/opencode-white.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/static/img/platform/integrations/opencode.svg b/static/img/platform/integrations/opencode.svg index b79c7332e2..b79140a507 100644 --- a/static/img/platform/integrations/opencode.svg +++ b/static/img/platform/integrations/opencode.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file