aidevops 2.52.1 → 2.53.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (334) hide show
  1. package/README.md +1 -1
  2. package/VERSION +1 -1
  3. package/aidevops.sh +15 -9
  4. package/package.json +4 -4
  5. package/scripts/npm-postinstall.js +6 -7
  6. package/setup.sh +1 -1
  7. package/templates/deploy-templates.sh +144 -0
  8. package/templates/home/.agent/README.md +33 -0
  9. package/templates/home/AGENTS.md +96 -0
  10. package/templates/home/git/.agent/README.md +48 -0
  11. package/templates/home/git/AGENTS.md +97 -0
  12. package/templates/standard-functions.sh +179 -0
  13. package/templates/wordpress-performance-workflow.md +217 -0
  14. package/.agent/AGENTS.md +0 -614
  15. package/.agent/accounts.md +0 -65
  16. package/.agent/aidevops/add-new-mcp-to-aidevops.md +0 -456
  17. package/.agent/aidevops/api-integrations.md +0 -335
  18. package/.agent/aidevops/architecture.md +0 -510
  19. package/.agent/aidevops/configs.md +0 -274
  20. package/.agent/aidevops/docs.md +0 -244
  21. package/.agent/aidevops/extension.md +0 -311
  22. package/.agent/aidevops/mcp-integrations.md +0 -340
  23. package/.agent/aidevops/mcp-troubleshooting.md +0 -162
  24. package/.agent/aidevops/memory-patterns.md +0 -172
  25. package/.agent/aidevops/providers.md +0 -217
  26. package/.agent/aidevops/recommendations.md +0 -321
  27. package/.agent/aidevops/requirements.md +0 -301
  28. package/.agent/aidevops/resources.md +0 -214
  29. package/.agent/aidevops/security-requirements.md +0 -174
  30. package/.agent/aidevops/security.md +0 -350
  31. package/.agent/aidevops/service-links.md +0 -400
  32. package/.agent/aidevops/services.md +0 -357
  33. package/.agent/aidevops/setup.md +0 -153
  34. package/.agent/aidevops/troubleshooting.md +0 -389
  35. package/.agent/aidevops.md +0 -124
  36. package/.agent/build-plus.md +0 -244
  37. package/.agent/content/guidelines.md +0 -109
  38. package/.agent/content.md +0 -87
  39. package/.agent/health.md +0 -59
  40. package/.agent/legal.md +0 -59
  41. package/.agent/loop-state/full-loop.local.md +0 -16
  42. package/.agent/loop-state/ralph-loop.local.md +0 -10
  43. package/.agent/marketing.md +0 -440
  44. package/.agent/memory/README.md +0 -260
  45. package/.agent/onboarding.md +0 -796
  46. package/.agent/plan-plus.md +0 -245
  47. package/.agent/research.md +0 -100
  48. package/.agent/sales.md +0 -333
  49. package/.agent/scripts/101domains-helper.sh +0 -701
  50. package/.agent/scripts/add-missing-returns.sh +0 -140
  51. package/.agent/scripts/agent-browser-helper.sh +0 -311
  52. package/.agent/scripts/agno-setup.sh +0 -712
  53. package/.agent/scripts/ahrefs-mcp-wrapper.js +0 -168
  54. package/.agent/scripts/aidevops-update-check.sh +0 -71
  55. package/.agent/scripts/ampcode-cli.sh +0 -522
  56. package/.agent/scripts/auto-version-bump.sh +0 -156
  57. package/.agent/scripts/autogen-helper.sh +0 -512
  58. package/.agent/scripts/beads-sync-helper.sh +0 -596
  59. package/.agent/scripts/closte-helper.sh +0 -5
  60. package/.agent/scripts/cloudron-helper.sh +0 -321
  61. package/.agent/scripts/codacy-cli-chunked.sh +0 -581
  62. package/.agent/scripts/codacy-cli.sh +0 -442
  63. package/.agent/scripts/code-audit-helper.sh +0 -5
  64. package/.agent/scripts/coderabbit-cli.sh +0 -417
  65. package/.agent/scripts/coderabbit-pro-analysis.sh +0 -238
  66. package/.agent/scripts/commands/code-simplifier.md +0 -86
  67. package/.agent/scripts/commands/full-loop.md +0 -246
  68. package/.agent/scripts/commands/postflight-loop.md +0 -103
  69. package/.agent/scripts/commands/recall.md +0 -182
  70. package/.agent/scripts/commands/remember.md +0 -132
  71. package/.agent/scripts/commands/save-todo.md +0 -175
  72. package/.agent/scripts/commands/session-review.md +0 -154
  73. package/.agent/scripts/comprehensive-quality-fix.sh +0 -106
  74. package/.agent/scripts/context-builder-helper.sh +0 -522
  75. package/.agent/scripts/coolify-cli-helper.sh +0 -674
  76. package/.agent/scripts/coolify-helper.sh +0 -380
  77. package/.agent/scripts/crawl4ai-examples.sh +0 -401
  78. package/.agent/scripts/crawl4ai-helper.sh +0 -1078
  79. package/.agent/scripts/crewai-helper.sh +0 -681
  80. package/.agent/scripts/dev-browser-helper.sh +0 -513
  81. package/.agent/scripts/dns-helper.sh +0 -396
  82. package/.agent/scripts/domain-research-helper.sh +0 -917
  83. package/.agent/scripts/dspy-helper.sh +0 -285
  84. package/.agent/scripts/dspyground-helper.sh +0 -291
  85. package/.agent/scripts/eeat-score-helper.sh +0 -1242
  86. package/.agent/scripts/efficient-return-fix.sh +0 -92
  87. package/.agent/scripts/extract-opencode-prompts.sh +0 -128
  88. package/.agent/scripts/find-missing-returns.sh +0 -113
  89. package/.agent/scripts/fix-auth-headers.sh +0 -104
  90. package/.agent/scripts/fix-common-strings.sh +0 -254
  91. package/.agent/scripts/fix-content-type.sh +0 -100
  92. package/.agent/scripts/fix-error-messages.sh +0 -130
  93. package/.agent/scripts/fix-misplaced-returns.sh +0 -74
  94. package/.agent/scripts/fix-remaining-literals.sh +0 -152
  95. package/.agent/scripts/fix-return-statements.sh +0 -41
  96. package/.agent/scripts/fix-s131-default-cases.sh +0 -249
  97. package/.agent/scripts/fix-sc2155-simple.sh +0 -102
  98. package/.agent/scripts/fix-shellcheck-critical.sh +0 -187
  99. package/.agent/scripts/fix-string-literals.sh +0 -273
  100. package/.agent/scripts/full-loop-helper.sh +0 -773
  101. package/.agent/scripts/generate-opencode-agents.sh +0 -497
  102. package/.agent/scripts/generate-opencode-commands.sh +0 -1629
  103. package/.agent/scripts/generate-skills.sh +0 -366
  104. package/.agent/scripts/git-platforms-helper.sh +0 -640
  105. package/.agent/scripts/gitea-cli-helper.sh +0 -743
  106. package/.agent/scripts/github-cli-helper.sh +0 -702
  107. package/.agent/scripts/gitlab-cli-helper.sh +0 -682
  108. package/.agent/scripts/gsc-add-user-helper.sh +0 -325
  109. package/.agent/scripts/gsc-sitemap-helper.sh +0 -678
  110. package/.agent/scripts/hetzner-helper.sh +0 -485
  111. package/.agent/scripts/hostinger-helper.sh +0 -229
  112. package/.agent/scripts/keyword-research-helper.sh +0 -1815
  113. package/.agent/scripts/langflow-helper.sh +0 -544
  114. package/.agent/scripts/linkedin-automation.py +0 -241
  115. package/.agent/scripts/linter-manager.sh +0 -599
  116. package/.agent/scripts/linters-local.sh +0 -434
  117. package/.agent/scripts/list-keys-helper.sh +0 -488
  118. package/.agent/scripts/local-browser-automation.py +0 -339
  119. package/.agent/scripts/localhost-helper.sh +0 -744
  120. package/.agent/scripts/loop-common.sh +0 -806
  121. package/.agent/scripts/mainwp-helper.sh +0 -728
  122. package/.agent/scripts/markdown-formatter.sh +0 -338
  123. package/.agent/scripts/markdown-lint-fix.sh +0 -311
  124. package/.agent/scripts/mass-fix-returns.sh +0 -58
  125. package/.agent/scripts/mcp-diagnose.sh +0 -167
  126. package/.agent/scripts/mcp-inspector-helper.sh +0 -449
  127. package/.agent/scripts/memory-helper.sh +0 -650
  128. package/.agent/scripts/monitor-code-review.sh +0 -255
  129. package/.agent/scripts/onboarding-helper.sh +0 -706
  130. package/.agent/scripts/opencode-github-setup-helper.sh +0 -797
  131. package/.agent/scripts/opencode-test-helper.sh +0 -213
  132. package/.agent/scripts/pagespeed-helper.sh +0 -464
  133. package/.agent/scripts/pandoc-helper.sh +0 -362
  134. package/.agent/scripts/postflight-check.sh +0 -555
  135. package/.agent/scripts/pre-commit-hook.sh +0 -259
  136. package/.agent/scripts/pre-edit-check.sh +0 -169
  137. package/.agent/scripts/qlty-cli.sh +0 -356
  138. package/.agent/scripts/quality-cli-manager.sh +0 -525
  139. package/.agent/scripts/quality-feedback-helper.sh +0 -462
  140. package/.agent/scripts/quality-fix.sh +0 -263
  141. package/.agent/scripts/quality-loop-helper.sh +0 -1108
  142. package/.agent/scripts/ralph-loop-helper.sh +0 -836
  143. package/.agent/scripts/ralph-upstream-check.sh +0 -341
  144. package/.agent/scripts/secretlint-helper.sh +0 -847
  145. package/.agent/scripts/servers-helper.sh +0 -241
  146. package/.agent/scripts/ses-helper.sh +0 -619
  147. package/.agent/scripts/session-review-helper.sh +0 -404
  148. package/.agent/scripts/setup-linters-wizard.sh +0 -379
  149. package/.agent/scripts/setup-local-api-keys.sh +0 -330
  150. package/.agent/scripts/setup-mcp-integrations.sh +0 -472
  151. package/.agent/scripts/shared-constants.sh +0 -246
  152. package/.agent/scripts/site-crawler-helper.sh +0 -1487
  153. package/.agent/scripts/snyk-helper.sh +0 -940
  154. package/.agent/scripts/sonarcloud-autofix.sh +0 -193
  155. package/.agent/scripts/sonarcloud-cli.sh +0 -191
  156. package/.agent/scripts/sonarscanner-cli.sh +0 -455
  157. package/.agent/scripts/spaceship-helper.sh +0 -747
  158. package/.agent/scripts/stagehand-helper.sh +0 -321
  159. package/.agent/scripts/stagehand-python-helper.sh +0 -321
  160. package/.agent/scripts/stagehand-python-setup.sh +0 -441
  161. package/.agent/scripts/stagehand-setup.sh +0 -439
  162. package/.agent/scripts/system-cleanup.sh +0 -340
  163. package/.agent/scripts/terminal-title-helper.sh +0 -388
  164. package/.agent/scripts/terminal-title-setup.sh +0 -549
  165. package/.agent/scripts/test-stagehand-both-integration.sh +0 -317
  166. package/.agent/scripts/test-stagehand-integration.sh +0 -309
  167. package/.agent/scripts/test-stagehand-python-integration.sh +0 -341
  168. package/.agent/scripts/todo-ready.sh +0 -263
  169. package/.agent/scripts/tool-version-check.sh +0 -362
  170. package/.agent/scripts/toon-helper.sh +0 -469
  171. package/.agent/scripts/twilio-helper.sh +0 -917
  172. package/.agent/scripts/updown-helper.sh +0 -279
  173. package/.agent/scripts/validate-mcp-integrations.sh +0 -250
  174. package/.agent/scripts/validate-version-consistency.sh +0 -131
  175. package/.agent/scripts/vaultwarden-helper.sh +0 -597
  176. package/.agent/scripts/vercel-cli-helper.sh +0 -816
  177. package/.agent/scripts/verify-mirrors.sh +0 -169
  178. package/.agent/scripts/version-manager.sh +0 -831
  179. package/.agent/scripts/webhosting-helper.sh +0 -471
  180. package/.agent/scripts/webhosting-verify.sh +0 -238
  181. package/.agent/scripts/wordpress-mcp-helper.sh +0 -508
  182. package/.agent/scripts/worktree-helper.sh +0 -595
  183. package/.agent/scripts/worktree-sessions.sh +0 -577
  184. package/.agent/seo/dataforseo.md +0 -215
  185. package/.agent/seo/domain-research.md +0 -532
  186. package/.agent/seo/eeat-score.md +0 -659
  187. package/.agent/seo/google-search-console.md +0 -366
  188. package/.agent/seo/gsc-sitemaps.md +0 -282
  189. package/.agent/seo/keyword-research.md +0 -521
  190. package/.agent/seo/serper.md +0 -278
  191. package/.agent/seo/site-crawler.md +0 -387
  192. package/.agent/seo.md +0 -236
  193. package/.agent/services/accounting/quickfile.md +0 -159
  194. package/.agent/services/communications/telfon.md +0 -470
  195. package/.agent/services/communications/twilio.md +0 -569
  196. package/.agent/services/crm/fluentcrm.md +0 -449
  197. package/.agent/services/email/ses.md +0 -399
  198. package/.agent/services/hosting/101domains.md +0 -378
  199. package/.agent/services/hosting/closte.md +0 -177
  200. package/.agent/services/hosting/cloudflare.md +0 -251
  201. package/.agent/services/hosting/cloudron.md +0 -478
  202. package/.agent/services/hosting/dns-providers.md +0 -335
  203. package/.agent/services/hosting/domain-purchasing.md +0 -344
  204. package/.agent/services/hosting/hetzner.md +0 -327
  205. package/.agent/services/hosting/hostinger.md +0 -287
  206. package/.agent/services/hosting/localhost.md +0 -419
  207. package/.agent/services/hosting/spaceship.md +0 -353
  208. package/.agent/services/hosting/webhosting.md +0 -330
  209. package/.agent/social-media.md +0 -69
  210. package/.agent/templates/plans-template.md +0 -114
  211. package/.agent/templates/prd-template.md +0 -129
  212. package/.agent/templates/tasks-template.md +0 -108
  213. package/.agent/templates/todo-template.md +0 -89
  214. package/.agent/tools/ai-assistants/agno.md +0 -471
  215. package/.agent/tools/ai-assistants/capsolver.md +0 -326
  216. package/.agent/tools/ai-assistants/configuration.md +0 -221
  217. package/.agent/tools/ai-assistants/overview.md +0 -209
  218. package/.agent/tools/ai-assistants/status.md +0 -171
  219. package/.agent/tools/ai-assistants/windsurf.md +0 -193
  220. package/.agent/tools/ai-orchestration/autogen.md +0 -406
  221. package/.agent/tools/ai-orchestration/crewai.md +0 -445
  222. package/.agent/tools/ai-orchestration/langflow.md +0 -405
  223. package/.agent/tools/ai-orchestration/openprose.md +0 -487
  224. package/.agent/tools/ai-orchestration/overview.md +0 -362
  225. package/.agent/tools/ai-orchestration/packaging.md +0 -647
  226. package/.agent/tools/browser/agent-browser.md +0 -464
  227. package/.agent/tools/browser/browser-automation.md +0 -400
  228. package/.agent/tools/browser/chrome-devtools.md +0 -282
  229. package/.agent/tools/browser/crawl4ai-integration.md +0 -422
  230. package/.agent/tools/browser/crawl4ai-resources.md +0 -277
  231. package/.agent/tools/browser/crawl4ai-usage.md +0 -416
  232. package/.agent/tools/browser/crawl4ai.md +0 -585
  233. package/.agent/tools/browser/dev-browser.md +0 -341
  234. package/.agent/tools/browser/pagespeed.md +0 -260
  235. package/.agent/tools/browser/playwright.md +0 -266
  236. package/.agent/tools/browser/playwriter.md +0 -310
  237. package/.agent/tools/browser/stagehand-examples.md +0 -456
  238. package/.agent/tools/browser/stagehand-python.md +0 -483
  239. package/.agent/tools/browser/stagehand.md +0 -421
  240. package/.agent/tools/build-agent/agent-review.md +0 -224
  241. package/.agent/tools/build-agent/build-agent.md +0 -784
  242. package/.agent/tools/build-mcp/aidevops-plugin.md +0 -476
  243. package/.agent/tools/build-mcp/api-wrapper.md +0 -445
  244. package/.agent/tools/build-mcp/build-mcp.md +0 -240
  245. package/.agent/tools/build-mcp/deployment.md +0 -401
  246. package/.agent/tools/build-mcp/server-patterns.md +0 -632
  247. package/.agent/tools/build-mcp/transports.md +0 -366
  248. package/.agent/tools/code-review/auditing.md +0 -383
  249. package/.agent/tools/code-review/automation.md +0 -219
  250. package/.agent/tools/code-review/best-practices.md +0 -203
  251. package/.agent/tools/code-review/codacy.md +0 -151
  252. package/.agent/tools/code-review/code-simplifier.md +0 -174
  253. package/.agent/tools/code-review/code-standards.md +0 -309
  254. package/.agent/tools/code-review/coderabbit.md +0 -101
  255. package/.agent/tools/code-review/management.md +0 -155
  256. package/.agent/tools/code-review/qlty.md +0 -248
  257. package/.agent/tools/code-review/secretlint.md +0 -565
  258. package/.agent/tools/code-review/setup.md +0 -250
  259. package/.agent/tools/code-review/snyk.md +0 -563
  260. package/.agent/tools/code-review/tools.md +0 -230
  261. package/.agent/tools/content/summarize.md +0 -353
  262. package/.agent/tools/context/augment-context-engine.md +0 -468
  263. package/.agent/tools/context/context-builder-agent.md +0 -76
  264. package/.agent/tools/context/context-builder.md +0 -375
  265. package/.agent/tools/context/context7.md +0 -371
  266. package/.agent/tools/context/dspy.md +0 -302
  267. package/.agent/tools/context/dspyground.md +0 -374
  268. package/.agent/tools/context/llm-tldr.md +0 -219
  269. package/.agent/tools/context/osgrep.md +0 -488
  270. package/.agent/tools/context/prompt-optimization.md +0 -338
  271. package/.agent/tools/context/toon.md +0 -292
  272. package/.agent/tools/conversion/pandoc.md +0 -304
  273. package/.agent/tools/credentials/api-key-management.md +0 -154
  274. package/.agent/tools/credentials/api-key-setup.md +0 -224
  275. package/.agent/tools/credentials/environment-variables.md +0 -180
  276. package/.agent/tools/credentials/vaultwarden.md +0 -382
  277. package/.agent/tools/data-extraction/outscraper.md +0 -974
  278. package/.agent/tools/deployment/coolify-cli.md +0 -388
  279. package/.agent/tools/deployment/coolify-setup.md +0 -353
  280. package/.agent/tools/deployment/coolify.md +0 -345
  281. package/.agent/tools/deployment/vercel.md +0 -390
  282. package/.agent/tools/git/authentication.md +0 -132
  283. package/.agent/tools/git/gitea-cli.md +0 -193
  284. package/.agent/tools/git/github-actions.md +0 -207
  285. package/.agent/tools/git/github-cli.md +0 -223
  286. package/.agent/tools/git/gitlab-cli.md +0 -190
  287. package/.agent/tools/git/opencode-github-security.md +0 -350
  288. package/.agent/tools/git/opencode-github.md +0 -328
  289. package/.agent/tools/git/opencode-gitlab.md +0 -252
  290. package/.agent/tools/git/security.md +0 -196
  291. package/.agent/tools/git.md +0 -207
  292. package/.agent/tools/opencode/oh-my-opencode.md +0 -375
  293. package/.agent/tools/opencode/opencode-anthropic-auth.md +0 -446
  294. package/.agent/tools/opencode/opencode.md +0 -651
  295. package/.agent/tools/social-media/bird.md +0 -437
  296. package/.agent/tools/task-management/beads.md +0 -336
  297. package/.agent/tools/terminal/terminal-title.md +0 -251
  298. package/.agent/tools/ui/shadcn.md +0 -196
  299. package/.agent/tools/ui/ui-skills.md +0 -115
  300. package/.agent/tools/wordpress/localwp.md +0 -311
  301. package/.agent/tools/wordpress/mainwp.md +0 -391
  302. package/.agent/tools/wordpress/scf.md +0 -527
  303. package/.agent/tools/wordpress/wp-admin.md +0 -729
  304. package/.agent/tools/wordpress/wp-dev.md +0 -940
  305. package/.agent/tools/wordpress/wp-preferred.md +0 -398
  306. package/.agent/tools/wordpress.md +0 -95
  307. package/.agent/workflows/branch/bugfix.md +0 -63
  308. package/.agent/workflows/branch/chore.md +0 -95
  309. package/.agent/workflows/branch/experiment.md +0 -115
  310. package/.agent/workflows/branch/feature.md +0 -59
  311. package/.agent/workflows/branch/hotfix.md +0 -98
  312. package/.agent/workflows/branch/refactor.md +0 -92
  313. package/.agent/workflows/branch/release.md +0 -96
  314. package/.agent/workflows/branch.md +0 -347
  315. package/.agent/workflows/bug-fixing.md +0 -267
  316. package/.agent/workflows/changelog.md +0 -129
  317. package/.agent/workflows/code-audit-remote.md +0 -279
  318. package/.agent/workflows/conversation-starter.md +0 -69
  319. package/.agent/workflows/error-feedback.md +0 -578
  320. package/.agent/workflows/feature-development.md +0 -355
  321. package/.agent/workflows/git-workflow.md +0 -702
  322. package/.agent/workflows/multi-repo-workspace.md +0 -268
  323. package/.agent/workflows/plans.md +0 -709
  324. package/.agent/workflows/postflight.md +0 -604
  325. package/.agent/workflows/pr.md +0 -571
  326. package/.agent/workflows/preflight.md +0 -278
  327. package/.agent/workflows/ralph-loop.md +0 -773
  328. package/.agent/workflows/release.md +0 -498
  329. package/.agent/workflows/session-manager.md +0 -254
  330. package/.agent/workflows/session-review.md +0 -311
  331. package/.agent/workflows/sql-migrations.md +0 -631
  332. package/.agent/workflows/version-bump.md +0 -283
  333. package/.agent/workflows/wiki-update.md +0 -333
  334. package/.agent/workflows/worktree.md +0 -477
@@ -1,974 +0,0 @@
1
- ---
2
- description: Outscraper MCP for business data extraction
3
- mode: subagent
4
- tools:
5
- read: true
6
- write: false
7
- edit: false
8
- bash: false
9
- glob: true
10
- grep: true
11
- webfetch: true
12
- task: true
13
- ---
14
-
15
- # Outscraper MCP Server
16
-
17
- <!-- AI-CONTEXT-START -->
18
-
19
- ## Quick Reference
20
-
21
- - **Purpose**: Business intelligence extraction from Google Maps, Amazon, reviews, contacts
22
- - **Install**: `uv tool run outscraper-mcp-server` or `pip install outscraper-mcp-server`
23
- - **Auth**: API key from <https://auth.outscraper.com/profile>
24
- - **Env Var**: `OUTSCRAPER_API_KEY`
25
- - **API Base**: `https://api.app.outscraper.com`
26
- - **Docs**: <https://app.outscraper.com/api-docs>
27
-
28
- **OpenCode Config**:
29
-
30
- ```json
31
- "outscraper": {
32
- "type": "local",
33
- "command": ["/bin/bash", "-c", "OUTSCRAPER_API_KEY=$OUTSCRAPER_API_KEY uv tool run outscraper-mcp-server"],
34
- "enabled": true
35
- }
36
- ```
37
-
38
- **Verification Prompt**:
39
-
40
- ```text
41
- Search for coffee shops near Times Square NYC using Google Maps search and return the top 5 results with ratings.
42
- ```
43
-
44
- **MCP Tools** (25+):
45
-
46
- - Google Maps: `google_maps_search`, `google_maps_reviews`, `google_maps_photos`,
47
- `google_maps_directions`
48
- - Search: `google_search`, `google_search_news`
49
- - Reviews: `google_play_reviews`, `amazon_reviews`, `tripadvisor_reviews`,
50
- `apple_store_reviews`, `youtube_comments`, `g2_reviews`, `trustpilot_reviews`,
51
- `glassdoor_reviews`, `capterra_reviews`, `yelp_reviews`
52
- - Business: `emails_and_contacts`, `contacts_and_leads`, `phones_enricher`,
53
- `company_insights`, `email_validation`, `whitepages_phones`, `whitepages_addresses`,
54
- `amazon_products`, `company_websites_finder`, `similarweb`
55
- - Search Platforms: `yelp_search`, `trustpilot_search`, `yellowpages_search`
56
- - Geo: `geocoding`, `reverse_geocoding`
57
-
58
- **Direct API** (not in MCP): `GET /profile/balance`, `GET /invoices`,
59
- `POST /tasks`, `GET /webhook-calls`, `GET /locations`
60
-
61
- **Supported AI Tools**: OpenCode, Claude Code, Cursor, Windsurf, Gemini CLI,
62
- VS Code (Copilot), Raycast, custom MCP clients
63
-
64
- **OpenCode Access**: `@outscraper` subagent only (not enabled for main agents)
65
-
66
- <!-- AI-CONTEXT-END -->
67
-
68
- ## What It Does
69
-
70
- Outscraper provides comprehensive data extraction from online platforms:
71
-
72
- | Category | Capabilities |
73
- |----------|-------------|
74
- | **Google Maps** | Business search, reviews, photos, directions |
75
- | **Search** | Google organic results, news, ads |
76
- | **Reviews** | Amazon, TripAdvisor, Apple Store, YouTube, G2, Trustpilot, Glassdoor, Capterra, Yelp |
77
- | **Business Intel** | Email extraction, phone validation, company insights, contacts & leads |
78
- | **Domain Intel** | Similarweb traffic, company website finder |
79
- | **Directories** | Yellow Pages search, Trustpilot search, Yelp search |
80
- | **Geolocation** | Address to coordinates, reverse geocoding |
81
- | **Whitepages** | Phone identity lookup, address/resident lookup |
82
-
83
- Use cases:
84
-
85
- - Local business research and competitive analysis
86
- - Review aggregation and sentiment analysis
87
- - Lead generation with contact enrichment
88
- - Market research across platforms
89
- - Location-based data collection
90
-
91
- ## Full API Reference
92
-
93
- **Base URL**: `https://api.app.outscraper.com`
94
-
95
- This is the URL used by the official Python SDK. The OpenAPI spec references
96
- `api.outscraper.cloud` but the SDK source confirms `api.app.outscraper.com`.
97
-
98
- **Authentication**: API key in `X-API-KEY` header
99
-
100
- ### Account & Billing Endpoints
101
-
102
- These endpoints are available via direct API calls (not in Python SDK):
103
-
104
- | Endpoint | Method | Description |
105
- |----------|--------|-------------|
106
- | `/profile/balance` | GET | Account balance, status, and upcoming invoice |
107
- | `/invoices` | GET | User invoice history |
108
-
109
- #### Get Account Balance
110
-
111
- ```python
112
- import requests
113
-
114
- response = requests.get(
115
- 'https://api.app.outscraper.com/profile/balance',
116
- headers={'X-API-KEY': 'YOUR_API_KEY'}
117
- )
118
- balance_info = response.json()
119
- # Returns: {"balance": 100.00, "account_status": "active", "upcoming_invoice": {...}}
120
- ```
121
-
122
- #### Get Invoices
123
-
124
- ```python
125
- response = requests.get(
126
- 'https://api.app.outscraper.com/invoices',
127
- headers={'X-API-KEY': 'YOUR_API_KEY'}
128
- )
129
- invoices = response.json()
130
- ```
131
-
132
- ### System & Request Endpoints
133
-
134
- | Endpoint | Method | In SDK | Description |
135
- |----------|--------|--------|-------------|
136
- | `/tasks` | GET | Yes | Fetch user UI tasks (platform task history) |
137
- | `/tasks` | POST | No | Create a new UI task via API |
138
- | `/tasks-validate` | POST | No | Validate/estimate a task before creation |
139
- | `/tasks/{taskId}` | PUT | No | Restart a task |
140
- | `/tasks/{taskId}` | DELETE | No | Terminate a task |
141
- | `/requests` | GET | Yes | Fetch up to 100 of your last API requests |
142
- | `/requests/{requestId}` | GET | Yes | Fetch request data from archive (async results) |
143
- | `/webhook-calls` | GET | No | Failed webhook calls (last 24 hours) |
144
- | `/locations` | GET | No | Country locations for Google Maps searches |
145
-
146
- #### Get UI Tasks
147
-
148
- Fetch user UI tasks created through the platform.
149
-
150
- ```python
151
- from outscraper import ApiClient
152
- client = ApiClient(api_key='YOUR_API_KEY')
153
-
154
- # Get tasks with optional filtering
155
- tasks, has_more = client.get_tasks(query='', page_size=10)
156
- ```
157
-
158
- | Parameter | Type | Description |
159
- |-----------|------|-------------|
160
- | `query` | string | Search query/tag to filter tasks |
161
- | `last_id` | string | Last task ID for pagination |
162
- | `page_size` | int | Number of items to return (default: 10) |
163
-
164
- #### Create UI Task
165
-
166
- Create a task via API (same as creating through the web UI).
167
-
168
- ```python
169
- import requests
170
-
171
- task_data = {
172
- "service": "google_maps_search",
173
- "query": ["restaurants brooklyn usa"],
174
- "limit": 100
175
- }
176
-
177
- response = requests.post(
178
- 'https://api.app.outscraper.com/tasks',
179
- headers={'X-API-KEY': 'YOUR_API_KEY'},
180
- json=task_data
181
- )
182
- task = response.json()
183
- ```
184
-
185
- #### Validate/Estimate Task
186
-
187
- Validate a task and get cost estimate before creation.
188
-
189
- ```python
190
- response = requests.post(
191
- 'https://api.app.outscraper.com/tasks-validate',
192
- headers={'X-API-KEY': 'YOUR_API_KEY'},
193
- json=task_data
194
- )
195
- validation = response.json()
196
- # Returns: {"valid": true, "estimated_cost": 5.00, ...}
197
- ```
198
-
199
- #### Restart Task
200
-
201
- ```python
202
- response = requests.put(
203
- f'https://api.app.outscraper.com/tasks/{task_id}',
204
- headers={'X-API-KEY': 'YOUR_API_KEY'}
205
- )
206
- ```
207
-
208
- #### Terminate Task
209
-
210
- ```python
211
- response = requests.delete(
212
- f'https://api.app.outscraper.com/tasks/{task_id}',
213
- headers={'X-API-KEY': 'YOUR_API_KEY'}
214
- )
215
- ```
216
-
217
- #### Get Requests History
218
-
219
- Fetch your recent API requests (running or finished).
220
-
221
- ```python
222
- # Get finished requests
223
- requests = client.get_requests_history(type='finished', skip=0, page_size=25)
224
-
225
- # Get running requests
226
- running = client.get_requests_history(type='running')
227
- ```
228
-
229
- | Parameter | Type | Description |
230
- |-----------|------|-------------|
231
- | `type` | string | Filter: `running` or `finished` |
232
- | `skip` | int | Skip first N records (pagination) |
233
- | `page_size` | int | Number of items (default: 25, max: 100) |
234
-
235
- #### Get Request Archive
236
-
237
- Retrieve results from async requests.
238
-
239
- ```python
240
- # Get archived request data
241
- result = client.get_request_archive(request_id='your_request_id')
242
- # Returns: {"id": "...", "status": "Pending|Completed|Failed", "data": [...]}
243
- ```
244
-
245
- #### Get Failed Webhook Calls
246
-
247
- Retrieve failed webhook calls from the last 24 hours.
248
-
249
- ```python
250
- response = requests.get(
251
- 'https://api.app.outscraper.com/webhook-calls',
252
- headers={'X-API-KEY': 'YOUR_API_KEY'}
253
- )
254
- failed_webhooks = response.json()
255
- ```
256
-
257
- #### Get Locations
258
-
259
- Get available country locations for Google Maps searches.
260
-
261
- ```python
262
- response = requests.get(
263
- 'https://api.app.outscraper.com/locations',
264
- headers={'X-API-KEY': 'YOUR_API_KEY'}
265
- )
266
- locations = response.json()
267
- # Returns list of countries with their location codes
268
- ```
269
-
270
- ### Google Services
271
-
272
- | Endpoint | Method | Description |
273
- |----------|--------|-------------|
274
- | `/google-search-v3` | GET | Google Search results |
275
- | `/google-search-news` | GET | Google News search |
276
- | `/google-maps-search` | POST | Google Maps places search (speed-optimized) |
277
- | `/maps/search` | GET | Google Maps search (legacy) |
278
- | `/maps/reviews-v3` | GET | Google Maps reviews (speed-optimized) |
279
- | `/maps/reviews-v2` | GET | Google Maps reviews (legacy) |
280
- | `/maps/photos-v3` | GET | Google Maps photos |
281
- | `/maps/directions` | GET | Google Maps directions |
282
- | `/google-play/reviews` | GET | Google Play Store reviews |
283
-
284
- ### Amazon Services
285
-
286
- | Endpoint | Method | Description |
287
- |----------|--------|-------------|
288
- | `/amazon/products-v2` | GET | Amazon product data |
289
- | `/amazon/reviews` | GET | Amazon product reviews |
290
-
291
- ### Review Platforms
292
-
293
- | Endpoint | Method | Description |
294
- |----------|--------|-------------|
295
- | `/yelp-search` | GET | Yelp search results |
296
- | `/yelp/reviews` | GET | Yelp business reviews |
297
- | `/tripadvisor/reviews` | GET | Tripadvisor reviews |
298
- | `/appstore/reviews` | GET | Apple App Store reviews |
299
- | `/youtube-comments` | GET | YouTube video comments |
300
- | `/g2/reviews` | GET | G2 product reviews |
301
- | `/trustpilot` | GET | Trustpilot business data |
302
- | `/trustpilot/reviews` | GET | Trustpilot reviews |
303
- | `/glassdoor/reviews` | GET | Glassdoor company reviews |
304
- | `/capterra-reviews` | GET | Capterra software reviews |
305
-
306
- ### Business Intelligence
307
-
308
- | Endpoint | Method | Description |
309
- |----------|--------|-------------|
310
- | `/emails-and-contacts` | GET | Extract emails/contacts from domains |
311
- | `/contacts-and-leads` | GET | Contacts and leads scraper (with roles) |
312
- | `/phones-enricher` | GET | Phone carrier data/validation |
313
- | `/company-insights` | GET | Company details (revenue, size, etc.) |
314
- | `/email-validator` | GET | Email address verification |
315
- | `/company-website-finder` | GET | Find company websites by name |
316
- | `/similarweb` | GET | Similarweb traffic data |
317
- | `/yellowpages-search` | GET | Yellow Pages search |
318
-
319
- ### Geolocation
320
-
321
- | Endpoint | Method | Description |
322
- |----------|--------|-------------|
323
- | `/geocoding` | GET | Address to coordinates |
324
- | `/reverse-geocoding` | GET | Coordinates to address |
325
-
326
- ### Whitepages
327
-
328
- | Endpoint | Method | Description |
329
- |----------|--------|-------------|
330
- | `/whitepages-phones` | GET | Phone number owner lookup |
331
- | `/whitepages-addresses` | GET | Address/resident lookup |
332
-
333
- ### Common Parameters
334
-
335
- Most endpoints support these parameters:
336
-
337
- | Parameter | Type | Description |
338
- |-----------|------|-------------|
339
- | `query` | string/list | Search query or queries (up to 250) |
340
- | `limit` | int | Maximum results per query |
341
- | `language` | string | Language code (e.g., 'en', 'de', 'es') |
342
- | `region` | string | Country code (e.g., 'US', 'GB', 'CA') |
343
- | `fields` | string/list | Fields to include in response |
344
- | `async` | bool | Submit async and retrieve later |
345
- | `ui` | bool | Execute as UI task |
346
- | `webhook` | string | Callback URL for completion notification |
347
-
348
- ### Account Access via API
349
-
350
- The following account features are available via API:
351
-
352
- | Feature | Endpoint | Description |
353
- |---------|----------|-------------|
354
- | Balance | `GET /profile/balance` | Current balance, account status |
355
- | Invoices | `GET /invoices` | Invoice history |
356
- | Usage | `GET /requests` | API request history |
357
- | Tasks | `GET /tasks` | UI task history |
358
-
359
- For subscription management and detailed analytics, visit <https://app.outscraper.com>
360
-
361
- ## Prerequisites
362
-
363
- - **Python 3.10+** required
364
- - **uv** recommended for package management
365
- - **Outscraper account** at <https://outscraper.com>
366
-
367
- Check Python version:
368
-
369
- ```bash
370
- python3 --version # Must be 3.10+
371
- ```
372
-
373
- ## Installation
374
-
375
- ### 1. Install via uvx (Recommended)
376
-
377
- ```bash
378
- # One-time execution (no installation needed)
379
- uvx outscraper-mcp-server
380
-
381
- # Or install permanently
382
- uv add outscraper-mcp-server
383
- ```
384
-
385
- ### 2. Install via pip
386
-
387
- ```bash
388
- pip install outscraper-mcp-server
389
- ```
390
-
391
- ### 3. Get API Key
392
-
393
- 1. Sign up at <https://outscraper.com>
394
- 2. Get your API key from <https://auth.outscraper.com/profile>
395
-
396
- ### 4. Configure Environment
397
-
398
- Add to `~/.config/aidevops/mcp-env.sh` (create if needed):
399
-
400
- ```bash
401
- export OUTSCRAPER_API_KEY="your_api_key_here"
402
- ```
403
-
404
- Set permissions:
405
-
406
- ```bash
407
- chmod 600 ~/.config/aidevops/mcp-env.sh
408
- ```
409
-
410
- Source in your shell profile:
411
-
412
- ```bash
413
- echo 'source ~/.config/aidevops/mcp-env.sh' >> ~/.zshrc
414
- source ~/.zshrc
415
- ```
416
-
417
- ## AI Tool Configurations
418
-
419
- ### OpenCode
420
-
421
- Edit `~/.config/opencode/opencode.json`:
422
-
423
- ```json
424
- {
425
- "mcp": {
426
- "outscraper": {
427
- "type": "local",
428
- "command": ["/bin/bash", "-c", "OUTSCRAPER_API_KEY=$OUTSCRAPER_API_KEY uv tool run outscraper-mcp-server"],
429
- "enabled": true
430
- }
431
- },
432
- "tools": {
433
- "outscraper_*": false
434
- }
435
- }
436
- ```
437
-
438
- The `@outscraper` subagent is automatically created by `generate-opencode-agents.sh` with:
439
-
440
- ```yaml
441
- tools:
442
- outscraper_*: true
443
- webfetch: true
444
- ```
445
-
446
- ### Claude Desktop / Claude Code
447
-
448
- **Via CLI (recommended)**:
449
-
450
- ```bash
451
- claude mcp add-json outscraper --scope user '{
452
- "type": "stdio",
453
- "command": "uvx",
454
- "args": ["outscraper-mcp-server"],
455
- "env": {"OUTSCRAPER_API_KEY": "your_api_key_here"}
456
- }'
457
- ```
458
-
459
- **Via config file** (`~/Library/Application Support/Claude/claude_desktop_config.json`):
460
-
461
- ```json
462
- {
463
- "mcpServers": {
464
- "outscraper": {
465
- "command": "uvx",
466
- "args": ["outscraper-mcp-server"],
467
- "env": {
468
- "OUTSCRAPER_API_KEY": "your_api_key_here"
469
- }
470
- }
471
- }
472
- }
473
- ```
474
-
475
- **Via Smithery (automatic)**:
476
-
477
- ```bash
478
- npx -y @smithery/cli install outscraper-mcp-server --client claude
479
- ```
480
-
481
- ### Cursor
482
-
483
- Go to Settings → Tools & MCP → New MCP Server.
484
-
485
- ```json
486
- {
487
- "mcpServers": {
488
- "outscraper": {
489
- "command": "uvx",
490
- "args": ["outscraper-mcp-server"],
491
- "env": {
492
- "OUTSCRAPER_API_KEY": "your_api_key_here"
493
- }
494
- }
495
- }
496
- }
497
- ```
498
-
499
- ### Windsurf
500
-
501
- Edit `~/.codeium/windsurf/mcp_config.json`:
502
-
503
- ```json
504
- {
505
- "mcpServers": {
506
- "outscraper": {
507
- "command": "uvx",
508
- "args": ["outscraper-mcp-server"],
509
- "env": {
510
- "OUTSCRAPER_API_KEY": "your_api_key_here"
511
- }
512
- }
513
- }
514
- }
515
- ```
516
-
517
- ### Gemini CLI
518
-
519
- Edit `~/.gemini/settings.json` (user level) or `.gemini/settings.json` (project):
520
-
521
- ```json
522
- {
523
- "mcpServers": {
524
- "outscraper": {
525
- "command": "uvx",
526
- "args": ["outscraper-mcp-server"],
527
- "env": {
528
- "OUTSCRAPER_API_KEY": "your_api_key_here"
529
- }
530
- }
531
- }
532
- }
533
- ```
534
-
535
- ### VS Code (GitHub Copilot)
536
-
537
- Create `.vscode/mcp.json` in your project root:
538
-
539
- ```json
540
- {
541
- "servers": {
542
- "outscraper": {
543
- "type": "stdio",
544
- "command": "uvx",
545
- "args": ["outscraper-mcp-server"],
546
- "env": {
547
- "OUTSCRAPER_API_KEY": "your_api_key_here"
548
- }
549
- }
550
- }
551
- }
552
- ```
553
-
554
- ### Kilo Code
555
-
556
- Click MCP server icon → Edit Global MCP:
557
-
558
- ```json
559
- {
560
- "mcpServers": {
561
- "outscraper": {
562
- "command": "uvx",
563
- "args": ["outscraper-mcp-server"],
564
- "type": "stdio",
565
- "disabled": false,
566
- "env": {
567
- "OUTSCRAPER_API_KEY": "your_api_key_here"
568
- },
569
- "alwaysAllow": ["google_maps_search", "google_search"]
570
- }
571
- }
572
- }
573
- ```
574
-
575
- ### Kiro
576
-
577
- Open command palette (Cmd+Shift+P / Ctrl+Shift+P) → "Kiro: Open user MCP config":
578
-
579
- ```json
580
- {
581
- "mcpServers": {
582
- "outscraper": {
583
- "command": "uvx",
584
- "args": ["outscraper-mcp-server"],
585
- "disabled": false,
586
- "env": {
587
- "OUTSCRAPER_API_KEY": "your_api_key_here"
588
- },
589
- "autoApprove": ["google_maps_search", "google_search"]
590
- }
591
- }
592
- }
593
- ```
594
-
595
- ### Droid (Factory.AI)
596
-
597
- Add via CLI:
598
-
599
- ```bash
600
- droid mcp add outscraper "uvx" outscraper-mcp-server --env OUTSCRAPER_API_KEY=your_api_key_here
601
- ```
602
-
603
- ## Tool Reference
604
-
605
- ### Google Maps Tools
606
-
607
- | Tool | Description |
608
- |------|-------------|
609
- | `google_maps_search` | Search businesses/places with detailed info (speed-optimized) |
610
- | `google_maps_search_v1` | Legacy Google Maps search |
611
- | `google_maps_reviews` | Extract customer reviews (speed-optimized, v3) |
612
- | `google_maps_reviews_v2` | Legacy reviews extraction |
613
- | `google_maps_photos` | Get photos from places |
614
- | `google_maps_directions` | Get directions between locations |
615
-
616
- ### Search Tools
617
-
618
- | Tool | Description |
619
- |------|-------------|
620
- | `google_search` | Organic listings, ads, related data |
621
- | `google_search_news` | Search Google News with date filtering |
622
-
623
- ### Review Extraction Tools
624
-
625
- | Tool | Description |
626
- |------|-------------|
627
- | `google_play_reviews` | App reviews from Play Store |
628
- | `amazon_reviews` | Product reviews from Amazon |
629
- | `yelp_reviews` | Business reviews from Yelp |
630
- | `tripadvisor_reviews` | Business reviews from TripAdvisor |
631
- | `apple_store_reviews` | App reviews from App Store |
632
- | `youtube_comments` | Comments from YouTube videos |
633
- | `g2_reviews` | Product reviews from G2 |
634
- | `trustpilot_reviews` | Business reviews from Trustpilot |
635
- | `glassdoor_reviews` | Company reviews from Glassdoor |
636
- | `capterra_reviews` | Software reviews from Capterra |
637
-
638
- ### Business Intelligence Tools
639
-
640
- | Tool | Description |
641
- |------|-------------|
642
- | `emails_and_contacts` | Extract emails/contacts from websites |
643
- | `contacts_and_leads` | Advanced leads scraper with contact roles |
644
- | `phones_enricher` | Validate phones, get carrier data |
645
- | `company_insights` | Company details (revenue, size, founding year) |
646
- | `validate_emails` | Validate email deliverability |
647
- | `company_websites_finder` | Find company websites by business name |
648
- | `similarweb` | Website traffic and analytics data |
649
- | `amazon_products` | Product information from Amazon |
650
-
651
- ### Search & Directory Tools
652
-
653
- | Tool | Description |
654
- |------|-------------|
655
- | `yelp_search` | Search businesses on Yelp |
656
- | `trustpilot_search` | Search companies on Trustpilot |
657
- | `trustpilot` | Get Trustpilot business data |
658
- | `yellowpages_search` | Search Yellow Pages directory |
659
-
660
- ### Whitepages Tools
661
-
662
- | Tool | Description |
663
- |------|-------------|
664
- | `whitepages_phones` | Phone number owner lookup |
665
- | `whitepages_addresses` | Address/resident insights |
666
-
667
- ### Geolocation Tools
668
-
669
- | Tool | Description |
670
- |------|-------------|
671
- | `geocoding` | Address → coordinates |
672
- | `reverse_geocoding` | Coordinates → address |
673
-
674
- ### Account & System Tools
675
-
676
- | Tool/Endpoint | Description |
677
- |---------------|-------------|
678
- | `GET /profile/balance` | Account balance, status, upcoming invoice |
679
- | `GET /invoices` | User invoice history |
680
- | `get_tasks` / `GET /tasks` | Fetch UI task history |
681
- | `POST /tasks` | Create UI task via API |
682
- | `POST /tasks-validate` | Validate/estimate task before creation |
683
- | `PUT /tasks/{id}` | Restart a task |
684
- | `DELETE /tasks/{id}` | Terminate a task |
685
- | `get_requests_history` / `GET /requests` | View recent API requests |
686
- | `get_request_archive` / `GET /requests/{id}` | Retrieve async request results |
687
- | `GET /webhook-calls` | Failed webhook calls (last 24 hours) |
688
- | `GET /locations` | Country locations for Google Maps |
689
-
690
- ## Advanced Features
691
-
692
- ### Data Enrichment
693
-
694
- Many tools support an `enrichment` parameter to add contact information:
695
-
696
- ```text
697
- Search for marketing agencies in San Francisco and enrich with email contacts.
698
- ```
699
-
700
- ### Multi-Language Support
701
-
702
- Specify language for localized results:
703
-
704
- ```text
705
- Search Google Maps for restaurants in Paris, France with reviews in French.
706
- ```
707
-
708
- ### Pagination
709
-
710
- Use `skip` and `limit` for large result sets:
711
-
712
- ```text
713
- Get Amazon reviews for product ASIN B08N5WRWNW, skip first 100, limit to 50.
714
- ```
715
-
716
- ### Time-Based Filtering
717
-
718
- Filter reviews by date with `cutoff` parameter:
719
-
720
- ```text
721
- Get recent Google Maps reviews for "Starbucks NYC" from the last 30 days.
722
- ```
723
-
724
- ## Python SDK Examples
725
-
726
- The official SDK is at <https://github.com/outscraper/outscraper-python>
727
-
728
- ### Basic Initialization
729
-
730
- ```python
731
- from outscraper import ApiClient
732
- import requests
733
-
734
- # SDK client (recommended for most operations)
735
- client = ApiClient(api_key='YOUR_API_KEY')
736
-
737
- # Direct API calls (for endpoints not in SDK)
738
- API_BASE = 'https://api.app.outscraper.com'
739
- headers = {'X-API-KEY': 'YOUR_API_KEY'}
740
- ```
741
-
742
- ### Account & Billing (Direct API Only)
743
-
744
- These endpoints are not in the Python SDK - use direct requests:
745
-
746
- ```python
747
- # Get account balance and status
748
- response = requests.get(f'{API_BASE}/profile/balance', headers=headers)
749
- balance_info = response.json()
750
- print(f"Balance: ${balance_info.get('balance', 0):.2f}")
751
- print(f"Status: {balance_info.get('account_status')}")
752
-
753
- # Get invoice history
754
- response = requests.get(f'{API_BASE}/invoices', headers=headers)
755
- invoices = response.json()
756
- for invoice in invoices:
757
- print(f"Invoice {invoice['id']}: ${invoice['amount']}")
758
- ```
759
-
760
- ### Task Management (Direct API + SDK)
761
-
762
- ```python
763
- # Create a task via API (not in SDK)
764
- task_data = {
765
- "service": "google_maps_search",
766
- "query": ["coffee shops manhattan"],
767
- "limit": 50
768
- }
769
-
770
- # Validate first to get cost estimate (not in SDK)
771
- response = requests.post(f'{API_BASE}/tasks-validate', headers=headers, json=task_data)
772
- estimate = response.json()
773
- print(f"Estimated cost: ${estimate.get('estimated_cost', 0):.2f}")
774
-
775
- # Create the task (not in SDK)
776
- response = requests.post(f'{API_BASE}/tasks', headers=headers, json=task_data)
777
- task = response.json()
778
- task_id = task['id']
779
-
780
- # Check task status via SDK (in SDK)
781
- tasks, has_more = client.get_tasks(page_size=1)
782
-
783
- # Terminate task if needed (not in SDK)
784
- requests.delete(f'{API_BASE}/tasks/{task_id}', headers=headers)
785
- ```
786
-
787
- ### System Request Management (SDK Methods)
788
-
789
- ```python
790
- # Get your UI task history
791
- tasks, has_more = client.get_tasks(query='restaurants', page_size=10)
792
- for task in tasks:
793
- print(f"Task: {task['id']} - {task.get('status')}")
794
-
795
- # Get your recent API requests
796
- finished_requests = client.get_requests_history(type='finished', page_size=25)
797
- running_requests = client.get_requests_history(type='running')
798
-
799
- # Retrieve async request results
800
- result = client.get_request_archive(request_id='abc123')
801
- if result['status'] == 'Completed':
802
- data = result['data']
803
- ```
804
-
805
- ### Async Request Pattern
806
-
807
- ```python
808
- # Submit async request for large queries
809
- results = client.google_maps_search(
810
- 'restaurants brooklyn usa',
811
- limit=100,
812
- async_request=True # Returns request ID immediately
813
- )
814
- request_id = results['id']
815
-
816
- # Poll for results (SDK handles this automatically if async_request=False)
817
- import time
818
- while True:
819
- result = client.get_request_archive(request_id)
820
- if result['status'] != 'Pending':
821
- break
822
- time.sleep(5)
823
-
824
- data = result.get('data', [])
825
- ```
826
-
827
- ### Webhook Integration
828
-
829
- ```python
830
- # Use webhooks for async notification
831
- results = client.google_maps_reviews(
832
- 'ChIJrc9T9fpYwokRdvjYRHT8nI4',
833
- reviews_limit=100,
834
- async_request=True,
835
- webhook='https://your-server.com/outscraper-callback'
836
- )
837
- # Outscraper will POST results to your webhook URL when complete
838
- ```
839
-
840
- ## Usage Examples
841
-
842
- ### Local Business Research
843
-
844
- ```text
845
- Search for "plumbers" near "Austin, TX" on Google Maps. For the top 10 results,
846
- get their ratings, review counts, and contact information.
847
- ```
848
-
849
- ### Competitive Review Analysis
850
-
851
- ```text
852
- Get the 50 most recent Trustpilot reviews for "competitor.com" and summarize
853
- the common complaints and praise points.
854
- ```
855
-
856
- ### Lead Generation
857
-
858
- ```text
859
- Find software companies in the "CRM" space using Google search, then extract
860
- email contacts from their websites.
861
- ```
862
-
863
- ### Market Research
864
-
865
- ```text
866
- Search for "electric vehicles" on Google News and return the top 20 articles
867
- from the past week with their sources and summaries.
868
- ```
869
-
870
- ## Verification
871
-
872
- **Tested tools** (Dec 2024):
873
- - `google_search` - Working perfectly
874
- - `google_maps_search` - Working (minor null field warnings, non-blocking)
875
-
876
- After configuration, test with this prompt:
877
-
878
- ```text
879
- Search for coffee shops near Times Square NYC using Google Maps search and
880
- return the top 5 results with ratings.
881
- ```
882
-
883
- The AI should:
884
-
885
- 1. Confirm access to Outscraper tools
886
- 2. Return business names, addresses, ratings
887
- 3. Include review counts and categories
888
-
889
- ## Rate Limits & Pricing
890
-
891
- - API usage is metered per request
892
- - Check pricing at <https://outscraper.com/pricing/>
893
- - Consider caching for frequently accessed data
894
- - Free tier available for testing
895
-
896
- ## Credential Storage
897
-
898
- | Method | Location | Use Case |
899
- |--------|----------|----------|
900
- | Environment | `OUTSCRAPER_API_KEY` | Local development, CI/CD |
901
- | aidevops pattern | `~/.config/aidevops/mcp-env.sh` | Consistent with other services |
902
- | Per-config | `env` block in MCP config | Tool-specific isolation |
903
-
904
- **Security**: Never commit API keys. Use environment variables or secure vaults.
905
-
906
- ## Troubleshooting
907
-
908
- ### "OUTSCRAPER_API_KEY not set"
909
-
910
- ```bash
911
- # Verify environment variable
912
- echo $OUTSCRAPER_API_KEY
913
-
914
- # Set if missing
915
- export OUTSCRAPER_API_KEY="your_key_here"
916
- ```
917
-
918
- ### "uvx: command not found"
919
-
920
- ```bash
921
- # Install uv
922
- curl -LsSf https://astral.sh/uv/install.sh | sh
923
-
924
- # Or via pip
925
- pip install uv
926
- ```
927
-
928
- ### "Connection refused" or timeout
929
-
930
- 1. Check API key validity at <https://auth.outscraper.com/profile>
931
- 2. Verify internet connectivity
932
- 3. Check Outscraper service status
933
-
934
- ### "Tool not found"
935
-
936
- 1. Ensure MCP server is enabled in config
937
- 2. Restart the AI tool after config changes
938
- 3. Check that the agent has `outscraper_*: true`
939
-
940
- ### OpenCode-specific issues
941
-
942
- **"env" key not supported**: OpenCode doesn't support the `env` key in MCP config.
943
- Use the bash wrapper pattern instead:
944
-
945
- ```json
946
- "command": ["/bin/bash", "-c", "OUTSCRAPER_API_KEY=$OUTSCRAPER_API_KEY uv tool run outscraper-mcp-server"]
947
- ```
948
-
949
- **"uvx" conflicts**: The `uvx` command may conflict with other packages.
950
- Use `uv tool run outscraper-mcp-server` instead.
951
-
952
- ### Python version errors
953
-
954
- ```bash
955
- # Check version
956
- python3 --version
957
-
958
- # Install Python 3.10+ if needed
959
- brew install python@3.12 # macOS
960
- ```
961
-
962
- ## Updates
963
-
964
- Check for configuration updates at:
965
-
966
- - Repository: <https://github.com/outscraper/outscraper-mcp>
967
- - PyPI: <https://pypi.org/project/outscraper-mcp-server/>
968
- - API Docs: <https://app.outscraper.com/api-docs>
969
-
970
- ## Related Documentation
971
-
972
- - [Crawl4AI](../browser/crawl4ai.md) - Web crawling for AI/LLM applications
973
- - [Stagehand](../browser/stagehand.md) - AI-powered browser automation
974
- - [Context7](../context/context7.md) - Library documentation lookup