diff --git a/.github/plugin/marketplace.json b/.github/plugin/marketplace.json index c488e0436..5e4692493 100644 --- a/.github/plugin/marketplace.json +++ b/.github/plugin/marketplace.json @@ -667,6 +667,12 @@ "source": "winui3-development", "description": "End-to-end WinUI 3 and Windows App SDK toolkit: expert agent, coding instructions, UWP-to-WinUI 3 migration guide, MVVM Toolkit reference, plus CLIs for packaging/debugging (winapp) and Microsoft Store publishing (msstore). Covers the full write → package → publish lifecycle for desktop Windows apps and prevents common UWP API misuse.", "version": "1.2.0" + }, + { + "name": "x-twitter-scraper", + "source": "x-twitter-scraper", + "description": "Xquik X API integration guidance for GitHub Copilot: SDK selection, REST endpoints, MCP tools, signed webhooks, tweet search, user lookup, follower exports, media actions, and automation workflows.", + "version": "1.0.0" } ] } diff --git a/docs/README.plugins.md b/docs/README.plugins.md index 47a8cfd44..4cf2833ad 100644 --- a/docs/README.plugins.md +++ b/docs/README.plugins.md @@ -92,3 +92,4 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-plugins) for guidelines on how t | [typescript-mcp-development](../plugins/typescript-mcp-development/README.md) | Complete toolkit for building Model Context Protocol (MCP) servers in TypeScript/Node.js using the official SDK. Includes instructions for best practices, a prompt for generating servers, and an expert chat mode for guidance. | 2 items | typescript, mcp, model-context-protocol, nodejs, server-development | | [typespec-m365-copilot](../plugins/typespec-m365-copilot/README.md) | Comprehensive collection of prompts, instructions, and resources for building declarative agents and API plugins using TypeSpec for Microsoft 365 Copilot extensibility. | 3 items | typespec, m365-copilot, declarative-agents, api-plugins, agent-development, microsoft-365 | | [winui3-development](../plugins/winui3-development/README.md) | End-to-end WinUI 3 and Windows App SDK toolkit: expert agent, coding instructions, UWP-to-WinUI 3 migration guide, MVVM Toolkit reference, plus CLIs for packaging/debugging (winapp) and Microsoft Store publishing (msstore). Covers the full write → package → publish lifecycle for desktop Windows apps and prevents common UWP API misuse. | 7 items | winui, winui3, windows-app-sdk, xaml, desktop, windows, mvvm, msix, microsoft-store | +| [x-twitter-scraper](../plugins/x-twitter-scraper/README.md) | Xquik X API integration guidance for GitHub Copilot: SDK selection, REST endpoints, MCP tools, signed webhooks, tweet search, user lookup, follower exports, media actions, and automation workflows. | 1 items | x-api, twitter, social-media, sdk, mcp, webhooks, automation, xquik | diff --git a/plugins/x-twitter-scraper/.github/plugin/plugin.json b/plugins/x-twitter-scraper/.github/plugin/plugin.json new file mode 100644 index 000000000..0c2cc7e45 --- /dev/null +++ b/plugins/x-twitter-scraper/.github/plugin/plugin.json @@ -0,0 +1,24 @@ +{ + "name": "x-twitter-scraper", + "description": "Xquik X API integration guidance for GitHub Copilot: SDK selection, REST endpoints, MCP tools, signed webhooks, tweet search, user lookup, follower exports, media actions, and automation workflows.", + "version": "1.0.0", + "keywords": [ + "x-api", + "twitter", + "social-media", + "sdk", + "mcp", + "webhooks", + "automation", + "xquik" + ], + "author": { + "name": "Xquik" + }, + "homepage": "https://docs.xquik.com", + "repository": "https://github.com/github/awesome-copilot", + "license": "MIT", + "skills": [ + "./skills/x-twitter-scraper/" + ] +} diff --git a/plugins/x-twitter-scraper/README.md b/plugins/x-twitter-scraper/README.md new file mode 100644 index 000000000..c97764dc3 --- /dev/null +++ b/plugins/x-twitter-scraper/README.md @@ -0,0 +1,66 @@ +# X Twitter Scraper Plugin + +Use this plugin to give GitHub Copilot the `x-twitter-scraper` skill for Xquik API integration work. The skill helps Copilot choose the right Xquik SDK, REST endpoint, MCP path, or webhook pattern before it writes code. + +## Installation + +```bash +copilot plugin install x-twitter-scraper@awesome-copilot +``` + +## What It Includes + +| Item | Description | +| ---- | ----------- | +| `/x-twitter-scraper` | Guides Xquik SDK, REST API, MCP, webhook, tweet search, user lookup, follower export, media action, and automation integration tasks. | + +## When To Use + +Use the skill when you want Copilot to integrate Xquik into an application, script, data pipeline, or agent workflow. + +Good fits include: + +- Add tweet search, timeline, tweet detail, or media download workflows. +- Look up X users or sync profile tweets into an app. +- Export followers, following, replies, reposts, quotes, likes, lists, communities, articles, or search results. +- Create account monitors and process signed webhook events. +- Add TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, or Terraform clients. +- Connect an agent to Xquik through MCP. + +The skill is useful when Copilot needs current Xquik docs instead of guessing endpoint names, request fields, package names, or webhook signature handling. + +## Example Prompts + +```text +/x-twitter-scraper Add a TypeScript job that searches recent tweets and stores tweet IDs. +``` + +```text +/x-twitter-scraper Build a server-side webhook handler that verifies Xquik signatures. +``` + +```text +/x-twitter-scraper Add profile tweet sync to this Python project using the official SDK. +``` + +```text +/x-twitter-scraper Show the safest MCP integration path for an agent that reads tweet data. +``` + +## Guardrails + +- Use official Xquik docs, SDK READMEs, and the OpenAPI spec before writing integration code. +- Keep API keys and webhook secrets in environment variables or the project's secret manager. +- Verify webhook signatures server-side before processing events. +- Require explicit user confirmation before write actions or long-running monitoring. +- Treat Xquik as a third-party X data and automation API. Do not claim affiliation with X Corp. + +## Source + +- Skill source: [skills/x-twitter-scraper](../../skills/x-twitter-scraper/SKILL.md) +- Xquik docs: [docs.xquik.com](https://docs.xquik.com) +- Xquik skill repo: [Xquik-dev/x-twitter-scraper](https://github.com/Xquik-dev/x-twitter-scraper) + +## License + +MIT