项目简介

DeepWiki MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在为支持 MCP 协议的 LLM 客户端(如 Cursor、Zed 等)提供访问 DeepWiki 文档网站内容的标准化接口。它可以让您的 LLM 在需要时获取特定开源项目的 DeepWiki 文档索引和详细页面内容。

主要功能点

  • 获取文档索引: 允许 LLM 根据项目的拥有者和仓库名称,获取 DeepWiki 上该项目的文档结构索引。
  • 获取页面内容: 允许 LLM 根据索引中提供的路径,获取 DeepWiki 上特定页面的详细 HTML 内容,并进行初步清理以便于 LLM 处理。
  • 标准化接口: 通过 MCP 协议暴露上述功能,使得任何支持 MCP 的客户端都能方便地集成 DeepWiki 文档能力。

安装步骤

该服务器通常通过 npm 或 npx 安装和运行。您可以直接使用 npx 命令来启动它,无需提前全局或本地安装。

服务器配置(供MCP客户端参考)

MCP 客户端(如某些编辑器或开发工具中的 LLM 功能)需要知道如何启动这个服务器进程并与之通信。典型的 MCP 客户端配置需要提供服务器的名称、启动命令及其参数。

以下是 MCP 客户端配置该服务器时所需的关键信息:

  • 服务器名称 (name): 'deepwiki'
  • 启动命令 (command): 'npx'
  • 命令参数 (args): '-y', 'deepwiki-mcp@latest'

这个配置告诉客户端使用 'npx' 命令来启动 'deepwiki-mcp@latest' 这个包,'-y' 参数用于跳过安装确认。客户端启动服务器后,将通过标准输入/输出(stdio)通道与其进行 MCP 协议通信。

例如,在支持 MCP 的客户端中,配置可能看起来像这样(具体格式取决于客户端):

{
  "mcpServers": {
    "deepwiki": { // 服务器名称
      "command": "npx", // 启动命令
      "args": ["-y", "deepwiki-mcp@latest"] // 启动参数
    }
  }
}

(注意:请查阅您的 MCP 客户端文档以获取具体的配置方法,以上 JSON 仅为概念示例,不要直接粘贴使用)

基本使用方法

作为 MCP 服务器,它不是一个独立的应用程序供用户直接交互,而是由 MCP 客户端在需要时自动启动和调用。

当您在支持 MCP 并配置了此服务器的客户端中使用 LLM 时,如果 LLM 需要获取 DeepWiki 文档信息,它将通过 MCP 协议与该服务器通信:

  1. 客户端启动 'deepwiki-mcp' 服务器进程。
  2. LLM 或客户端调用服务器提供的 'get-deepwiki-index' 工具,提供 DeepWiki 项目的拥有者和仓库名(例如:'owner: "torvalds", repo: "linux"')。
  3. 服务器请求 DeepWiki 网站获取索引数据,处理后通过 MCP 协议返回给客户端/LLM。
  4. 基于获取的索引,LLM 或客户端可以调用服务器提供的 'get-deepwiki-page' 工具,提供特定页面的路径(从索引中获取)。
  5. 服务器请求 DeepWiki 网站获取页面内容,处理后通过 MCP 协议返回给客户端/LLM。

这个过程对于最终用户通常是透明的,由客户端和 LLM 自动协调完成,为 LLM 提供相关的 DeepWiki 文档上下文。

信息

分类

开发者工具