diff --git a/.vscode/mcp.json b/.vscode/mcp.json new file mode 100644 index 0000000..9ed01e4 --- /dev/null +++ b/.vscode/mcp.json @@ -0,0 +1,8 @@ +{ + "servers": { + "apify": { + "type": "http", + "url": "https://mcp.apify.com/" + } + } +} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8ebb2df --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +All notable changes to the **Apify for GitHub Copilot** plugin are documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [1.0.0] — Initial GitHub Copilot release + +### Added +- `apify` agent (single user-facing entry point for all Apify requests). +- `apify-routing` instruction (soft enforcement of the agent-first pattern). +- `apify` MCP server entry in `.vscode/mcp.json` pointing to `https://mcp.apify.com/`. +- Skills: `apify-actor-development`, `apify-actorization`, `apify-generate-output-schema`, `apify-sdk-integration`, `apify-ultimate-scraper`. +- Bundled Node helper scripts for the ultimate-scraper skill (`search_actors.js`, `fetch_actor_details.js`, `run_actor.js`). +- Apache-2.0 license. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ce2a292 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 Apify Technologies s.r.o. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index 8b13789..8f7bb7b 100644 --- a/README.md +++ b/README.md @@ -1 +1,132 @@ +# Apify for GitHub Copilot +Official Apify plugin for GitHub Copilot — adds an `apify` agent, an Apify MCP server connection, a routing instruction, and a set of internal skills for three Apify workflows: using existing Actors from the Apify Store, building or actorizing custom Actors, and integrating Apify into existing applications. + +> **Apify** is a platform of thousands of serverless cloud programs called **Actors** for web scraping, browser automation, and data extraction. Learn more at [apify.com](https://apify.com). + +## What you get + +| Component | Name | Purpose | +|---|---|---| +| Agent (entry point) | `apify` | Routes each Apify request to the right MCP tool, CLI-based flow, or internal skill. **This is the one you should invoke.** | +| Routing rule | `apify-routing` | Tells Copilot to send Apify-related requests through the `apify` agent first instead of calling `apify-*` skills directly. | +| MCP server | `apify` (`https://mcp.apify.com/`) | Configured in `.vscode/mcp.json`; lets the agent search the Apify Store, fetch Actor details, run Actors, retrieve dataset items, and look up Apify docs when MCP is available. | +| Skill | `apify-actor-development` | Create, debug, test, and deploy a new Apify Actor from scratch. | +| Skill | `apify-actorization` | Convert an existing JavaScript, TypeScript, Python, or CLI-based project into an Apify Actor. | +| Skill | `apify-generate-output-schema` | Analyze an Actor and generate or update `dataset_schema.json`, `output_schema.json`, and `key_value_store_schema.json`. | +| Skill | `apify-sdk-integration` | Add Apify Actor execution to an existing application using the `apify-client` package or REST API. | +| Skill | `apify-ultimate-scraper` | Run Apify Store Actors for multi-step scraping workflows across 15+ platforms using the Apify CLI and bundled workflow references. | + +## Installation + +Clone (or copy) the plugin contents into your project repository so that the Copilot-specific directories end up in the right places: + +```bash +# Clone the plugin repo +git clone https://github.com/apify/apify-copilot-plugin /tmp/apify-copilot + +# Copy Copilot agent, skills, and instructions into .github/ +mkdir -p .github +cp -r /tmp/apify-copilot/agents .github/ +cp -r /tmp/apify-copilot/skills .github/ +cp -r /tmp/apify-copilot/instructions .github/ + +# Copy MCP server config into .vscode/ +mkdir -p .vscode +cp /tmp/apify-copilot/.vscode/mcp.json .vscode/mcp.json +``` + +After copying, reload VS Code (View → Command Palette → "Developer: Reload Window"). + +### Prerequisites + +- **VS Code** with the **GitHub Copilot Chat** extension installed and active. +- A GitHub account with Copilot access. + +## First-run setup + +The plugin supports multiple execution paths behind a single `@apify` entry point. The `apify` agent chooses the right route based on the request, and the required auth depends on that route. + +### Path 1 — Using existing Actors (MCP) + +For straightforward "search / inspect / run an Actor" tasks, the agent prefers the Apify MCP server when it is available. The first time the agent calls an MCP tool that needs auth (for example `run-actor`), VS Code opens `console.apify.com` in your browser and asks you to sign in. Read-only tools such as `search-actors`, `fetch-actor-details`, `search-apify-docs`, and `fetch-apify-docs` work without auth. + +If MCP is not available, the agent can fall back to the Apify CLI for Route 1 tasks, especially for the `apify-ultimate-scraper` skill. In that case, verify the CLI with `apify --help`, then authenticate with `apify login` or use an exported `APIFY_TOKEN` in headless environments. + +### Path 2 — Building Actors or integrating via SDK + +This path covers two different cases: + +- **Actor development / actorization** uses the Apify CLI (`apify create`, `apify init`, `apify run`, `apify push`). In interactive environments, the skills expect `apify login`; in headless environments, they can work with an exported `APIFY_TOKEN`. +- **Application integration** uses the **`apify-client`** package (or REST API) and requires an **`APIFY_TOKEN`** environment variable. Generate one at [console.apify.com/settings/integrations](https://console.apify.com/settings/integrations) and export it before starting VS Code (or add it to your project's `.env`): + +```bash +export APIFY_TOKEN="apify_api_xxxxxxxxxxxx" +``` + +Don't have an account? [Sign up free](https://console.apify.com/sign-up) — no credit card required. + +### Working in remote sessions, devcontainers, or SSH (no browser) + +The MCP OAuth flow needs a browser. If you're running VS Code over SSH, in a devcontainer, or in any environment where VS Code cannot open a browser, you have two options: + +1. **Authenticate locally first.** Connect the Apify MCP server once on your laptop with a normal VS Code session so the OAuth refresh token is stored in your profile, then reconnect remotely. +2. **Use the CLI / SDK paths instead.** The non-MCP flows (`apify-actor-development`, `apify-actorization`, `apify-sdk-integration`, and `apify-ultimate-scraper`) can work without MCP. Use `apify login` where a browser is available, or export `APIFY_TOKEN` for headless sessions. + +## How to use it + +Open Copilot Chat in VS Code and invoke the `apify` agent. The routing instruction is designed to keep all Apify requests going through that single entry point so the agent can choose the correct transport and skill. + +``` +@apify find me 5 well-rated coffee shops in Seattle and export to CSV +@apify build me an Actor that scrapes a sitemap and stores titles +@apify add Apify to this Next.js app so I can run a scraper from /api/scrape +@apify generate output schemas for the Actor in this folder +``` + +## Components reference + +### MCP server + +The `apify` MCP server is configured in `.vscode/mcp.json` and is the preferred Route 1 transport when it is available. The shipped agent expects the server to expose: + +- `search-actors` — search the Apify Store by keyword +- `fetch-actor-details` — Actor specs, input schema, and pricing +- `run-actor` — execute an Actor and return run metadata +- `get-dataset-items` — retrieve dataset rows from a previous run +- `search-apify-docs` / `fetch-apify-docs` — Apify documentation lookup + +You can disable or re-enable the server in **VS Code Settings → GitHub Copilot → MCP**. + +### Bundled scripts + +This Copilot package does **not** ship helper scripts under `skills/apify-ultimate-scraper/scripts/`. Instead, the `apify-ultimate-scraper` skill is documented as a CLI-driven workflow and ships markdown references under `skills/apify-ultimate-scraper/references/`, including: + +- `actor-index.md` — curated Actor selection guidance +- `gotchas.md` — common pitfalls and warnings +- `workflows/*.md` — playbooks for lead generation, competitive intelligence, brand monitoring, review analysis, SEO/content, and other multi-step use cases + +## Troubleshooting + +**OAuth browser never opens / hangs.** See the "Working in remote sessions" section above. + +**`APIFY_TOKEN not found` or CLI auth failures.** For CLI-based flows (`apify-ultimate-scraper`, `apify-actor-development`, `apify-actorization`), either log in with `apify login` or export `APIFY_TOKEN` before starting the session. For SDK integrations, `apify-client` expects `APIFY_TOKEN` to be available in the environment. + +**The wrong skill keeps getting picked.** That's exactly the problem the `apify` routing instruction and agent are designed to prevent — make sure you're starting with `@apify`. + +**`apify` vs `apify-client`** — these are two different npm packages. The `apify` package is the SDK for **building** Actors (used inside an Actor's code, on the Apify platform). The `apify-client` package is the API client for **calling** Actors from your own application. The agent picks the right one for you; if you're installing manually, double-check. + +**MCP server appears disconnected after VS Code restart.** Open **VS Code Settings → GitHub Copilot → MCP** and toggle the `apify` server off and on. If that doesn't help, re-trigger OAuth by running any Actor command. + +## Resources + +- Apify Console — [console.apify.com](https://console.apify.com) +- Apify Store — [apify.com/store](https://apify.com/store) +- Apify MCP server — [mcp.apify.com](https://mcp.apify.com/) +- Docs (LLM-friendly) — [docs.apify.com/llms.txt](https://docs.apify.com/llms.txt) +- Docs (full) — [docs.apify.com/llms-full.txt](https://docs.apify.com/llms-full.txt) +- Apify CLI reference — [docs.apify.com/cli](https://docs.apify.com/cli) + +## License + +Apache-2.0. See [LICENSE](./LICENSE).