claude-code-hwp-mcp 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +225 -83
  2. package/dist/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,67 +1,84 @@
1
1
  # claude-code-hwp-mcp
2
2
 
3
- Claude Code / Claude Desktop에서 한글(HWP) 문서를 직접 제어하는 MCP 서버.
4
- pyhwpx COM API를 통해 문서 열기, 편집, 분석, 저장, 변환까지 **85개+ 도구**를 제공합니다.
3
+ Claude Code Claude Desktop에서 한글(HWP) 문서를 AI로 자동 편집하는 MCP 서버입니다.
5
4
 
6
- > **Windows 전용** | 한글 2014 이상 | Python 3.8+ | Claude Code & Claude Desktop 지원
5
+ 85개 이상의 도구로 문서 열기, 채우기, 텍스트 편집, 서식 설정, PDF 변환까지 모두 자동화할 있습니다.
7
6
 
8
- ## 빠른 시작
7
+ > Windows 전용 | 한글 2014 이상 | Python 3.8+ | Claude Code + Claude Desktop 지원
9
8
 
10
- ```bash
11
- # 1. Python 패키지 설치
12
- pip install pyhwpx pywin32
9
+ ---
13
10
 
14
- # 2. MCP 서버 설치
15
- npm install -g claude-code-hwp-mcp
11
+ ## 설치 가이드 (처음 설정하는 분)
16
12
 
17
- # 3. 한글(HWP) 프로그램을 실행하고 빈 문서를 열어둡니다
13
+ 아래 순서대로 따라하세요. 5분이면 완료됩니다.
18
14
 
19
- # 4. Claude Code 또는 Claude Desktop에서 사용
20
- ```
15
+ ### Step 1. Python 설치
21
16
 
22
- ## 사전 요구사항
17
+ **반드시 python.org 공식 버전을 설치하세요.**
23
18
 
24
- | 요구사항 | 설치 방법 | 비고 |
25
- |----------|-----------|------|
26
- | Windows 10/11 | - | macOS/Linux 미지원 (COM API 기반) |
27
- | 한글(HWP) | 한컴오피스 설치 | 한글 2014, 2018, 2020, 2022, 2024 지원 |
28
- | Python 3.8+ | [python.org](https://www.python.org/downloads/) | **반드시 python.org에서 설치** |
29
- | Node.js 18+ | [nodejs.org](https://nodejs.org/) | LTS 버전 권장 |
19
+ 1. https://www.python.org/downloads/ 접속
20
+ 2. "Download Python 3.x.x" 버튼 클릭
21
+ 3. 설치 화면에서 **"Add Python to PATH" 체크박스를 반드시 체크**
22
+ 4. "Install Now" 클릭
30
23
 
31
- ### Python 설치 주의사항
24
+ > **Microsoft Store 버전 Python 사용하지 마세요.** Store 버전은 패키지가 격리된 경로에 설치되어 pyhwpx를 인식하지 못합니다. 이미 Store 버전이 설치되어 있다면 [Microsoft Store Python 문제 해결](#microsoft-store-python-문제) 섹션을 참고하세요.
32
25
 
33
- **python.org 공식 버전을 설치하세요.** Microsoft Store 버전(WindowsApps 경로)은 pyhwpx가 정상 동작하지 않을 수 있습니다.
26
+ 설치 확인 (명령 프롬프트에서):
34
27
 
35
- 설치 화면에서 **"Add Python to PATH"를 반드시 체크**하세요.
28
+ ```bash
29
+ python --version
30
+ ```
31
+
32
+ `Python 3.x.x`가 출력되면 성공입니다.
33
+
34
+ ### Step 2. Python 패키지 설치
35
+
36
+ 명령 프롬프트(cmd)를 열고 아래를 실행하세요:
37
+
38
+ ```bash
39
+ pip install pyhwpx pywin32
40
+ ```
36
41
 
37
42
  설치 확인:
43
+
38
44
  ```bash
39
- python --version
40
45
  pip show pyhwpx
41
46
  ```
42
47
 
43
- ## 설치
48
+ ### Step 3. Node.js 설치
44
49
 
45
- ### 방법 A: npm 글로벌 설치 (권장)
50
+ 1. https://nodejs.org/ 접속
51
+ 2. LTS 버전 다운로드 후 설치
52
+
53
+ ### Step 4. MCP 서버 설치
54
+
55
+ 명령 프롬프트에서:
46
56
 
47
57
  ```bash
48
58
  npm install -g claude-code-hwp-mcp
49
59
  ```
50
60
 
51
- 설치 pyhwpx가 없으면 자동으로 안내 메시지가 표시됩니다.
61
+ ### Step 5. Claude에 MCP 서버 연결
52
62
 
53
- ### 방법 B: GitHub 클론
63
+ 사용하는 Claude 앱에 따라 아래 설정을 진행하세요:
54
64
 
55
- ```bash
56
- git clone https://github.com/gmlcjf0326/claude-code-hwp-mcp.git
57
- cd claude-code-hwp-mcp
58
- npm install
59
- npm run build
60
- ```
65
+ - **Claude Code** 사용자 → [Claude Code 설정](#claude-code-설정) 섹션으로
66
+ - **Claude Desktop** 사용자 → [Claude Desktop 설정](#claude-desktop-설정) 섹션으로
67
+
68
+ ---
61
69
 
62
70
  ## Claude Code 설정
63
71
 
64
- `~/.claude/settings.json` 파일에 추가:
72
+ ### 설정 파일 열기
73
+
74
+ Claude Code 터미널에서 설정 파일을 엽니다. 파일 위치:
75
+
76
+ - Windows: `C:\Users\사용자이름\.claude\settings.json`
77
+ - 또는 `~/.claude/settings.json`
78
+
79
+ ### 설정 추가
80
+
81
+ `settings.json` 파일에 아래 내용을 추가하세요:
65
82
 
66
83
  ```json
67
84
  {
@@ -73,37 +90,63 @@ npm run build
73
90
  }
74
91
  ```
75
92
 
76
- GitHub 클론 방식:
93
+ 이미 다른 MCP 서버가 등록되어 있다면 `mcpServers` 안에 추가합니다:
77
94
 
78
95
  ```json
79
96
  {
80
97
  "mcpServers": {
98
+ "기존-서버": {
99
+ "command": "기존-명령"
100
+ },
81
101
  "claude-code-hwp-mcp": {
82
- "command": "node",
83
- "args": ["C:/claude-code-hwp-mcp/dist/index.js"]
102
+ "command": "hwp-mcp"
84
103
  }
85
104
  }
86
105
  }
87
106
  ```
88
107
 
89
- Python 경로를 직접 지정하려면:
108
+ ### GitHub 클론 방식으로 설치한 경우
109
+
110
+ npm 글로벌 설치 대신 GitHub에서 클론한 경우:
90
111
 
91
112
  ```json
92
113
  {
93
114
  "mcpServers": {
94
115
  "claude-code-hwp-mcp": {
95
- "command": "hwp-mcp",
96
- "env": {
97
- "PYTHON_PATH": "C:/Python313/python.exe"
98
- }
116
+ "command": "node",
117
+ "args": ["C:\\claude-code-hwp-mcp\\dist\\index.js"]
99
118
  }
100
119
  }
101
120
  }
102
121
  ```
103
122
 
123
+ `args`의 경로를 실제 클론한 위치로 변경하세요.
124
+
125
+ ---
126
+
104
127
  ## Claude Desktop 설정
105
128
 
106
- `%APPDATA%\Claude\claude_desktop_config.json` 파일에 추가:
129
+ ### Step 1. 설정 파일 찾기
130
+
131
+ Windows 탐색기에서 주소창에 아래를 입력하고 Enter:
132
+
133
+ ```
134
+ %APPDATA%\Claude
135
+ ```
136
+
137
+ `Claude` 폴더가 열립니다.
138
+
139
+ ### Step 2. 설정 파일 만들기 또는 열기
140
+
141
+ 해당 폴더에 `claude_desktop_config.json` 파일이 있으면 메모장으로 엽니다.
142
+
143
+ 파일이 없으면 새로 만드세요:
144
+ 1. 폴더에서 마우스 우클릭 > 새로 만들기 > 텍스트 문서
145
+ 2. 파일 이름을 `claude_desktop_config.json`으로 변경 (확장자 `.txt`가 아닌 `.json`)
146
+
147
+ ### Step 3. 설정 내용 입력
148
+
149
+ 파일에 아래 내용을 그대로 붙여넣으세요:
107
150
 
108
151
  ```json
109
152
  {
@@ -115,21 +158,64 @@ Python 경로를 직접 지정하려면:
115
158
  }
116
159
  ```
117
160
 
118
- ## 사용 반드시 확인
161
+ ### Step 4. (선택) Python 경로 직접 지정
119
162
 
120
- **한글(HWP) 프로그램이 실행 중이어야 합니다.** MCP 서버는 한글 프로그램의 COM API를 통해 문서를 제어하므로, 한글이 열려 있지 않으면 도구가 동작하지 않습니다.
163
+ Python이 여러 설치되어 있거나 Microsoft Store Python 문제가 있을 경우, Python 경로를 명시적으로 지정할 있습니다:
121
164
 
122
- 1. 한글(HWP) 프로그램 실행
123
- 2. 빈 문서 하나 열어두기
124
- 3. Claude에서 작업 시작
165
+ ```json
166
+ {
167
+ "mcpServers": {
168
+ "claude-code-hwp-mcp": {
169
+ "command": "hwp-mcp",
170
+ "env": {
171
+ "PYTHON_PATH": "C:\\Users\\사용자이름\\AppData\\Local\\Programs\\Python\\Python313\\python.exe"
172
+ }
173
+ }
174
+ }
175
+ }
176
+ ```
177
+
178
+ 본인의 Python 경로를 확인하려면 명령 프롬프트에서:
125
179
 
126
- 환경 진단이 필요하면:
180
+ ```bash
181
+ python -c "import sys; print(sys.executable)"
127
182
  ```
128
- "hwp_check_setup 실행해줘"
183
+
184
+ 출력된 경로를 `PYTHON_PATH` 값으로 사용하세요.
185
+
186
+ ### Step 5. Claude Desktop 재시작
187
+
188
+ 설정 파일을 저장한 후 **Claude Desktop을 완전히 종료했다가 다시 실행**하세요. (트레이에서도 완전 종료)
189
+
190
+ ### Step 6. 연결 확인
191
+
192
+ Claude Desktop에서 아래와 같이 입력하세요:
193
+
194
+ ```
195
+ hwp_check_setup 실행해줘
129
196
  ```
130
197
 
198
+ 모든 항목에 체크 표시가 나오면 성공입니다.
199
+
200
+ ---
201
+
202
+ ## 사용 전 반드시 확인
203
+
204
+ **한글(HWP) 프로그램이 실행 중이어야 합니다.**
205
+
206
+ MCP 서버는 한글 프로그램의 COM API를 통해 문서를 제어합니다. 한글이 열려 있지 않으면 문서 관련 도구가 동작하지 않습니다.
207
+
208
+ 사용 순서:
209
+ 1. 한글(HWP) 프로그램을 실행합니다
210
+ 2. 빈 문서가 열린 상태로 둡니다
211
+ 3. Claude Code 또는 Claude Desktop에서 작업을 시작합니다
212
+
213
+ ---
214
+
131
215
  ## 사용 예시
132
216
 
217
+ Claude에게 자연어로 요청하면 됩니다:
218
+
133
219
  ```
134
220
  "C:/문서/사업계획서.hwp 파일을 열어서 분석해줘"
135
221
  "표의 계약금액 칸에 50,000,000원을 채워줘"
@@ -139,13 +225,87 @@ Python 경로를 직접 지정하려면:
139
225
  "직원_명단.xlsx의 각 행으로 위촉장.hwp를 개별 생성해줘"
140
226
  ```
141
227
 
228
+ ---
229
+
230
+ ## 문제 해결
231
+
232
+ ### Microsoft Store Python 문제
233
+
234
+ **증상**: hwp_check_setup에서 "pyhwpx 미설치" 또는 "한글 미설치"로 표시되지만 실제로는 설치되어 있음
235
+
236
+ **진단**: 명령 프롬프트에서 아래를 실행하세요:
237
+
238
+ ```bash
239
+ python -c "import sys; print(sys.executable)"
240
+ ```
241
+
242
+ 출력 경로에 `WindowsApps`가 포함되어 있으면 Microsoft Store 버전입니다:
243
+
244
+ ```
245
+ C:\Users\사용자\AppData\Local\Microsoft\WindowsApps\python.exe (Store 버전)
246
+ ```
247
+
248
+ **해결 방법 A (권장): python.org 버전으로 재설치**
249
+
250
+ 1. Windows 설정 > 앱 > "Python"을 찾아서 제거
251
+ 2. https://www.python.org/downloads/ 에서 다시 설치
252
+ 3. 설치 시 "Add Python to PATH" 반드시 체크
253
+ 4. `pip install pyhwpx pywin32` 다시 실행
254
+
255
+ **해결 방법 B: Claude 설정에서 Python 경로 지정**
256
+
257
+ Store Python을 유지한 채, MCP 설정에서 직접 경로를 지정합니다:
258
+
259
+ ```json
260
+ {
261
+ "mcpServers": {
262
+ "claude-code-hwp-mcp": {
263
+ "command": "hwp-mcp",
264
+ "env": {
265
+ "PYTHON_PATH": "C:\\Users\\사용자\\AppData\\Local\\Programs\\Python\\Python313\\python.exe"
266
+ }
267
+ }
268
+ }
269
+ }
270
+ ```
271
+
272
+ ### Python을 찾을 수 없습니다
273
+
274
+ python.org에서 Python 3.8+을 설치하세요. 설치 시 "Add Python to PATH" 체크 필수입니다. 설치 후 명령 프롬프트를 새로 열어야 합니다.
275
+
276
+ ### pyhwpx 모듈을 찾을 수 없습니다
277
+
278
+ ```bash
279
+ pip install pyhwpx pywin32
280
+ ```
281
+
282
+ ### COM class not registered
283
+
284
+ 한컴오피스 한글을 설치하세요. 설치 후 한글을 한번 실행하여 초기 설정을 완료하세요.
285
+
286
+ ### RPC 서버를 사용할 수 없습니다
287
+
288
+ 한글 프로그램을 닫고 다시 시도하세요. 작업 관리자(Ctrl+Shift+Esc)에서 Hwp.exe 프로세스가 남아있으면 종료 후 재시도하세요.
289
+
290
+ ### 환경 자동 진단
291
+
292
+ Claude에게 요청하세요:
293
+
294
+ ```
295
+ "hwp_check_setup 실행해줘"
296
+ ```
297
+
298
+ Python 경로, pyhwpx 설치 여부, 한글 프로그램 설치 및 실행 상태를 자동으로 확인합니다.
299
+
300
+ ---
301
+
142
302
  ## 기능 목록 (85개+)
143
303
 
144
304
  ### 환경/문서 관리 (6개)
145
305
 
146
306
  | 도구 | 설명 |
147
307
  |------|------|
148
- | hwp_check_setup | Python/pyhwpx/한글 설치 상태 진단 |
308
+ | hwp_check_setup | Python/pyhwpx/한글 설치 상태 자동 진단 |
149
309
  | hwp_list_files | 디렉토리 내 HWP/HWPX 파일 목록 |
150
310
  | hwp_open_document | HWP 문서 열기 (자동 백업) |
151
311
  | hwp_close_document | 문서 닫기 |
@@ -266,17 +426,7 @@ Python 경로를 직접 지정하려면:
266
426
  | hwp_export_docx | DOCX(Word) 내보내기 |
267
427
  | hwp_export_html | HTML 내보내기 |
268
428
 
269
- ## 아키텍처
270
-
271
- ```
272
- Claude Code / Claude Desktop
273
- | MCP Protocol (stdio)
274
- MCP Server (Node.js/TypeScript)
275
- | child_process (JSON stdin/stdout)
276
- Python Bridge (hwp_service.py + pyhwpx)
277
- | COM API
278
- 한글(HWP) 프로그램
279
- ```
429
+ ---
280
430
 
281
431
  ## Toolset 모드
282
432
 
@@ -293,35 +443,27 @@ Python Bridge (hwp_service.py + pyhwpx)
293
443
  }
294
444
  ```
295
445
 
296
- ## 문제 해결
297
-
298
- ### Python을 찾을 수 없습니다
446
+ ---
299
447
 
300
- python.org에서 Python 3.8+을 설치하세요. 설치 시 "Add Python to PATH" 체크 필수.
301
- Microsoft Store 버전은 권장하지 않습니다.
302
-
303
- ### pyhwpx 모듈을 찾을 수 없습니다
448
+ ## 아키텍처
304
449
 
305
- ```bash
306
- pip install pyhwpx pywin32
307
450
  ```
308
-
309
- 여러 Python이 설치된 경우 경로를 확인하세요:
310
- ```bash
311
- python -c "import sys; print(sys.executable)"
451
+ Claude Code / Claude Desktop
452
+ | MCP Protocol (stdio)
453
+ MCP Server (Node.js/TypeScript)
454
+ | child_process (JSON stdin/stdout)
455
+ Python Bridge (hwp_service.py + pyhwpx)
456
+ | COM API
457
+ 한글(HWP) 프로그램
312
458
  ```
313
459
 
314
- ### COM class not registered
315
-
316
- 한컴오피스 한글을 설치하세요. 설치 후 한글을 한번 실행하여 초기 설정을 완료하세요.
317
-
318
- ### RPC 서버를 사용할 수 없습니다
460
+ ---
319
461
 
320
- 한글을 닫고 다시 시도하세요. 작업 관리자에서 Hwp.exe 프로세스가 남아있으면 종료하세요.
462
+ ## 지원 한글 버전
321
463
 
322
- ### 한글이 열려있는데도 됩니다
464
+ 한글 2014, 2018, 2020, 2022, 2024 모두 지원합니다.
323
465
 
324
- 한글 프로그램이 실행 중이어야 COM 연결이 됩니다. hwp_check_setup으로 진단하세요.
466
+ ---
325
467
 
326
468
  ## 라이선스
327
469
 
package/dist/index.js CHANGED
@@ -20,7 +20,7 @@ const resolvedToolset = validToolsets.includes(toolset)
20
20
  const bridge = new HwpBridge();
21
21
  const server = new McpServer({
22
22
  name: 'claude-code-hwp-mcp',
23
- version: '0.2.1',
23
+ version: '0.2.2',
24
24
  });
25
25
  setupServer(server, bridge, resolvedToolset);
26
26
  const transport = new StdioServerTransport();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-code-hwp-mcp",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "description": "MCP server for HWP (한글) document automation via pyhwpx COM API. 85+ tools for document editing, analysis, and AI-powered filling.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",