diff --git a/sources/platform/integrations/ai/github-copilot.md b/sources/platform/integrations/ai/github-copilot.md deleted file mode 100644 index 4f8b3a5f8c..0000000000 --- a/sources/platform/integrations/ai/github-copilot.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -title: GitHub Copilot integration -sidebar_label: GitHub Copilot -description: Learn how to install the Apify plugin for GitHub Copilot in VS Code to discover, run, and build Actors with the Apify MCP server, skills, and a routing agent. -slug: /integrations/github-copilot ---- - -import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; - -[GitHub Copilot](https://github.com/features/copilot) is GitHub's AI coding assistant. In VS Code, its agent mode reads and edits your workspace, runs commands, and completes multi-step development tasks. - -The [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) connects Copilot to Apify's library of [Actors](https://apify.com/store) and bundles: - -- The [Apify MCP server](/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). -- An `apify` routing agent that picks the right tool or skill from a natural-language request. -- Five built-in skills for common workflows (see [Bundled skills](#bundled-skills) below). - -This guide covers setup in VS Code. - - - -## Prerequisites - -- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. -- [VS Code](https://code.visualstudio.com/) version 1.120 or newer, with the [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extension installed and signed in with Copilot access. - -## Install the plugin - -Install the plugin directly from its GitHub repository - there's no need to clone it. - -1. Copy the plugin repository URL: - - ```text - https://github.com/apify/apify-github-copilot-plugin - ``` - -1. In VS Code, open the Command Palette (`Ctrl+Shift+P`, or `Cmd+Shift+P` on macOS) and run **Chat: Install Plugin from Source**. - - ![VS Code Command Palette with the Chat: Install Plugin from Source command selected](images/github-copilot/install-plugin-command.webp) - -1. Paste the repository URL into the input field and press Enter. - - ![VS Code input field with the Apify plugin repository URL pasted in](images/github-copilot/install-plugin-url.webp) - -1. In the trust dialog, review the source and select **Trust**. - - ![VS Code dialog asking whether to trust plugins from the Apify repository](images/github-copilot/install-plugin-trust.webp) - -1. VS Code installs the plugin and opens the **Plugin: apify** panel, which shows **Disable** and **Uninstall** actions. You can reopen it anytime from the Command Palette (`Ctrl+Shift+P`, or `Cmd+Shift+P` on macOS) with **Chat: Plugins**, which lists your installed agent plugins. - - ![VS Code Plugin: apify panel open over the Agent Plugins list, showing the installed Apify plugin](images/github-copilot/plugin-installed.webp) - -1. Open Copilot Chat, open the mode picker, and select the **apify** agent. - - ![Copilot Chat mode picker with the apify agent selected](images/github-copilot/agent-picker.webp) - -## Connect the Apify MCP server - -The plugin bundles the Apify MCP server (`https://mcp.apify.com/`) - its configuration ships in the plugin's `.mcp.json`, so you don't add it manually. 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. Open the tools picker in Copilot Chat and confirm that **Apify MCP Server** is selected for the `apify` agent. - - ![Configure Tools dialog with Apify MCP Server enabled for the apify agent](images/github-copilot/configure-tools.webp) - -1. Open the plugin's `.mcp.json`. A **Start** action appears above the `apify-mcp-server` entry - select it to start the server. - - ![Bundled .mcp.json with the Start action above the apify-mcp-server entry](images/github-copilot/mcp-start.webp) - -1. VS Code prompts that the MCP server wants to authenticate to `console-backend.apify.com`. Select **Allow**, complete the Apify OAuth flow in your browser, and choose the account to connect. - - ![VS Code dialog asking to allow the apify-mcp-server to authenticate to console-backend.apify.com](images/github-copilot/mcp-oauth-allow.webp) - -1. The `apify-mcp-server` entry shows **Running** and exposes its tools. - - ![Bundled .mcp.json showing the apify-mcp-server as Running with Stop and Restart actions](images/github-copilot/mcp-running.webp) - -:::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 - -Select the **apify** agent and describe what you want in natural language. The agent routes the request to the right tool or skill, 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. - -The agent 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. - -To check what's available, ask the agent to list its Apify tools. - -![Copilot Chat listing the available Apify MCP tools](images/github-copilot/verify-tools.webp) - -## Bundled skills - -| Skill | Description | -| --- | --- | -| `apify-ultimate-scraper` | CLI-driven extraction using existing Actors for multi-step scraping and lead-generation workflows. | -| `apify-actor-development` | Full Actor lifecycle - template selection, development, local testing, and deployment with `apify push`. | -| `apify-actorization` | Converts existing JavaScript, TypeScript, Python, or CLI projects into Apify Actors. | -| `apify-generate-output-schema` | Generates dataset and key-value store schemas for existing Actors. | -| `apify-sdk-integration` | Integrates Actor execution into applications using the `apify-client` package. | - -Example prompts that route to specific skills: - -_Ultimate scraper:_ - -> Find 10 highly rated coffee shops in Seattle with name, address, rating, phone, and website. - -_Actor development:_ - -> Create an Apify Actor that accepts a `startUrl` and `maxPages` input, crawls the site, and stores each page title and URL. - -_SDK integration:_ - -> Add Apify to this project. The Node.js API route should run an Actor and return dataset items as JSON. - -## Authentication paths - -The `apify` agent uses the transport that fits the task, and each one authenticates differently: - -- For MCP tools (search, run, retrieve data), authenticate with OAuth through the browser, as described in [Connect the Apify MCP server](#connect-the-apify-mcp-server). No token setup is needed. -- For the Apify CLI (building Actors, actorization, CLI fallback), run `apify login` once, or set `APIFY_TOKEN` in headless environments. Get your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). -- For SDK integration with `apify-client`, set the `APIFY_TOKEN` environment variable in your application's environment. - -## Troubleshooting - -### The `apify` agent doesn't appear in the picker - -Confirm that the plugin is installed and trusted (rerun **Chat: Install Plugin from Source** if needed), that **Chat: Plugins** is enabled in Settings, and that you reloaded the window after installing. Plugin support requires VS Code 1.120 or newer. - -### The Apify MCP server won't start - -Open the plugin's `.mcp.json` and select the **Start** action above the `apify-mcp-server` entry, then complete the **Allow** prompt and account selection. Check the **Output** panel (**MCP: apify-mcp-server**) - a successful start ends with a line about the discovered tools. Confirm the **Apify MCP Server** tool is enabled for the `apify` agent in the tools picker. - -### Browser doesn't open, or OAuth fails - -If the browser doesn't open automatically, copy the OAuth URL from the VS Code dialog and paste it into your browser manually. - -If you're running VS Code over SSH, in a dev container, or in any environment without a browser, the MCP OAuth flow can't complete. Authenticate locally first so the connection is stored, or use the CLI and SDK paths instead - run `apify login`, or set `APIFY_TOKEN`: - -```bash -export APIFY_TOKEN= -``` - -### The agent picks the wrong skill or transport - -Start from the **apify** agent. It is the single entry point that detects the available transport and routes each request to the correct tool or skill. - -## Limitations - -- Copilot plugin support is a preview feature in VS Code, so its settings and behavior may change between releases. -- The plugin is installed from its GitHub repository URL; it isn't published to a plugin marketplace yet. -- 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 usage on the Apify platform from your plan in addition to any Copilot usage. See the [Apify billing documentation](/account/billing) for details. -- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing. - -## Related integrations - -- [Claude Code CLI integration](/integrations/claude-code-cli) - Install the Apify plugin in the Claude Code CLI -- [MCP server integration](/integrations/mcp) - Use the Apify MCP server with other clients - -## Resources - -- [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) - Source repository and full README with advanced setup notes -- [GitHub Copilot documentation](https://docs.github.com/en/copilot) - Official GitHub Copilot docs -- [Apify MCP server documentation](/integrations/mcp) - Connect the Apify MCP server to other clients -- [Apify Store](https://apify.com/store) - Browse Actors you can run from Copilot diff --git a/sources/platform/integrations/ai/github-copilot/_category_.yml b/sources/platform/integrations/ai/github-copilot/_category_.yml new file mode 100644 index 0000000000..e59df0d5b6 --- /dev/null +++ b/sources/platform/integrations/ai/github-copilot/_category_.yml @@ -0,0 +1 @@ +label: 'GitHub Copilot' diff --git a/sources/platform/integrations/ai/github-copilot/github-copilot-cli.md b/sources/platform/integrations/ai/github-copilot/github-copilot-cli.md new file mode 100644 index 0000000000..e56f507759 --- /dev/null +++ b/sources/platform/integrations/ai/github-copilot/github-copilot-cli.md @@ -0,0 +1,159 @@ +--- +title: GitHub Copilot CLI integration +sidebar_label: GitHub Copilot CLI +description: Learn how to install the Apify plugin for the GitHub Copilot CLI to discover, run, and build Actors with the Apify MCP server, skills, and a routing agent. +slug: /integrations/github-copilot-cli +--- + +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; + +The [GitHub Copilot CLI](https://docs.github.com/en/copilot/concepts/agents/copilot-cli) is GitHub's agentic coding tool that runs in your terminal. It reads and edits your codebase, runs commands, and completes multi-step development tasks. + +The [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) connects Copilot to Apify's library of [Actors](https://apify.com/store) and bundles: + +- The [Apify MCP server](/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets. +- An `apify` routing agent that picks the right tool or skill based on your prompt. +- [Five built-in skills](#bundled-skills) for common workflows. + +This guide covers installation in the GitHub Copilot CLI. + + + +## Prerequisites + +- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. +- [The GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) - installed and signed in. + +## Install the plugin and sign in + +The plugin lives in an Apify marketplace that you add to Copilot with a repository URL. The CLI doesn't register that marketplace by default, so add it before you install - unlike [Visual Studio Code (VS Code)](/integrations/vscode) and the [desktop app](/integrations/github-copilot-desktop), which find the plugin in a marketplace they already know about. Installing the plugin also sets up the bundled Apify MCP server and signs you in, so there's no separate authentication step. 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. In a Copilot session, add the Apify marketplace: + + ```text + /plugin marketplace add https://github.com/apify/apify-github-copilot-plugin + ``` + + Copilot confirms with `Marketplace "apify" added successfully`. + +1. Install the `apify` plugin from the marketplace: + + ```text + /plugin install apify@apify + ``` + + This installs the plugin, its five [bundled skills](#bundled-skills), and the bundled Apify MCP server (`https://mcp.apify.com/`). Copilot usually opens a browser tab for the Apify sign-in automatically once the install finishes. + +1. Complete the Apify OAuth flow in your browser and choose the account to connect. The browser confirms the authorization, and back in the terminal `apify-mcp-server` shows as connected. + + ![GitHub Copilot CLI reporting the apify plugin installed with five skills and apify-mcp-server connected](images/github-copilot-cli/03-authorization-successful.webp) + + On the first start, Copilot may report that `apify-mcp-server` is taking longer than expected to connect, then that it gave up waiting. The server usually finishes connecting a moment later and logs `MCP server 'apify-mcp-server' connected`, so no action is needed. + + If no browser tab opens, or the server never connects, connect it yourself with the [manual steps](#connect-the-mcp-server-manually) below. + +:::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). + +::: + +## Connect the MCP server manually + +If no browser tab opened during installation, or `apify-mcp-server` shows as disconnected, authenticate it from the MCP server manager. + +1. Run `/mcp` to open the MCP server manager, select `apify-mcp-server` under **Plugins**, and press Enter to show its details. + +1. The detail view shows the `http` type and the `https://mcp.apify.com/` URL. Press r to authenticate. + +1. Copilot opens a browser tab for the Apify OAuth flow. If the browser doesn't open, copy the URL shown in the terminal and open it manually. + +1. Complete the OAuth flow and choose the account to connect. Back in the terminal, Copilot confirms `Successfully authenticated with apify-mcp-server`. Press Enter to continue. + +1. Run `/mcp` again to confirm `apify-mcp-server` is connected and enabled. Use Space to enable or disable it. + +## Run your first prompt + +Describe what you want in plain language. + +> 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. + +The agent searches Apify Store, fetches the top Actor's details, and summarizes its inputs, pricing, and output - without running the Actor. + +To check what's available, ask the agent to list its Apify tools. + +![GitHub Copilot CLI listing the available Apify MCP tools and skills](images/github-copilot-cli/09-list-tools.webp) + +## Bundled skills + +| Skill | Description | +| --- | --- | +| `apify-ultimate-scraper` | CLI-driven extraction using existing Actors for multi-step scraping and lead-generation workflows. | +| `apify-actor-development` | Full Actor lifecycle - template selection, development, local testing, and deployment with `apify push`. | +| `apify-actorization` | Converts existing JavaScript, TypeScript, Python, or CLI projects into Apify Actors. | +| `apify-generate-output-schema` | Generates dataset and key-value store schemas for existing Actors. | +| `apify-sdk-integration` | Integrates Actor execution into applications using the `apify-client` package. | + +Example prompts that route to specific skills: + +_Ultimate scraper:_ + +> Find 10 highly rated coffee shops in Seattle with name, address, rating, phone, and website. + +_Actor development:_ + +> Create an Apify Actor that accepts a `startUrl` and `maxPages` input, crawls the site, and stores each page title and URL. + +_SDK integration:_ + +> Add Apify to this project. The Node.js API route should run an Actor and return dataset items as JSON. + +## Authentication paths + +The `apify` agent picks the right transport for each task. Each transport authenticates differently: + +- For MCP tools (search, run, retrieve data), authenticate with OAuth through the browser, as described in [Install the plugin and sign in](#install-the-plugin-and-sign-in). You don't need to set up a token. +- For the Apify CLI (building Actors, actorization, CLI fallback), run `apify login` once, or set `APIFY_TOKEN` in headless environments. Get your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). +- For SDK integration with `apify-client`, set the `APIFY_TOKEN` environment variable in your application's environment. + +## Troubleshooting + +### The `apify` plugin isn't installed + +Run `/plugin marketplace add https://github.com/apify/apify-github-copilot-plugin` to add the marketplace, then `/plugin install apify@apify` to install the plugin. Confirm the marketplace was added with `/plugin marketplace browse apify`. + +### The Apify MCP server won't authenticate + +Installation normally signs you in automatically. If the browser prompt didn't appear or you skipped it, connect the server manually: run `/mcp`, select `apify-mcp-server`, and choose to authenticate, as described in [Connect the MCP server manually](#connect-the-mcp-server-manually). Read-only tools work without signing in, so run a search prompt first to confirm the server is connected. + +### 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 the CLI 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 the CLI: + +```bash +export APIFY_TOKEN= +``` + +### The agent picks the wrong skill or transport + +Start from the `apify` agent. It automatically detects the right transport and routes your request. + +## Limitations + +- Long-running Actors may time out during a single tool call. Reduce the scope or split the work across multiple prompts. +- Each Actor run counts toward your Apify plan usage in addition to any Copilot usage. See [Billing](/account/billing) for details. +- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing. + +## Related integrations + +- [VS Code integration](/integrations/vscode) - Install the same plugin from the VS Code plugin marketplace +- [GitHub Copilot desktop app integration](/integrations/github-copilot-desktop) - Install the Apify plugin in the GitHub Copilot desktop app +- [MCP server integration](/integrations/mcp) - Use the Apify MCP server with other clients + +## Resources + +- [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) - Source repository and full README with advanced setup notes +- [GitHub Copilot CLI documentation](https://docs.github.com/en/copilot/concepts/agents/copilot-cli) - Official GitHub Copilot CLI docs +- [Apify Store](https://apify.com/store) - Browse Actors you can run from Copilot diff --git a/sources/platform/integrations/ai/github-copilot/github-copilot-desktop.md b/sources/platform/integrations/ai/github-copilot/github-copilot-desktop.md new file mode 100644 index 0000000000..f57db4c989 --- /dev/null +++ b/sources/platform/integrations/ai/github-copilot/github-copilot-desktop.md @@ -0,0 +1,145 @@ +--- +title: GitHub Copilot desktop app integration +sidebar_label: GitHub Copilot desktop app +description: Learn how to install the Apify plugin in the GitHub Copilot desktop app to discover, run, and build Actors with the Apify MCP server and skills. +slug: /integrations/github-copilot-desktop +--- + +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; + +The [GitHub Copilot desktop app](https://github.com/features/ai/github-app) is GitHub's standalone Copilot client. It runs agentic coding sessions in a chat interface, connects to your repositories, and supports plugins, skills, and Model Context Protocol (MCP) servers. + +The [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) connects Copilot to Apify's library of [Actors](https://apify.com/store) and bundles: + +- The [Apify MCP server](/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets. +- An `apify` routing agent that picks the right tool or skill based on your prompt. +- [Five built-in skills](#bundled-skills) for common workflows. + +This guide covers installation in the GitHub Copilot desktop app. + + + +## Prerequisites + +- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. +- The [GitHub Copilot desktop app](https://github.com/features/ai/github-app) - installed and signed in. + +## Install the plugin + +1. Open **Settings**. + +1. Select the **Plugins** tab. + +1. Search for `Apify`. The `apify` plugin appears in the results, under the `awesome-copilot` marketplace. + +1. Select **Install**. + + ![GitHub Copilot desktop app Plugins settings with the apify plugin in the search results](images/github-copilot-desktop/01-plugins-search-install.webp) + +1. The plugin appears under **Installed** with its toggle enabled. + +## Connect the Apify MCP server + +The plugin connects to the Apify MCP server (`https://mcp.apify.com/`) using HTTP transport. Read-only tools like searching Apify Store and fetching Actor details work without signing in. To run Actors and access your account data, you need to authenticate. + +1. Open **Settings**, select the **MCP servers** tab, and find `apify-mcp-server` with the `HTTP` transport. Select **Sign in**. + + ![GitHub Copilot desktop app MCP servers settings with the apify-mcp-server Sign in button](images/github-copilot-desktop/03-mcp-server-signin.webp) + +1. Complete the Apify OAuth flow in your browser and choose the account to connect. The browser confirms the authorization and prompts you to return to the desktop app. + +:::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). + +::: + +## Select the `apify` agent + +Open the agent picker in the chat composer and select the `apify` agent. + +![GitHub Copilot desktop app agent picker with the apify agent available](images/github-copilot-desktop/05-agent-picker.webp) + +## Run your first prompt + +With the `apify` agent selected, describe what you want in plain language. + +> 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. + +The agent searches Apify Store, fetches the top Actor's details, and summarizes its inputs, pricing, and output - without running the Actor. + +To check what's available, ask the agent to list what it can do with the Apify plugin. It replies with the tools it can call and the skill behind each workflow. + +## Bundled skills + +| Skill | Description | +| --- | --- | +| `apify-ultimate-scraper` | CLI-driven extraction using existing Actors for multi-step scraping and lead-generation workflows. | +| `apify-actor-development` | Full Actor lifecycle - template selection, development, local testing, and deployment with `apify push`. | +| `apify-actorization` | Converts existing JavaScript, TypeScript, Python, or CLI projects into Apify Actors. | +| `apify-generate-output-schema` | Generates dataset and key-value store schemas for existing Actors. | +| `apify-sdk-integration` | Integrates Actor execution into applications using the `apify-client` package. | + +Example prompts that route to specific skills: + +_Ultimate scraper:_ + +> Find 10 highly rated coffee shops in Seattle with name, address, rating, phone, and website. + +_Actor development:_ + +> Create an Apify Actor that accepts a `startUrl` and `maxPages` input, crawls the site, and stores each page title and URL. + +_SDK integration:_ + +> Add Apify to this project. The Node.js API route should run an Actor and return dataset items as JSON. + +## Authentication paths + +The `apify` agent picks the right transport for each task. Each transport authenticates differently: + +- For MCP tools (search, run, retrieve data), authenticate with OAuth through the browser, as described in [Connect the Apify MCP server](#connect-the-apify-mcp-server). You don't need to set up a token. +- For the Apify CLI (building Actors, actorization, CLI fallback), run `apify login` once, or set `APIFY_TOKEN` in headless environments. Get your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). +- For SDK integration with `apify-client`, set the `APIFY_TOKEN` environment variable in your application's environment. + +## Troubleshooting + +### The `apify` plugin doesn't appear in search + +If the `apify` plugin doesn't appear when you search for `Apify`: + +1. Quit the desktop app, reopen it, and search again. + +1. If the plugin still doesn't appear, add its marketplace manually. Open **Settings > Plugins**, select **Install > Add marketplace**, and enter the repository URL: + + ```text + https://github.com/apify/apify-github-copilot-plugin + ``` + + The `apify` plugin then appears in the **Plugins** list. Select **Install** and continue with [Connect the Apify MCP server](#connect-the-apify-mcp-server). + +### The Apify MCP server won't sign in + +Open **Settings > MCP servers**, confirm `apify-mcp-server` uses the `HTTP` transport, and select **Sign in** to restart the OAuth flow. Read-only tools work without signing in, so run a search prompt first to confirm the server is connected. + +### The `apify` agent isn't available + +Confirm the plugin is installed and enabled under **Settings > Plugins**, then reopen the agent picker in the chat composer. The `apify` agent appears once the plugin is active. + +## Limitations + +- Long-running Actors may time out during a single tool call. Reduce the scope or split the work across multiple prompts. +- Each Actor run counts toward your Apify plan usage in addition to any Copilot usage. See [Billing](/account/billing) for details. +- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing. + +## Related integrations + +- [Visual Studio Code (VS Code) integration](/integrations/vscode) - Install the same plugin from the VS Code plugin marketplace +- [GitHub Copilot CLI integration](/integrations/github-copilot-cli) - Install the Apify plugin in the GitHub Copilot CLI +- [MCP server integration](/integrations/mcp) - Use the Apify MCP server with other clients + +## Resources + +- [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) - Source repository and full README with advanced setup notes +- [GitHub Copilot documentation](https://docs.github.com/en/copilot) - Official GitHub Copilot docs +- [Apify Store](https://apify.com/store) - Browse Actors you can run from Copilot diff --git a/sources/platform/integrations/ai/github-copilot/images/github-copilot-cli/03-authorization-successful.webp b/sources/platform/integrations/ai/github-copilot/images/github-copilot-cli/03-authorization-successful.webp new file mode 100644 index 0000000000..ba37e3d0d1 Binary files /dev/null and b/sources/platform/integrations/ai/github-copilot/images/github-copilot-cli/03-authorization-successful.webp differ diff --git a/sources/platform/integrations/ai/github-copilot/images/github-copilot-cli/09-list-tools.webp b/sources/platform/integrations/ai/github-copilot/images/github-copilot-cli/09-list-tools.webp new file mode 100644 index 0000000000..d9c1f24e15 Binary files /dev/null and b/sources/platform/integrations/ai/github-copilot/images/github-copilot-cli/09-list-tools.webp differ diff --git a/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/01-plugins-search-install.webp b/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/01-plugins-search-install.webp new file mode 100644 index 0000000000..6c35c69f3e Binary files /dev/null and b/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/01-plugins-search-install.webp differ diff --git a/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/03-mcp-server-signin.webp b/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/03-mcp-server-signin.webp new file mode 100644 index 0000000000..6aebe84b46 Binary files /dev/null and b/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/03-mcp-server-signin.webp differ diff --git a/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/05-agent-picker.webp b/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/05-agent-picker.webp new file mode 100644 index 0000000000..cc11493489 Binary files /dev/null and b/sources/platform/integrations/ai/github-copilot/images/github-copilot-desktop/05-agent-picker.webp differ diff --git a/sources/platform/integrations/ai/github-copilot/index.mdx b/sources/platform/integrations/ai/github-copilot/index.mdx new file mode 100644 index 0000000000..66b62f56f8 --- /dev/null +++ b/sources/platform/integrations/ai/github-copilot/index.mdx @@ -0,0 +1,40 @@ +--- +title: GitHub Copilot +description: Use Apify Actors with GitHub Copilot - install the Apify plugin in the GitHub Copilot CLI or the GitHub Copilot desktop app to discover, run, and build Actors. +sidebar_label: GitHub Copilot +slug: /integrations/github-copilot +--- + +import Card from '@site/src/components/Card'; +import CardGrid from '@site/src/components/CardGrid'; + +The [Apify plugin for GitHub Copilot](https://github.com/apify/apify-github-copilot-plugin) connects [GitHub Copilot](https://github.com/features/copilot) to Apify's library of [Actors](https://apify.com/store). It bundles the Apify MCP server, an `apify` routing agent, and skills for common scraping and Actor-building workflows. Install it in the GitHub Copilot CLI or the GitHub Copilot desktop app - or in [Visual Studio Code (VS Code)](/integrations/vscode), which supports the same plugin through its own agent-plugin marketplace. + +## What you can build + + + + + + diff --git a/sources/platform/integrations/ai/images/github-copilot/agent-picker.webp b/sources/platform/integrations/ai/images/github-copilot/agent-picker.webp deleted file mode 100644 index 790854573f..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/agent-picker.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/configure-tools.webp b/sources/platform/integrations/ai/images/github-copilot/configure-tools.webp deleted file mode 100644 index 27977429d9..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/configure-tools.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/install-plugin-command.webp b/sources/platform/integrations/ai/images/github-copilot/install-plugin-command.webp deleted file mode 100644 index 6f151c7a86..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/install-plugin-command.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/install-plugin-trust.webp b/sources/platform/integrations/ai/images/github-copilot/install-plugin-trust.webp deleted file mode 100644 index 5ef0367e72..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/install-plugin-trust.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/install-plugin-url.webp b/sources/platform/integrations/ai/images/github-copilot/install-plugin-url.webp deleted file mode 100644 index cbe0c773b9..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/install-plugin-url.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/mcp-oauth-allow.webp b/sources/platform/integrations/ai/images/github-copilot/mcp-oauth-allow.webp deleted file mode 100644 index f80bbba6ba..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/mcp-oauth-allow.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/mcp-running.webp b/sources/platform/integrations/ai/images/github-copilot/mcp-running.webp deleted file mode 100644 index d08914716e..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/mcp-running.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/mcp-start.webp b/sources/platform/integrations/ai/images/github-copilot/mcp-start.webp deleted file mode 100644 index b003f35a75..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/mcp-start.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/plugin-installed.webp b/sources/platform/integrations/ai/images/github-copilot/plugin-installed.webp deleted file mode 100644 index d95770d2fc..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/plugin-installed.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/images/github-copilot/verify-tools.webp b/sources/platform/integrations/ai/images/github-copilot/verify-tools.webp deleted file mode 100644 index 2673d78fe0..0000000000 Binary files a/sources/platform/integrations/ai/images/github-copilot/verify-tools.webp and /dev/null differ diff --git a/sources/platform/integrations/ai/index.mdx b/sources/platform/integrations/ai/index.mdx index a48316cd05..eb7954de71 100644 --- a/sources/platform/integrations/ai/index.mdx +++ b/sources/platform/integrations/ai/index.mdx @@ -151,15 +151,31 @@ Chat and coding assistants you connect to Apify through the Apify MCP server or smallImage /> + + ## By provider -See everything for a provider on one page: the [OpenAI hub](/integrations/openai) (ChatGPT, Codex, Agents SDK) and the [Claude hub](/integrations/claude) (Claude Desktop, Claude Code CLI). +See everything for a provider on one page: the [OpenAI hub](/integrations/openai) (ChatGPT, Codex, Agents SDK), the [Claude hub](/integrations/claude) (Claude Desktop, Claude Code CLI), and the [GitHub Copilot hub](/integrations/github-copilot) (GitHub Copilot CLI, desktop app). diff --git a/sources/platform/integrations/ai/vscode.md b/sources/platform/integrations/ai/vscode.md new file mode 100644 index 0000000000..b80a104fa6 --- /dev/null +++ b/sources/platform/integrations/ai/vscode.md @@ -0,0 +1,163 @@ +--- +title: VS Code integration +sidebar_label: VS Code +description: Learn how to install the Apify agent plugin in VS Code to discover, run, and build Actors with the Apify MCP server, bundled skills, and a routing agent. +slug: /integrations/vscode +--- + +import ThirdPartyDisclaimer from '@site/sources/_partials/_third-party-integration.mdx'; + +[Visual Studio Code (VS Code)](https://code.visualstudio.com/) is Microsoft's code editor. Its [agent plugins](https://code.visualstudio.com/docs/agent-customization/agent-plugins) are prepackaged bundles of agent customizations - skills, agents, and MCP servers - that you install from a plugin marketplace and use in chat. + +The [Apify plugin](https://github.com/apify/apify-github-copilot-plugin) is published in the [Awesome Copilot](https://awesome-copilot.github.com/plugins) marketplace, which VS Code registers by default. It connects VS Code to Apify's library of [Actors](https://apify.com/store) and bundles: + +- The [Apify MCP server](/integrations/mcp) for searching Apify Store, running Actors, and retrieving datasets through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro). +- An `apify` routing agent that picks the right tool or skill from a natural-language request. +- Five built-in skills for common workflows (see [Bundled skills](#bundled-skills) below). + +This guide covers installation from the plugin marketplace in VS Code. It's the same plugin that powers the [GitHub Copilot CLI](/integrations/github-copilot-cli) and the [GitHub Copilot desktop app](/integrations/github-copilot-desktop) - install it once per client you use. + + + +## Prerequisites + +- [An Apify account](https://console.apify.com/sign-up) - sign up for free if you don't have one. +- [VS Code](https://code.visualstudio.com/) version 1.120 or newer, with AI features enabled and signed in. +- Agent plugin support enabled - set `chat.plugins.enabled` to `true` in Settings. + +## Install the plugin + +1. Open the Extensions view (Ctrl + Shift + X, or Cmd + Shift + X on macOS) and enter `@agentPlugins` in the search field. Alternatively, run **Chat: Plugins** from the Command Palette (Ctrl + Shift + P, or Cmd + Shift + P on macOS). + +1. Find the **apify** plugin in the list. Type `apify` after the filter to narrow the results. The entry is labeled `github/awesome-copilot#marketplace`. + +1. Select **Install** on the **apify** entry. + +1. The first time you install a plugin from a marketplace, VS Code shows a trust prompt. Review the source and confirm. + +The installed plugin appears in the **Agent Plugins - Installed** section of the Extensions view. + +## Authenticate to Apify + +The plugin bundles the Apify MCP server (`https://mcp.apify.com/`), and VS Code starts it as soon as the plugin is enabled. 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. VS Code prompts that the MCP server wants to authenticate to `console-backend.apify.com`. Select **Allow**. + +1. Complete the Apify OAuth flow in your browser and choose the account to connect. + +1. Run **MCP: List Servers** from the Command Palette and confirm that `apify-mcp-server` is running. + +:::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 + +Open Chat, select the **apify** agent from the mode picker, and describe what you want in natural language. The agent routes the request to the right tool or skill, 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. + +The agent 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. + +To check what's available, ask the agent to list its Apify tools. + +## Bundled skills + +| Skill | Description | +| --- | --- | +| `apify-ultimate-scraper` | CLI-driven extraction using existing Actors for multi-step scraping and lead-generation workflows. | +| `apify-actor-development` | Full Actor lifecycle - template selection, development, local testing, and deployment with `apify push`. | +| `apify-actorization` | Converts existing JavaScript, TypeScript, Python, or CLI projects into Apify Actors. | +| `apify-generate-output-schema` | Generates dataset and key-value store schemas for existing Actors. | +| `apify-sdk-integration` | Integrates Actor execution into applications using the `apify-client` package. | + +Example prompts that route to specific skills: + +_Ultimate scraper:_ + +> Find 10 highly rated coffee shops in Seattle with name, address, rating, phone, and website. + +_Actor development:_ + +> Create an Apify Actor that accepts a `startUrl` and `maxPages` input, crawls the site, and stores each page title and URL. + +_SDK integration:_ + +> Add Apify to this project. The Node.js API route should run an Actor and return dataset items as JSON. + +## Authentication paths + +The `apify` agent picks the right transport for each task. Each transport authenticates differently: + +- For MCP tools (search, run, retrieve data), authenticate with OAuth through the browser, as described in [Authenticate to Apify](#authenticate-to-apify). You don't need to set up a token. +- For the Apify CLI (building Actors, actorization, CLI fallback), run `apify login` once, or set `APIFY_TOKEN` in headless environments. Get your token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations). +- For SDK integration with `apify-client`, set the `APIFY_TOKEN` environment variable in your application's environment. + +## Manage the plugin + +- To update the plugin, run **Extensions: Check for Extension Updates** from the Command Palette. VS Code also checks every 24 hours when `extensions.autoUpdate` is enabled. +- To enable or disable the plugin, use its context menu in the **Agent Plugins - Installed** section of the Extensions view. Disabling it stops the bundled MCP server and hides the `apify` agent and skills from chat. You can disable it globally or for a single workspace. +- To remove the plugin, right-click it in **Agent Plugins - Installed** and select **Uninstall**. + +## Troubleshooting + +### The `apify` plugin doesn't appear in the list + +Confirm that `chat.plugins.enabled` is set to `true` and that you're running VS Code 1.120 or newer. If you overrode the `chat.plugins.marketplaces` setting, restore both marketplaces that VS Code registers by default: + +```json5 +// settings.json +"chat.plugins.marketplaces": [ + "github/awesome-copilot", + "github/copilot-plugins" +] +``` + +### The Apify MCP server doesn't start + +Run **MCP: List Servers** from the Command Palette, select `apify-mcp-server`, and start or restart it. Check the **Output** panel (**MCP: apify-mcp-server**) - a successful start ends with a line about the discovered tools. In Chat, open **Configure Tools** and confirm that **Apify MCP Server** is enabled for the `apify` agent. + +### Browser doesn't open, or OAuth fails + +If the browser doesn't open automatically, copy the OAuth URL from the VS Code dialog and paste it into your browser manually. + +If you're running VS Code over SSH, in a dev container, or in any environment without a browser, the MCP OAuth flow can't complete. Authenticate locally first so the connection is stored, or use the Apify CLI and SDK paths instead - run `apify login`, or set `APIFY_TOKEN` with a token from [Apify Console > Settings > Integrations](https://console.apify.com/settings/integrations): + +```bash +export APIFY_TOKEN= +``` + +### Installation fails with "destination path already exists" + +A previous install left a cached copy of the plugin. Delete the cached directory and install again: + +- macOS: `~/Library/Application Support/Code/agentPlugins/github.com/apify/apify-github-copilot-plugin` +- Linux: `~/.config/Code/agentPlugins/github.com/apify/apify-github-copilot-plugin` +- Windows: `%APPDATA%\Code\agentPlugins\github.com\apify\apify-github-copilot-plugin` + +### The agent picks the wrong skill or transport + +Start from the **apify** agent. It is the single entry point that detects the available transport and routes each request to the correct tool or skill. + +## 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 VS Code usage. See [Billing](/account/billing) for details. +- Skills that edit files in your project (Actor development, actorization, SDK integration) make local changes - review them before deploying or committing. + +## Related integrations + +- [GitHub Copilot hub](/integrations/github-copilot) - Every client that runs the Apify plugin for GitHub Copilot +- [GitHub Copilot CLI integration](/integrations/github-copilot-cli) - Install the same plugin in your terminal +- [GitHub Copilot desktop app integration](/integrations/github-copilot-desktop) - Install the same plugin in the desktop app +- [Cursor integration](/integrations/cursor) - Install the Apify plugin in Cursor +- [MCP server integration](/integrations/mcp) - Use the Apify MCP server with other clients + +## Resources + +- [Apify plugin repository](https://github.com/apify/apify-github-copilot-plugin) - Source repository and full README with advanced setup notes +- [Agent plugins in VS Code](https://code.visualstudio.com/docs/agent-customization/agent-plugins) - Official VS Code documentation +- [Awesome Copilot plugin marketplace](https://awesome-copilot.github.com/plugins) - Browse the plugins VS Code registers by default +- [Apify Store](https://apify.com/store) - Browse Actors you can run from VS Code diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index 3a3978252e..e789d21495 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -88,7 +88,7 @@ Plug Apify Actors into the AI stack - chat clients like Claude and ChatGPT via t /> + [See all AI integrations →](/integrations/ai) diff --git a/static/img/platform/integrations/vscode-white.svg b/static/img/platform/integrations/vscode-white.svg new file mode 100644 index 0000000000..66699157dd --- /dev/null +++ b/static/img/platform/integrations/vscode-white.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/static/img/platform/integrations/vscode.svg b/static/img/platform/integrations/vscode.svg new file mode 100644 index 0000000000..c453e633f3 --- /dev/null +++ b/static/img/platform/integrations/vscode.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +