Meta & Health

Public discovery routes for humans, agents, SDKs, and operators. This page covers the API landing page, the canonical SaaSignal agent skill, OpenAPI and AI docs, health probes, OAuth protected-resource metadata, and the MCP transport endpoint.

These routes are especially useful when you are integrating SaaSignal from a browser, CLI, SDK, or agent runtime. Most are public; the MCP transport itself still requires OAuth or an API key.

Discovery & Docs

Landing pages and machine-readable specs for humans, SDKs, and AI agents.

API Landing Page

GET

typescript

const markdown = await ss.meta.landing()

Open Dashboard → API Console
Select GET / and run it to inspect the public discovery response from Chrome
Open the API host directly in a new tab when you want the full HTML landing page instead of markdown

SaaSignal Agent Skill

GET

typescript

const skill = await ss.meta.saasignalSkill()

Open Dashboard → API Console
Select GET /skills/saasignal and run it to inspect the canonical agent onboarding guide
Use this route when you want an AI agent to choose between MCP, REST, the SDK, and the CLI without guessing

This route is the single-source SaaSignal skill document used by the public API, SDK helpers, and the MCP helper tool.

LLM Docs Index

GET

typescript

const llms = await ss.meta.llmsTxt()

Open Dashboard → API Console
Select GET /llms.txt and run it to inspect the llmstxt.org-compliant index
Use the response headers pane to confirm caching metadata like ETag

Full LLM-Optimized Docs

GET

typescript

const llmsFull = await ss.meta.llmsFullTxt()

Open Dashboard → API Console
Select GET /llms-full.txt and run it to inspect the AI-focused docs payload
Use the response headers pane to confirm caching metadata like ETag and X-Markdown-Tokens

Human Markdown Docs

GET

typescript

const docs = await ss.meta.humanDocs()

Open Dashboard → API Console
Select GET /to-humans.md and run it to preview the markdown reference in Chrome
Use this route when you want an agent-friendly but still human-readable export of the full API surface

OpenAPI Spec

GET

typescript

const spec = await ss.meta.openApiSpec()

Open Dashboard → API Console
Select GET /api/openapi.json and run it to inspect the raw OpenAPI document
Use the JSON response directly in code generators, Postman imports, or contract diff tooling

Scalar API Reference

GET

typescript

const scalarUrl = ss.meta.scalarUrl()
window.open(scalarUrl, '_blank')

Open Dashboard → API Console
Click Open Scalar in the header to launch the hosted interactive reference
Or call GET /scalar directly from the console if you want to inspect the HTML response itself

robots.txt

GET

typescript

const robots = await ss.meta.robotsTxt()

Open Dashboard → API Console
Select GET /robots.txt and run it to inspect crawler directives
Validate that the file points crawlers to the public meta surfaces and sitemap

XML Sitemap

GET

typescript

const sitemap = await ss.meta.sitemapXml()

Open Dashboard → API Console
Select GET /sitemap.xml and run it to inspect the public route inventory
Use the XML response to verify that public docs and health surfaces stay discoverable

Health & Readiness

Operational probes for uptime checks, orchestration, and monitoring.

Liveness Probe

GET

typescript

const result = await ss.meta.livez()

Open Dashboard → API Console
Select GET /livez and run it for a fast process-level health check
Use this endpoint for shallow uptime monitors that only need to know the worker is answering requests

Readiness Probe

GET

typescript

const result = await ss.meta.readyz()

Open Dashboard → API Console
Select GET /readyz and run it to verify the worker can reach dependencies like D1
Inspect the JSON checks object when you are debugging a degraded deployment

Combined Health Probe

GET

typescript

const result = await ss.meta.healthz()

Open Dashboard → API Console
Select GET /healthz and run it for the combined liveness and readiness view
Use this route when you want one browser-checkable JSON response with status, uptime, version, and dependency checks

OAuth Metadata & MCP

Protected-resource discovery documents and the Streamable HTTP MCP entrypoint.

API Protected Resource Metadata

GET

typescript

const metadata = await ss.meta.apiProtectedResourceMetadata()

Open Dashboard → API Console
Select GET /.well-known/oauth-protected-resource and run it to inspect API OAuth discovery data
Use this document when wiring CLI or SDK OAuth flows against the regular SaaSignal HTTP API

MCP Protected Resource Metadata

GET

typescript

const metadata = await ss.meta.mcpProtectedResourceMetadata()

Open Dashboard → API Console
Select GET /.well-known/oauth-protected-resource/mcp and run it to inspect MCP OAuth discovery data
Use the response when configuring MCP clients that support the browser authorization flow

MCP JSON-RPC Transport

GET

typescript

const tools = await ss.meta.mcp({ method: 'tools/list', params: {} })

Open Dashboard → API Console and select an organization plus project
Choose POST /mcp from the route list, then edit the JSON-RPC body in the request builder
Run the request to proxy it through the dashboard session and inspect the MCP response directly from Chrome

The dashboard proxy handles authentication for browser testing, while production MCP clients should use OAuth discovery or an API key fallback.