apify · daveomri · Aug 12, 2026 · Aug 17, 2026 · Aug 17, 2026 · Aug 17, 2026
@@ -0,0 +1 @@
+label: 'GitHub Copilot'
@@ -0,0 +1,174 @@
+---
+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.
+
+<ThirdPartyDisclaimer />
+
+## 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. Installing the plugin also sets up the bundled Apify MCP server and signs you in, so there's no separate authentication step.
+
+1. In a Copilot session, add the Apify marketplace:
+
+    ```text
+    /plugin marketplace add https://github.com/apify/apify-github-copilot-plugin
+    ```
+
+    ![GitHub Copilot CLI confirming the Apify marketplace was added](images/github-copilot-cli/01-marketplace-added.webp)
+
+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.
+
+    ![GitHub Copilot CLI installing the apify plugin, its skills, and the Apify MCP server](images/github-copilot-cli/02-plugin-install.webp)
+
+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.
+
+    ![Browser window confirming the Apify authorization was successful](images/github-copilot-cli/03-authorization-successful.webp)
+
+    If no browser tab opens, connect the server yourself with the [manual steps](#connect-the-mcp-server-manually) below.
+
+:::note Read-only access without signing in
+
+Read-only tools like searching Apify Store and fetching Actor details work without signing in. You only need to authenticate to run Actors and access your account data.
+
+:::
+
+:::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.
+
+    ![GitHub Copilot CLI MCP server list with apify-mcp-server selected](images/github-copilot-cli/04-mcp-server-list.webp)
+
+1. The detail view shows the `http` type and the `https://mcp.apify.com/` URL. Press `r` to authenticate.
+
+    ![GitHub Copilot CLI apify-mcp-server detail view with the authenticate action](images/github-copilot-cli/05-mcp-server-detail.webp)
+
+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.
+
+    ![GitHub Copilot CLI showing the Apify OAuth URL to open in a browser](images/github-copilot-cli/06-mcp-authenticating.webp)
+
+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.
+
+    ![GitHub Copilot CLI confirming successful authentication with apify-mcp-server](images/github-copilot-cli/07-mcp-authentication-successful.webp)
+
+1. Run `/mcp` again to confirm `apify-mcp-server` is connected and enabled. Use `space` to enable or disable it.
+
+    ![GitHub Copilot CLI MCP server list showing apify-mcp-server connected](images/github-copilot-cli/08-mcp-server-connected.webp)
+
+## 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=<YOUR_API_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
+
+- [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