API Documentation

Nuvo Code publishes a small public API surface together with discovery endpoints for agents and developers.

Newsletter API

Endpoint: POST /api/newsletter

Accepts a JSON payload with an email field and subscribes the address to the Nuvo Code newsletter.

  • Request content type: application/json
  • Success response: HTTP 200 with a JSON success payload
  • Error responses: HTTP 400 for invalid input and HTTP 500 for upstream failures

Health API

Endpoint: GET /api/health

Returns a lightweight JSON health payload with service status and a timestamp suitable for monitoring and API catalog status links.

MCP Endpoint

Endpoint: POST /mcp

Supports a lightweight JSON-RPC workflow for discovery-oriented MCP methods including initialize, tools/list, and tools/call.

  • Transport: streamable HTTP
  • Tool set: site overview, page listing, policy lookup, API catalog lookup
  • Server card: /.well-known/mcp/server-card.json

Discovery Endpoints

  • /.well-known/api-catalog
  • /.well-known/agent-skills/index.json
  • /.well-known/oauth-authorization-server
  • /.well-known/openid-configuration
  • /.well-known/oauth-protected-resource
  • /.well-known/mcp/server-card.json
  • /openapi.json

OAuth and OIDC discovery documents are published when the deployment provides the required discovery environment variables for the active identity provider.