Developer documentation

Build with PinglyMCP

Give people and AI agents simple website tools through one authenticated REST API or remote MCP server.

Connect MCP REST Quick Start Create API Key

OAuth or private keys

Start free with ping

Machine-readable docs

Quick start

Start in under 2 minutes

Choose the connection your client supports. Both paths use the same website tools and safety rules.

MCP

Best for MCP-capable agents

OAuth is preferred when your client supports it. Otherwise use a personal API key beginning with pmcp_ as a bearer token.

{
  "mcpServers": {
    "pinglymcp": { "url": "https://mcp.pinglymcp.com" }
  }
}

Personal-key clients send:

Authorization: Bearer pmcp_...

After connecting, call tools/list, then try ping with example.com. See authentication details for scopes and key permissions.

MCP connection details

REST

For scripts and applications

Create a personal key, keep it private, and send it in the Authorization header.

curl -X POST https://api.pinglymcp.com/ping \
  -H "Authorization: Bearer pmcp_..." \
  -H "Content-Type: application/json" \
  -d '{"target":"example.com"}'

Ping is free and validates a public target before you try paid tools.

REST API details

Choose your path

Start with the connection your product already supports.

MCP client

Use OAuth when your client supports it. Use a personal key for local clients and simple setup.

Connect MCP

REST application

Use a personal key or OAuth access token from your backend and call the same website services.

Use REST

Try it in the docs

Open quick start

Service catalog

Website tools at a glance

View full REST reference

Ping

Free · 0 credits

Check public IPv4 addresses, IPv6 addresses, and domain names for network reachability. Costs 0 credits.

FreeRead-only

REST POST /ping

MCP ping

Describe Website

1 credits

Render a public website, capture its viewport before AI analysis, and return a description, screenshot URL, and visible navigation links. Costs 1 credits.

Costs creditsRead-only

REST POST /website/describe

MCP describe_website

Contact Website

1–10 credits with optional AI

Contact a website owner from a public URL by email or contact form, with optional AI-assistance for difficult form workflows. Costs 1 credits when completed without AI, or 10 credits when AI assistance is used.

Costs creditsExternal action · confirmation recommended

REST POST /contacts/send

MCP contact_website

Billing actions are separate

Billing action

Billing endpoints and MCP tools cost 0 service credits, require the matching billing permission, and can move money or change a recurring plan. Review previews, get the account owner's approval, use sandbox mode while testing, and reuse the same operation key for a safe retry.

Read billing and credits

Operate safely

Clear costs. Clear effects.

The short rules that keep automated workflows understandable and reversible.

Keep keys private

Store personal keys as secrets. They are shown once and should never appear in logs or shared output.

Check balance first

Use get_credit_balance or the credits endpoint before paid work.

Contact has real effects

Ask for confirmation before sending. If submission is uncertain, inspect the result before retrying.

Billing needs an owner

Use the right billing permission, review the operation, and use the same operation key for retries in sandbox or live mode.

Ready to connect?

Start with MCP for an agent, REST for an application, or create a key for either path.

Connect MCP Use REST Create API Key

For agents

Built for humans. Discoverable by agents.

Use the same resources in a browser, an agent prompt, or an automated setup flow.

llms.txt

A short index of the public docs and safe billing rules.

Open index

llms-full.txt

The complete catalog, examples, arguments, and billing reference.

Open full reference

SKILL.md

Reusable connection and safety instructions with no credentials.

·Download SKILL.md

MCP discovery

Authorized clients can use tools/list for current permissions and tool names.

Connect MCP