ManualWorks MCP Server

1

Add it to Claude Code

Run this in a terminal.

Run in terminal
claude mcp add -e "MANUALWORKS_BASE_URL=${MANUALWORKS_BASE_URL}" -e "MANUALWORKS_API_UUID=${MANUALWORKS_API_UUID}" manual-works-mcp -- npx -y mcp-remote http://localhost:8000/mcp
Required:MANUALWORKS_BASE_URLMANUALWORKS_API_UUID+ 2 optional
README.md

Enables keyword searching across ManualWorks documents.

manual-works-mcp

ManualWorks 문서 검색을 위한 MCP(Model Context Protocol) 서버입니다.

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 Desktop 설정

Claude Desktop 메뉴에서 File > Settings > Developer > Edit Config를 클릭하여 설정 파일을 엽니다.

설정 파일 경로:

  • Windows: %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 Tools

`search_documents`

키워드로 ManualWorks 문서를 검색합니다.

  • 파라미터: keyword (string) - 검색할 키워드
  • 동작: 모든 문서의 장(chapter) 내용을 가져와 키워드 매칭 후 결과를 반환
  • 반환: 매칭된 문서 제목, 장 제목, URL, 매칭된 내용 snippet

라이선스

Apache-2.0

Tools (1)

search_documentsSearches for ManualWorks documents by keyword and returns matching snippets and URLs.

Environment Variables

MANUALWORKS_BASE_URLrequiredManualWorks server URL
MANUALWORKS_API_UUIDrequiredAPI UUID for authentication
MANUALWORKS_MCP_HOSTMCP server binding host
MANUALWORKS_MCP_PORTMCP server port

Configuration

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

Try it

Search for 'authentication' in the ManualWorks documentation.
Find documentation snippets related to 'API configuration'.
What does the manual say about setting up the server?
Search for all chapters mentioning 'deployment' in ManualWorks.

Frequently Asked Questions

What are the key features of ManualWorks MCP?

Provides keyword search functionality for ManualWorks documentation. Aggregates document and chapter APIs to retrieve content. Returns document titles, chapter titles, URLs, and content snippets. Enables natural language querying for documentation when native search is missing.

What can I use ManualWorks MCP for?

Quickly finding specific technical instructions within large internal documentation sets. Retrieving direct links to relevant documentation chapters via natural language queries. Integrating ManualWorks documentation search directly into the Claude Desktop interface.

How do I install ManualWorks MCP?

Install ManualWorks MCP by running: pip install -e .

What MCP clients work with ManualWorks MCP?

ManualWorks MCP works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep ManualWorks MCP docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Need the old visual installer? Open Conare IDE.
Open Conare