nabchan-mcp-server

基本能力

产品定位

nabchan-mcp-server是一个实验性的MCP服务器，旨在为开发者提供Nablarch文档的快速访问和搜索功能。

核心功能

1. 文档读取：通过read_document API返回指定URL的Nablarch文档内容。
2. 文档搜索：通过search_document API在Nablarch文档中进行全文检索。
3. SSE通信：支持通过Server-Sent Events与客户端进行实时通信。

适用场景

1. 开发辅助：在开发过程中快速查询Nablarch文档。
2. 文档检索：通过关键词搜索Nablarch文档中的相关内容。
3. 集成开发环境：与VSCode等IDE集成，提供文档查询功能。

工具列表

1. Whoosh：全文检索库，用于构建和搜索文档索引。
2. Janome：形态素分析库，用于日语文档的分词处理。
3. BeautifulSoup：HTML解析库，用于从Nablarch文档中提取文本内容。

常见问题解答

1. 如何启动Docker容器？ bash docker run -p 8000:8000 ghcr.io/backpaper0/nabchan-mcp-server
2. 如何构建索引？ bash uv run -m nabchan_mcp_server.build_index
3. 如何配置VSCode？ 参考README中的VSCode配置示例。

使用教程

使用依赖

1. Python 3.11：确保系统已安装Python 3.11。
2. uv：Python包管理工具。
3. Git：用于克隆仓库和子模块管理。
4. Docker：用于容器化部署。

安装教程

1. 克隆仓库 bash git clone https://github.com/backpaper0/nabchan-mcp-server.git cd nabchan-mcp-server git submodule init git submodule update
2. 构建索引 bash uv run -m nabchan_mcp_server.build_index
3. 启动服务器 bash uv run -m nabchan_mcp_server.main --transport sse

调试方式

1. 检查Docker容器 bash docker ps
2. 测试API 使用curl或其他HTTP客户端测试read_document和search_documentAPI。 bash curl http://localhost:8000/sse

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。