nabchan-mcp-server

[!WARNING] 这是一个实验性项目，仍有很大的改进空间。

概要

这是一个基于Nablarch的解説書，用于返回Nablarch信息的MCP服务器。

Getting started

可以使用Docker轻松尝试。

graph LR
  a[VSCode]
  b[nabchan-mcp-server<br>（Docker容器）]
  a -->|标准输入输出通信| b

请将以下设置添加到VSCode中。

{
  "mcp": {
    "inputs": [],
    "servers": {
      "nablarch-document": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "--network",
          "none",
          "-e",
          "TRANSPORT=stdio",
          "ghcr.io/backpaper0/nabchan-mcp-server",
        ]
      }
    }
  }
}

将GitHub Copilot Chat设置为Agent模式，尝试提出关于Nablarch的问题。

架构

目前采用仅在本地Python环境下运行的架构。

使用名为Whoosh的全文搜索库和名为Janome的形态素分析库来构建索引。 从解説書的HTML中提取的文本经过形态素分析后，将作为全文搜索的目标字段。 此外，还拥有标题、概要以及转换为markdown格式的内容，这些内容将通过MCP服务器提供的API使用。

graph TD
   h[Nablarch的解説書<br>（HTML文件）]
   c(文本)
   d(概要)
   t(标题)
   m(markdown)
   i[Whoosh的索引]

   h -->|使用BeautifulSoup<br>提取文本| c
   c -->|使用Janome进行形态素分析| i
   c -->|使用LLM进行摘要| d
   d --> i
   h -->|使用BeautifulSoup<br>提取标题|t
   t --> i
   h -->|使用html2text<br>转换为markdown| m
   m --> i

MCP服务器提供的API如下：

• read_document
  • 返回URL指示的Nablarch文档的markdown格式转换版本。
• search_document
  • 搜索Nablarch文档。返回的信息如下：
    • 标题
    • URL
    • 概要

必需环境

• Python 3.11
• uv
• Git
• Docker

构建索引

uv run -m tools.build_index

[!NOTE] 如果尚未获取子模块的内容，请执行git submodule init和git submodule update。

尝试搜索

uv run -m tools.search_document -q "Nablarch"

开发时的VSCode配置示例

将/path/to/nabchan-mcp-server替换为实际路径。

{
  "mcp": {
    "inputs": [],
    "servers": {
      "nablarch-document": {
        "command": "uv",
        "args": [
          "--directory",
          "/path/to/nabchan-mcp-server",
          "run",
          "-m",
          "nabchan_mcp_server.main",
        ]
      }
    }
  }
}

如果使用SSE作为传输类型，请使用以下配置。

{
  "mcp": {
    "inputs": [],
    "servers": {
      "nablarch-document": {
        "type": "sse",
        "url": "http://localhost:8000/sse"
      }
    }
  }
}

如果使用SSE，则需要提前使用以下命令启动服务器。

uv run -m nabchan_mcp_server.main --transport sse --host localhost