CommSyncdocs
Open app
Developers

Agent discovery

The machine-readable surfaces that let AI agents and crawlers find and understand CommSync automatically — no human pointing them at a URL first.

For developers

CommSync publishes a small set of well-known, machine-readable files so an AI agent — or the crawler behind one — can figure out what CommSync is, how to authenticate, and where the MCP server lives without a human walking it through the app first. Each surface below answers one question a generic discovery process would otherwise have to guess at.

The surfaces

Crawling and training policy

/robots.txt explicitly names 18 AI crawler user agents (GPTBot, ClaudeBot, PerplexityBot, Google-Extended, and more) as welcome across the marketing site and this docs knowledge base — see robots.txt. Every group also carries a Content Signals directive:

Content-Signal: search=yes, ai-train=yes, ai-input=yes

CommSync says yes to all three signals on purpose: indexing, live AI answers (RAG/grounding), and model training. This is a deliberate positioning choice, not an oversight — the product wants maximum reach in AI answers and agent tool use.

Public marketing pages and every /docs page carry an RFC 8288 Link response header pointing at the three discovery entry points above, so an agent that already fetched the homepage doesn't need to know any well-known path in advance:

Link: </.well-known/api-catalog>; rel="api-catalog",
      </docs>; rel="service-doc",
      </llms.txt>; rel="describedby"; type="text/plain"

Markdown on request

Send Accept: text/markdown to the homepage or any /docs page and CommSync returns the underlying markdown instead of rendered HTML — same URL, no separate .md path to guess:

curl -H "Accept: text/markdown" https://commsync.ai/docs/mcp

The response carries Content-Type: text/markdown and Vary: Accept. Regular browser requests (which send Accept: text/html,...) are completely unaffected — this only fires when markdown is explicitly preferred.

Scope

Negotiation currently covers the homepage and the /docs knowledge base — the two surfaces an agent is most likely to want as clean text. The rest of the site (including the authenticated app) always returns HTML.

How it fits together

An agent with no prior knowledge of CommSync can bootstrap entirely from https://commsync.ai/:

Fetch the homepage

Either read the Link header for the catalog URL, or send Accept: text/markdown for a plain-text summary.

Read the API catalog

/.well-known/api-catalog names both HTTP surfaces — the REST API and /api/mcp — each with a link to its docs.

Read the MCP server card

/.well-known/mcp/server-card.json gives the transport, the auth header format, and a full tool-category breakdown.

Get a credential

/auth.md explains the API key model. Keys are minted in Settings → API Keys — see API keys.

Connect

POST /api/mcp with Authorization: Bearer csk_.... See MCP server for the full tool catalog.