文档搜索服务

ManualWorks MCP是一个为ManualWorks提供文档搜索功能的服务器,通过组合文档列表和内容API实现关键词搜索。

  • by plainday
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 plainday/manual-works-mcp

使用说明

手工作业mcp

用于检索ManualWorks文档的模型上下文协议(MCP)服务器。

由于ManualWorks没有搜索API,因此将文档列表/内容API组合起来提供关键字搜索功能。

安装

git clone https://github.com/plainday/manual-works-mcp.git
cd manual-works-mcp

使用uv(建议)

uv venv
uv pip install -e .

使用pip

python -m venv .venv

激活虚拟环境:

# Windows
.venv\Scripts\activate

# macOS / Linux
source .venv/bin/activate

安装软件包:

pip install -e .

设置环境变量

名称说明示例 |---|---|---| | MANUALWORKS_BASE_URL | ManualWorks服务器URL | http://127.0.0.1:1975 | | MANUALWORKS_API_UUID |API UUID| 5b969d63e97cfec7 | | MANUALWORKS_MCP_HOST | MCP服务器绑定主机(可选)| 127.0.0.1 (默认)| | MANUALWORKS_MCP_PORT | MCP服务器端口(可选)| 8000 (默认)|

使用方法

运行服务器

使用uv(建议)

MANUALWORKS_BASE_URL=http://127.0.0.1:1975 MANUALWORKS_API_UUID=your-api-uuid uv run -m manual_works_mcp.server

启用pip(激活虚拟环境后)

MANUALWORKS_BASE_URL=http://127.0.0.1:1975 MANUALWORKS_API_UUID=your-api-uuid python -m manual_works_mcp.server

对于Windows,请先设置环境变量:

set MANUALWORKS_BASE_URL=http://127.0.0.1:1975
set MANUALWORKS_API_UUID=your-api-uuid
.venv\Scripts\python.exe -m manual_works_mcp.server

服务器启动后 http://127.0.0.1:8000/mcp 接收MCP请求。

使用MCP Inspector进行测试

mcp dev src/manual_works_mcp/server.py

Claude桌面设置

在Claude Desktop菜单中 文件>设置>开发人员>编辑配置单击打开设置文件。

配置文件路径:

  • 窗户: %APPDATA%\Claude\claude_desktop_config.json
  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

首先运行服务器,然后添加以下设置(需要Node.js):

{
  "mcpServers": {
    "manual-works": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "http://localhost:8000/mcp"]
    }
  }
}

设置后重新启动Claude Desktop。

MCP工具

search_documents

使用关键字搜索ManualWorks文档。

  • 参数: keyword (string)-要搜索的关键字
  • 动作: 获取所有文档的章节内容,匹配关键字并返回结果
  • 返回: 匹配的文档标题、章节标题、URL、匹配的内容snippet

许可证

阿帕奇-2.0