Nuvelics documentation
Agents

Reading these docs as an agent

The machine-readable forms of this site, and the documentation MCP server an agent can search.

This documentation site is built to be read by an agent as well as by a person. Every form below needs no sign-in.

Plain-text indexes

  • /llms.txt lists every page with its title and description, to find the page you need.
  • /llms-full.txt is the full text of every page in one file.

Markdown for any page

Every page is available as Markdown in two ways:

  • Add .md to its address, for example /docs/agents/connect-a-client.md.
  • Request the page's own address with an Accept: text/markdown header. The same URL then answers with Markdown instead of HTML.

The documentation MCP server

The site runs its own MCP server at /api/mcp, separate from the Nuvelics product server, with three tools:

  • list_pages lists the pages.
  • get_page returns one page.
  • search searches the documentation.

It needs no credential and has no connection to any organization: it reads documentation only, and it keeps no session between requests. Add this site's /api/mcp address in the assistant's connector settings, as you would the product address in Connect a client; no sign-in or consent follows.

Each IP address can send up to 60 requests a minute to /api/mcp. Above that the server answers 429 until the minute rolls over, and an agent that waits briefly can carry on.

The product server has no documentation tool

The Nuvelics MCP server that acts on your organization has no tool that returns documentation. An agent that needs to know how Nuvelics works reads it here, through the forms above, and learns what the product's tools do from the tool reference.

Report a problem with this page

On this page