Add Paperclip plugin docs for TwexAPI agent tools.

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: lanbytes

README.md

@@ -5,7 +5,7 @@
 
 Documentation for [TwexAPI](https://twexapi.io), an X (Twitter) Scraper API and X API alternative. Intended for **[docs.twexapi.io](https://docs.twexapi.io)**.
 
-This repository covers REST, MCP, SDKs, CLI, Terraform, n8n, Prefect, Haystack, and Apify. The OpenAPI contract currently documents **66** operations.
+This repository covers REST, MCP, SDKs, CLI, Terraform, n8n, Prefect, Haystack, Paperclip, and Apify. The OpenAPI contract currently documents **66** operations.
 
 ## Start here
 
@@ -35,6 +35,7 @@ python3 scripts/generate-api-pages.py
 - [n8n node](https://github.com/twexapi-dev/n8n-nodes-x-api-scraper)
 - [Prefect collection](https://github.com/twexapi-dev/prefect-x-api-scraper)
 - [Haystack components](https://github.com/twexapi-dev/x-api-scraper-haystack)
+- [Paperclip plugin](https://github.com/twexapi-dev/paperclip-plugin-x-api-scraper)
 
 ## License
 

changelog.mdx

@@ -6,5 +6,5 @@ description: "Docs repository changes for the TwexAPI Mintlify site."
 ## 2026-08-24
 
 - First public docs repository aligned with the 66-operation SDK OpenAPI.
-- REST, MCP, SDK, CLI, Terraform, n8n, Prefect, Haystack, and Apify coverage.
+- REST, MCP, SDK, CLI, Terraform, n8n, Prefect, Haystack, Paperclip, and Apify coverage.
 - No webhook, monitor, or OAuth CIMD pages. Those APIs are not in the current OpenAPI.

context7.json

@@ -1,6 +1,6 @@
 {
   "projectTitle": "TwexAPI docs",
-  "description": "TwexAPI documentation for REST API, MCP, SDKs, CLI, Terraform, n8n, Prefect, Haystack, and X/Twitter public reads plus approved writes. Not affiliated with X Corp.",
+  "description": "TwexAPI documentation for REST API, MCP, SDKs, CLI, Terraform, n8n, Prefect, Haystack, Paperclip, and X/Twitter public reads plus approved writes. Not affiliated with X Corp.",
   "branch": "main",
   "rules": [
     "Not affiliated with X Corp.",

docs.json

@@ -2,7 +2,7 @@
   "$schema": "https://mintlify.com/docs.json",
   "theme": "maple",
   "name": "TwexAPI",
-  "description": "TwexAPI docs for tweet search, follower scraping, timelines, DMs, SDKs, MCP, CLI, Terraform, n8n, Prefect, and Haystack. Not affiliated with X Corp.",
+  "description": "TwexAPI docs for tweet search, follower scraping, timelines, DMs, SDKs, MCP, CLI, Terraform, n8n, Prefect, Haystack, and Paperclip. Not affiliated with X Corp.",
   "search": {
     "prompt": "Search docs"
   },
@@ -90,7 +90,8 @@
               "sdks/terraform",
               "sdks/n8n",
               "sdks/prefect",
-              "sdks/haystack"
+              "sdks/haystack",
+              "sdks/paperclip"
             ]
           },
           {

index.mdx

@@ -1,7 +1,7 @@
 ---
 title: "TwexAPI X (Twitter) Scraper API"
 sidebarTitle: Home
-description: "Search tweets, read profiles, paginate followers, and run approved X actions through TwexAPI REST, SDKs, MCP, CLI, Terraform, n8n, Prefect, Haystack, or Apify. Not affiliated with X Corp."
+description: "Search tweets, read profiles, paginate followers, and run approved X actions through TwexAPI REST, SDKs, MCP, CLI, Terraform, n8n, Prefect, Haystack, Paperclip, or Apify. Not affiliated with X Corp."
 ---
 
 TwexAPI is an X (Twitter) Scraper API and X API alternative. Search tweets, read profiles, paginate followers, and run approved account actions.
@@ -38,7 +38,7 @@ Pass `next_cursor` from the previous page unchanged to fetch the next page.
     Hosted MCP at `https://api.twexapi.io/mcp` with `explore` and `twexapi_request`.
   </Card>
   <Card title="SDKs" icon="package" href="/sdks">
-    TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, n8n, Prefect, and Haystack.
+    TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, n8n, Prefect, Haystack, and Paperclip.
   </Card>
 </CardGroup>
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "x-api-scraper-docs",
   "private": true,
-  "description": "TwexAPI documentation source for REST, MCP, SDKs, CLI, Terraform, n8n, Prefect, and Haystack. Not affiliated with X Corp.",
+  "description": "TwexAPI documentation source for REST, MCP, SDKs, CLI, Terraform, n8n, Prefect, Haystack, and Paperclip. Not affiliated with X Corp.",
   "scripts": {
     "dev": "npx mintlify@latest dev",
     "generate:api": "python3 scripts/generate-api-pages.py"

sdks.mdx

@@ -1,7 +1,7 @@
 ---
 title: "TwexAPI SDKs and clients"
 sidebarTitle: SDKs
-description: "Install TwexAPI TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, n8n, Prefect, and Haystack clients. Not affiliated with X Corp."
+description: "Install TwexAPI TypeScript, Python, Go, Java, Kotlin, C#, Ruby, PHP, CLI, Terraform, n8n, Prefect, Haystack, and Paperclip clients. Not affiliated with X Corp."
 ---
 
 Official clients wrap the same REST contract. Public reads use `X_API_SCRAPER_KEY`. Writes still need a cookie or `auth_token`.
@@ -46,6 +46,9 @@ Official clients wrap the same REST contract. Public reads use `X_API_SCRAPER_KE
   <Card title="Haystack" href="/sdks/haystack" icon="layers">
     Components `x-api-scraper-haystack`
   </Card>
+  <Card title="Paperclip" href="/sdks/paperclip" icon="bot">
+    Plugin `@twexapi/paperclip-plugin-x-api-scraper`
+  </Card>
   <Card title="Apify" href="/guides/apify" icon="database">
     Pay-per-result tweet Actor, no TwexAPI key
   </Card>

sdks/paperclip.mdx

@@ -0,0 +1,23 @@
+---
+title: "Paperclip plugin"
+description: "Install @twexapi/paperclip-plugin-x-api-scraper for agent tools that search tweets, read profiles, timelines, and trends."
+---
+
+Install `@twexapi/paperclip-plugin-x-api-scraper` in Paperclip. The plugin reads a TwexAPI API key from a Paperclip secret and sends `Authorization: Bearer`.
+
+```bash
+paperclipai plugin install @twexapi/paperclip-plugin-x-api-scraper
+```
+
+| Agent task | Paperclip tool | TwexAPI route |
+| --- | --- | --- |
+| Search tweets | `twexapi.search_tweets` | `POST /twitter/advanced_search/page` |
+| Read one tweet | `twexapi.lookup_tweet` | `POST /v2/tweet/detail` |
+| Search users | `twexapi.search_users` | `GET /twitter/search-user/{keyword}/{target_count}` |
+| Read a profile | `twexapi.get_user` | `GET /twitter/{screen_name}/about` |
+| Read profile tweets | `twexapi.get_user_tweets` | `POST /twitter/{screen_name}/timeline/page` |
+| Read trending tweets | `twexapi.get_trends` | `GET /twitter/global-trending/tweets` |
+
+The plugin is read-only. Use REST or an SDK for follower pagination and approved posting.
+
+Source: [paperclip-plugin-x-api-scraper](https://github.com/twexapi-dev/paperclip-plugin-x-api-scraper)

twitter-api-alternatives.mdx

@@ -8,7 +8,7 @@ TwexAPI is an independent third-party X data API. It is not the official X API.
 
 | Option | Strong fit | Main tradeoff |
 | --- | --- | --- |
-| TwexAPI | Filtered X data, agents, SDKs, CLI, n8n, Prefect, Haystack, and X actions | Uses TwexAPI credits and documented limits |
+| TwexAPI | Filtered X data, agents, SDKs, CLI, n8n, Prefect, Haystack, Paperclip, and X actions | Uses TwexAPI credits and documented limits |
 | Official X API | Official platform contract and first-party support | Requires an official developer account |
 | Apify Actor | Console runs, schedules, and datasets | Actor and platform charges can both apply |
 | General scraper | Flexible HTML or browser retrieval | You own parsing, pagination, and schema drift |