AI logo
AI
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

Lynx Docs MCP

A MCP Server providing docs for LLMs from Lynx official site, with carefully designed prompting.

@lynx-js/docs-mcp-server lets your coding agent (such as Gemini, Claude, Cursor or Copilot) access Lynx documentation to assist you in development tasks. Therefore, we have specifically optimized llms.txt, a condensed version of the documentation site optimized for LLMs.

Requirements

Getting started

Add the following config to your MCP client:

{
  "mcpServers": {
    "lynx-docs": {
      "command": "npx",
      "args": ["-y", "@lynx-js/docs-mcp-server@latest"]
    }
  }
}

@lynx-js/docs-mcp-server works best with MCP clients that supports Server Instructions, such as Claude Code. If you find your MCP client doesn't know about the MCP server, you can manually provide the following instructions (e.g. in your AGENTS.md, CLAUDE.md, or just send it along with your question):

For any questions or requirements regarding Lynx:

1. Use the "List Resources Tool" to list all Resources provided in MCP "lynx-docs".
2. First read MCP Resources "lynx-docs://llms.txt" (**REQUIRED**), this document is an ENTRYPOINT of all Lynx Docs.
3. After reading "lynx-docs://llms.txt", use the "Read MCP Resources Tool" to retrieve docs you need based on the user's questions or requirements, please read them proactively.
4. If available, prioritize obtaining Lynx-related information through MCP Resources tools over external web searches.
Claude Code

Use the Claude Code CLI to add the Lynx Docs MCP server (guide):

claude mcp add lynx-docs npx @lynx-js/docs-mcp-server@latest
Codex

Follow the configure MCP guide using the standard config from above. You can also install the Lynx Docs MCP server using the Codex CLI:

codex mcp add lynx-docs -- npx @lynx-js/docs-mcp-server@latest
Copilot / VS Code

Follow the MCP install guide, with the standard config from above. You can also install the Lynx Docs MCP server using the VS Code CLI:

code --add-mcp '{"name":"lynx-docs","command":"npx","args":["@lynx-js/docs-mcp-server@latest"]}'
Cursor

Install manually:

Go to Cursor Settings -> MCP -> New MCP Server. Use the config provided above.

Gemini CLI

Install the Lynx Docs MCP server using the Gemini CLI.

Project wide:

gemini mcp add lynx-docs npx @lynx-js/docs-mcp-server@latest

Globally:

gemini mcp add -s user lynx-docs npx @lynx-js/docs-mcp-server@latest

Alternatively, follow the MCP guide and use the standard config from above.

Credits

This project is inspired by Svelte MCP server. Both the implementation and documentation have been adapted and referenced from the original MCP server.

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.