AI Coding Agents

Give your coding agent two things: the UQL skill, which teaches it to write UQL, and the docs, which it looks up as it goes.

Paste this into any coding agent. It sets up both, then shows that it worked:

Setup prompt

Set this repository up for UQL (uql-orm):
1. Add https://uql-orm.dev/mcp as an MCP server for this agent: HTTP transport, no key.
2. Add this line to AGENTS.md: Before writing UQL code, read `node_modules/uql-orm/skills/uql-orm/SKILL.md`: it matches the installed uql-orm.
3. Call the server's read_skill tool and tell me the first heading it returns.

Or set up each one yourself.

1. Point it at the skill

uql-orm ships an agent skill. It covers how a query is shaped, how entities are declared, the mistakes agents make most, and where each detail lives in these docs. The skill is inside the package, so each uql-orm upgrade brings the skill for that version.

Add this line to your project’s AGENTS.md, which Claude Code, Codex, Cursor, GitHub Copilot and most other agents read on their own:

AGENTS.md

Before writing UQL code, read `node_modules/uql-orm/skills/uql-orm/SKILL.md`: it matches the installed uql-orm.

2. Let it look up the docs

Over MCP

The docs MCP server at https://uql-orm.dev/mcp adds search, so the agent finds the right page without knowing its URL. It needs no key, and its three tools are read-only:

Tool	What it answers
search_docs	The pages for a topic, most relevant first, with the passage that matched
get_doc	One page as Markdown, by the path search_docs gives or by its URL
read_skill	The skill above, for a client that cannot install one

One click installs it in Cursor or VS Code:

Cursor VS Code

In a terminal agent, one command:

Claude Code

claude mcp add --transport http uql https://uql-orm.dev/mcp

Codex

codex mcp add uql --url https://uql-orm.dev/mcp

In Claude.ai or Claude Desktop, add it as a custom connector (Customize, then Connectors). Any other client takes the same URL in its MCP settings.

Or by URL, with nothing to set up

Every page here answers with Markdown when an agent asks for it, as Claude Code and Cursor do. Each page is also Markdown at its URL plus .md, such as /querying/relations.md, and /llms.txt indexes them all. An agent that can fetch URLs needs only that index:

Before writing UQL code, read https://uql-orm.dev/llms.txt and fetch the pages for the task.

To load the whole site at once, /llms-full.txt is every page in one file.