↑ ↓ to move ↵ to open

Build with a coding agent

Give Claude Code, Codex or Cursor the exact contract.

Claude Code, Codex, Cursor and other coding agents write good Upscrape integrations when they read the real contract instead of guessing. Upscrape publishes everything an agent needs as plain Markdown. This guide is what to hand it, and what to check in the code it writes.

The quickest way

Give the agent a ready-made brief for the endpoint you need. It holds the request, the input schema, the response rules and the polling flow, written for an agent, in the language you pick:

Text
https://upscrape.com/scrapers/linkedin/capabilities/linkedin.profile.get/llm.md?stack=python

Change the platform and endpoint ID to yours, and stack to python, node or curl. Then ask, for example: "Read this brief and add a function to our app that fetches a LinkedIn profile by URL."

What else to give it

WhatWhere
One platform, every endpointhttps://upscrape.com/scrapers/PLATFORM_ID/llm.md
The whole cataloghttps://upscrape.com/scrapers/llm.md (large)
An index of every docs pagehttps://upscrape.com/llms.txt
Every docs page in one filehttps://upscrape.com/llms-full.txt
Any docs pageThe page's address plus .md, such as /docs/quickstart.md; a platform or endpoint page plus /index.md

Give the agent the smallest one that covers the task: one endpoint's brief beats the whole catalog. Markdown is better for it than the HTML pages.

Agents that fetch pages themselves can find the Markdown on their own: every docs page names it in a <link rel="alternate" type="text/markdown"> tag and a Link header.

Keep the key out of the conversation

Tell the agent to read the key from the UPSCRAPE_API_KEY environment variable. Never paste a real key into the chat or let it land in the code.

Check what it wrote

Before you ship code an agent wrote, check that it:

  • uses the exact endpoint ID and input fields from the brief;

  • reads the key from the environment, on the server, never in browser code;

  • handles both 200 (finished) and 202 (still running), and checks state and success, not only the HTTP status;

  • stops checking on a job at a deadline;

  • sends an Idempotency-Key and retries only the errors worth retrying (Errors and retries);

  • reads result fields by name and copes with one being missing, rather than assuming the example's exact shape.

Or let the agent use Upscrape directly

A coding agent can also connect to the MCP server and run endpoints while it works, for example to look at real responses before writing the parser. The setup guides for Claude Code, Codex and Cursor take a minute.

Something missing or unclear? Ask the team that builds the endpoints.