Agent guide
Hand the whole setup to your coding agent. With one key it lists your product, adds the card to your code and checks your site. You deploy, and we review.
Before you start
Connect your agent
Our MCP server speaks Streamable HTTP at https://pluggyback.com/api/mcp. Send the key on every request as Authorization: Bearer pb_live_….
Claude Code
Run once in a terminal.
claude mcp add --transport http pluggyback https://pluggyback.com/api/mcp --header "Authorization: Bearer pb_live_YOUR_KEY"Cursor
Add to ~/.cursor/mcp.json.
{
"mcpServers": {
"pluggyback": {
"url": "https://pluggyback.com/api/mcp",
"headers": {
"Authorization": "Bearer pb_live_YOUR_KEY"
}
}
}
}VS Code
Add to .vscode/mcp.json. VS Code asks for the key and stores it, so the file holds no secret..
{
"inputs": [
{
"type": "promptString",
"id": "pluggyback-key",
"description": "Pluggyback API key",
"password": true
}
],
"servers": {
"pluggyback": {
"type": "http",
"url": "https://pluggyback.com/api/mcp",
"headers": {
"Authorization": "Bearer ${input:pluggyback-key}"
}
}
}
}Codex
Add to ~/.codex/config.toml, then set PLUGGYBACK_API_KEY in your shell.
[mcp_servers.pluggyback]
url = "https://pluggyback.com/api/mcp"
bearer_token_env_var = "PLUGGYBACK_API_KEY"Other clients
Any client that speaks Streamable HTTP.
URL: https://pluggyback.com/api/mcp
Header: Authorization: Bearer pb_live_YOUR_KEYThen ask your agent:
Use the Pluggyback MCP server to list this product on Pluggyback and add its card to this site. Read the product's address from this project, call suggest_categories, check the suggestion against what the product really does, then create_product. Call get_install_snippet with this project's framework and a placement real visitors see, add the snippet exactly as given, and follow its notes. When I have deployed, call check_install and tell me the result. If something is missing, fix what it names and check again.What the agent does
- Reads your site with suggest_categories and proposes a name, a tagline of at most 60 characters and a category.
- Registers the product with create_product. It starts as a draft.
- Adds the snippet from get_install_snippet, made for your framework with your key in it.
- Checks the install with check_install after you deploy. It names the exact problem when something is off: script missing, wrong key, different domain, or our fetch was blocked.
- Goes to review on its own. Once your domain is verified, the product is submitted and you get an email with the listing and categories the agent chose, so you can correct them.
The agent follows the same install rules as everyone:
- Put the slot where real visitors will see it. Hidden, tiny or covered slots earn nothing.
- Keep the attributes and the min-height on the div, and the data-key on the script, exactly as given.
- The script tag must be in the HTML the server sends. In React or Next.js write it as a plain <script async> element, not through a script loader component.
- The script tag goes on a page once, however many slots the page has.
- Do not restyle or wrap the card to hide its Promoted label, and do not add a fallback: the slot collapses to nothing when there is nothing to show.
- If the site sends a Content-Security-Policy header, allow https://pluggyback.com in script-src, connect-src and img-src.
- Nothing shows until the product is approved, so an empty slot right after install is expected.
Tools
whoamiNo arguments- Confirm the key works. Returns the account the key belongs to, the key's label and the account's limits.
list_categoriesNo arguments- Every category with its subcategories. Use the slug for category and acceptedCategories, and the sub key for subcategory.
suggest_categoriesurl- Read a product's https address and propose its name, tagline, category, subcategory and the categories it should accept. Nothing is saved. Pass the result to create_product, adjusted if the suggestion is wrong.
create_producturl, name?, tagline?, description?, category?, subcategory?, acceptedCategories?, acceptsAnything?- Register a product from its https address. The listing and categories are read from the site; anything you pass replaces what was read. The product starts as a draft. Next: get_install_snippet, deploy, then check_install. Once the domain is verified the product goes to review on its own. An account holds up to 20 products and a domain can be registered once.
list_productsNo arguments- Every product on the account with its status and whether its domain is verified.
get_verificationproductId- The verification token and the three ways to prove the site is the owner's: the snippet on the home page, a meta tag in the home page head, or a DNS TXT record. Any one is enough; check_install confirms it.
get_install_snippetproductId, framework, format?, placement?, slot?- The snippet for the project's framework with the product's real key filled in. Saves the slot with its format and placement. Placements: dashboard (row), under-result (row), between-sections (row), sidebar (card), end-of-post (card), after-action (card), footer (pill). Formats: row is 64 px tall and full width, card is about 300 by 140 px, pill is one 32 px line.
check_installproductId, pageUrl?- Fetch the product's site and confirm the snippet is live with the right key, and verify the domain. When an agent-registered draft becomes verified it is submitted for review and the owner is emailed. On failure, reason is script_missing, wrong_key, different_domain or fetch_blocked, and detail says what to fix.
update_settingsproductId, name?, tagline?, description?, category?, subcategory?, acceptedCategories?, acceptsAnything?, blockedTerms?, blockedProducts?, hosting?, shownElsewhere?- Change what the site shows and how the product appears. Accepted categories, blocked terms and blocked products decide which cards may show on the site. hosting switches cards on the site on or off; shownElsewhere switches the product's own card on other sites on or off. Listing and category can also be corrected: while the product is a draft or in review they change at once, a live listing change waits for a quick review, and the category is locked once live. Pass only what changes.
get_statsproductId?, from?, to?- Counted views, clicks and credits per UTC day for one product or all of them. cardViewsOnYourSite and cardClicksOnYourSite are cards shown on the product's site; timesShownElsewhere and clicksFromElsewhere are the product's own card on other sites. Only days with activity are listed. Defaults to the last 7 days, at most 90 days.
get_walletlimit?- The account's credits: balance (spendable), pending (earned, spendable after 24 hours), unsettled spend, available, and the most recent ledger entries. Credits have no cash value.
schedule_launchproductId, week?- Book a free LaunchRaid for a product in one of the coming eight launch weeks (next week if no week is given). A free launch needs an approved product with a slot seen in the last three days, a free place left that week, and no other free launch for the product within four weeks. Boost and Spotlight are bought from the dashboard.
Without MCP
The same endpoint answers plain JSON-RPC over HTTP, so any agent that can run curl can do the whole setup. Put your key in the PLUGGYBACK_API_KEY environment variable, then paste this prompt:
List this product on Pluggyback (https://pluggyback.com) and add its card to this site. Pluggyback is a network where indie software products show a small card for each other.
Use the Pluggyback API over HTTP. My API key is in the environment variable PLUGGYBACK_API_KEY. Never print it, commit it or put it in the code. Every call is a POST like this one:
curl -s https://pluggyback.com/api/mcp \
-H "Authorization: Bearer $PLUGGYBACK_API_KEY" \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"whoami","arguments":{}}}'
Change name and arguments for each step. The tool's output is JSON inside result.content[0].text. When result.isError is true, that text says what to fix.
1. whoami, to check the key works.
2. suggest_categories with {"url": "<the product's https address>"}. Check the suggested name, tagline and category against what the product really does.
3. create_product with {"url", "name", "tagline", "category", "subcategory"}. Keep the product id it returns.
4. get_install_snippet with {"productId", "framework", "placement"}. framework is html, nextjs or react, whichever this project uses. Pick a placement real visitors see.
5. Add the snippet to the code exactly as given and follow its notes.
6. Ask me to deploy, then call check_install with {"productId"}. If found is false, fix what detail says, ask me to deploy again and check again.
7. When check_install says submittedForReview, tell me the product is in review. I will get an email with the listing you chose.
The full guide is at https://pluggyback.com/agents.txtAgents can read this guide in plain text at /agents.txt.
Limits
- 120 requests a minute per key. Over that, the server answers 429 and says when to try again.
- 20 site reads per key in ten minutes, across suggest_categories, create_product and check_install.
- A missing, wrong or revoked key gets 401.