Skip to main content

Building with AI

peaq documentation is optimized for AI coding assistants. Whether you’re using Claude, Cursor, GitHub Copilot, or other AI tools, you can reference our docs directly for accurate information about the peaq SDK and APIs.

LLM-Optimized Documentation

llms.txt Files

peaq docs support the llms.txt standard, making our documentation easily accessible to AI tools:
FileURLDescription
llms.txthttps://docs.peaq.xyz/llms.txtNavigation structure with page summaries
llms-full.txthttps://docs.peaq.xyz/llms-full.txtComplete documentation in plain text
These files are automatically kept in sync with our documentation.

Copy a Single Page

Click the Copy page button at the top of any docs page to copy its contents in a clean, AI-friendly format, then paste it directly into your AI assistant’s context window.

Using Cursor

MCP Server

Install the peaq docs MCP server for queryable access to our documentation directly from Cursor, Claude Desktop, or any MCP-compatible client. One-click install for Cursor:
npx @mintlify/mcp add docs.peaq.xyz

Cursor @Docs

Add peaq docs as a context source in Cursor:
  1. Open Cursor Settings → Features → Docs
  2. Add https://docs.peaq.xyz as a documentation source
  3. Reference it in any Cursor chat by typing @Docs and selecting peaq

Using Claude

Claude Projects

Create a dedicated Claude Project for peaq development:
  1. Create a new project in Claude
  2. Add https://docs.peaq.xyz/llms-full.txt as a knowledge source
  3. Set custom instructions like “Use the peaq documentation to answer questions about the peaq SDK and APIs”

Claude Code

Add the following to your .mcp.json for context-aware assistance in your terminal:
{
  "mcpServers": {
    "peaq-docs": {
      "url": "https://docs.peaq.xyz/mcp"
    }
  }
}

Prompting Tips

When prompting any AI assistant about peaq:
  • Specify the SDK — Clarify if you’re using the JavaScript SDK or interacting directly with the API so the model generates the right patterns
  • Mention the function — Be explicit about whether you’re working with peaq ID, peaq access, peaq store, peaq verify, or UMT
  • Include chain context — Mention if you’re targeting mainnet or testnet to get accurate endpoints and config values
  • Paste the relevant page — Use the Copy page button on specific docs pages and paste into your conversation for the most accurate results