On this page

Omnillink for AI agents

A language model reads raw HTML badly: menus, scripts and banners drown the text. /content gives it the readable part of the page.

Markdown in one request

Terminal
curl "https://omnillink.kayzen-lyon.com/api/v1/content?url=https%3A%2F%2Fexample.com%2Fblog%2Flaunch&format=markdown"
  • format=json (default) returns title, excerpt, text, markdown, wordCount, readingTimeMinutes, plus the links and images of the content.
  • format=markdown and format=text return the text alone, ready to drop into a prompt.
  • citations=true replaces links with numbered references, with the list of addresses at the end.
  • mainContent=false keeps the whole page instead of the main content only; include and exclude take CSS selectors.

Keeping the size under control

Text and Markdown are cut at 500,000 characters; the truncated field reports it. wordCount lets you estimate the cost of a call before sending the text to a model.

Turning it into a tool

The OpenAPI document describes every endpoint with its parameters: most agent frameworks can derive a tool definition from it.

Terminal
curl "https://omnillink.kayzen-lyon.com/api/v1/openapi.json"

MCP server

The Model Context Protocol lets an agent call Omnillink as a set of tools. There are two ways to connect: an endpoint hosted by the instance, and a local server started by your client.

Hosted endpoint

POST /mcp speaks the stateless HTTP transport: one JSON-RPC 2.0 message per request, a JSON answer, no session. Methods: initialize, ping, tools/list and tools/call. One tool call counts as one request of the quota; x-api-key is honoured.

Terminal
curl -X POST "https://omnillink.kayzen-lyon.com/mcp" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Local server (stdio)

The @omnillink/mcp package, in packages/mcp, is an MCP server over stdio, started by your client. It needs Node.js 20 or newer.

ToolUse it toReturns
omnillink_contentUse it toRead an article or a documentation pageReturnsMarkdown, in parts when long
omnillink_metaUse it toIdentify a link: title, description, image, feedsReturnsJSON
omnillink_extractUse it toPull precise values with CSS selectorsReturnsJSON
omnillink_screenshotUse it toSee a pageReturnsAn image
omnillink_pdfUse it toKeep a page as a fileReturnsThe path of the saved PDF
Claude Code
claude mcp add \
  --env OMNILLINK_URL=https://links.example.com \
  --env OMNILLINK_API_KEY=your-key \
  omnillink -- npx -y @omnillink/mcp
Claude Desktop, Cursor
{
  "mcpServers": {
    "omnillink": {
      "command": "npx",
      "args": [
        "-y",
        "@omnillink/mcp"
      ],
      "env": {
        "OMNILLINK_URL": "https://links.example.com",
        "OMNILLINK_API_KEY": "your-key"
      }
    }
  }
}
  • Claude Desktop: Settings, Developer, Edit Config (claude_desktop_config.json).
  • Cursor: ~/.cursor/mcp.json for all projects, or .cursor/mcp.json for one.
  • OMNILLINK_URL names your instance; without it the server uses the demo instance. OMNILLINK_API_KEY requires OMNILLINK_URL: the server refuses to send a key to the default instance.
  • From a checkout of the repository, replace npx -y @omnillink/mcp with node /absolute/path/to/packages/mcp/dist/bin.js. Publication of the package on the npm registry is not confirmed at this time.

llms.txt files

This site publishes /llms.txt, a table of contents of the documentation, and /llms-full.txt, which holds its full text in a single file.

Extracted content comes from a third-party site. Treat it as untrusted data: it may contain instructions meant to hijack an agent.

Keyboard shortcuts

CtrlKor/
Open search and commands
?
Show this help
←→
Move from one tab to the next
Ctrl↵
Run the request in the playground
Esc
Close a panel or a menu

Single-key shortcuts can be turned off in the accessibility options.