AI logo
AI
指引
API
博客
贡献
指引
API
博客
贡献
简体中文

Lynx Docs MCP

一个 MCP 服务器，从 Lynx 官网 提供适用于 LLM 的文档，并带有精心设计的提示。

@lynx-js/docs-mcp-server 允许您的编码代理（例如 Gemini、Claude、Cursor 或 Copilot）访问 Lynx 文档， 以协助您完成开发任务。因此，我们专门优化了 llms.txt， 它是文档站点的精简版本，专为大型模型阅读而优化。

要求

入门指南

将以下配置添加到您的 MCP 客户端：

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

@lynx-js/docs-mcp-server 最适合支持 Server Instructions 的 MCP 客户端，例如 Claude Code。

如果您发现您的 MCP 客户端无法识别 MCP 服务器，您可以手动提供以下说明： （例如，在您的 AGENTS.md、CLAUDE.md 文件中，或者直接将其与您的问题一起发送）：

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

使用 Claude Code CLI 添加 Lynx Docs MCP 服务器（指南）：


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

按照配置 MCP 指南进行操作。

使用上述标准配置。您还可以使用 Codex CLI 安装 Lynx Docs MCP 服务器：


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

请按照 MCP 安装指南 guide 进行操作，

并使用上述标准配置。您还可以使用 VS Code CLI 安装 Lynx Docs MCP 服务器：


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

手动安装：

前往"Cursor Settings"->"MCP"->"新建 MCP 服务器"。使用上面提供的配置。

Gemini CLI

使用 Gemini CLI 安装 Lynx Docs MCP 服务器。

项目级配置：


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

全局配置：


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

或者，您可以参考MCP 指南，并使用上述标准配置。

致谢

本项目灵感来源于 Svelte MCP 服务器。实现和文档均参考了原始 MCP 服务器并进行了调整。

除非另有说明，本项目采用知识共享署名 4.0 国际许可协议进行许可，代码示例采用 Apache License 2.0 许可协议进行许可。