whisper-windows-mcp 2.0.0 → 2.2.0
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.
- package/.github/ISSUE_TEMPLATE/bug_report.md +42 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +29 -0
- package/.github/ISSUE_TEMPLATE/gpu_test_result.md +32 -0
- package/.github/pull_request_template.md +28 -0
- package/CODE_OF_CONDUCT.md +30 -0
- package/CONTRIBUTING.md +89 -0
- package/README.ja.md +176 -89
- package/README.md +60 -10
- package/ROADMAP.ja.md +190 -43
- package/SECURITY.md +35 -0
- package/TROUBLESHOOTING.ja.md +77 -0
- package/dist/index.js +555 -30
- package/package.json +1 -1
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Something isn't working correctly
|
|
4
|
+
title: '[BUG] '
|
|
5
|
+
labels: bug
|
|
6
|
+
assignees: ''
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## What happened
|
|
10
|
+
|
|
11
|
+
<!-- Describe what went wrong -->
|
|
12
|
+
|
|
13
|
+
## Steps to reproduce
|
|
14
|
+
|
|
15
|
+
1.
|
|
16
|
+
2.
|
|
17
|
+
3.
|
|
18
|
+
|
|
19
|
+
## Expected behavior
|
|
20
|
+
|
|
21
|
+
<!-- What should have happened instead -->
|
|
22
|
+
|
|
23
|
+
## Environment
|
|
24
|
+
|
|
25
|
+
- **OS:** Windows [version — run `winver`]
|
|
26
|
+
- **Node.js:** [run `node --version`]
|
|
27
|
+
- **whisper-windows-mcp version:** [shown in Claude Desktop Settings → Developer]
|
|
28
|
+
- **GPU:** [model name]
|
|
29
|
+
- **Vulkan build:** Yes / No
|
|
30
|
+
- **Model:** [e.g. ggml-medium.en.bin, ggml-large-v3.bin]
|
|
31
|
+
|
|
32
|
+
## Error output
|
|
33
|
+
|
|
34
|
+
<!-- Paste any error messages here -->
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
error output here
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Additional context
|
|
41
|
+
|
|
42
|
+
<!-- Anything else that might help — file format, file duration, language, etc. -->
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest a new feature or improvement
|
|
4
|
+
title: '[FEATURE] '
|
|
5
|
+
labels: enhancement
|
|
6
|
+
assignees: ''
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## What problem would this solve
|
|
10
|
+
|
|
11
|
+
<!-- Describe the use case. What are you trying to do that isn't possible or is difficult right now? -->
|
|
12
|
+
|
|
13
|
+
## Proposed solution
|
|
14
|
+
|
|
15
|
+
<!-- How would you like this to work? Be as specific as you can. -->
|
|
16
|
+
|
|
17
|
+
## Alternatives considered
|
|
18
|
+
|
|
19
|
+
<!-- Have you tried other approaches? What didn't work? -->
|
|
20
|
+
|
|
21
|
+
## Hardware context
|
|
22
|
+
|
|
23
|
+
<!-- Relevant if this is GPU/model related -->
|
|
24
|
+
- GPU:
|
|
25
|
+
- Model size you're using:
|
|
26
|
+
|
|
27
|
+
## Additional context
|
|
28
|
+
|
|
29
|
+
<!-- Anything else — links to similar implementations, whisper.cpp flags that might support this, etc. -->
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: GPU test result
|
|
3
|
+
about: Share your GPU acceleration test results to help other users
|
|
4
|
+
title: '[GPU] '
|
|
5
|
+
labels: hardware-report
|
|
6
|
+
assignees: ''
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Hardware
|
|
10
|
+
|
|
11
|
+
- **GPU:**
|
|
12
|
+
- **VRAM:**
|
|
13
|
+
- **CPU:**
|
|
14
|
+
- **RAM:**
|
|
15
|
+
|
|
16
|
+
## Test
|
|
17
|
+
|
|
18
|
+
- **Model used:** [e.g. ggml-medium.en.bin, ggml-large-v3.bin]
|
|
19
|
+
- **File duration:** [e.g. 5 minutes]
|
|
20
|
+
- **Language:**
|
|
21
|
+
|
|
22
|
+
## Results
|
|
23
|
+
|
|
24
|
+
- **GPU utilization during transcription:** [e.g. 20%]
|
|
25
|
+
- **Time to complete:**
|
|
26
|
+
- **CPU utilization during transcription:**
|
|
27
|
+
- **Vulkan build:** Yes / No
|
|
28
|
+
- **Any issues:**
|
|
29
|
+
|
|
30
|
+
## Notes
|
|
31
|
+
|
|
32
|
+
<!-- Anything else worth knowing for users with similar hardware -->
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
## What this PR does
|
|
2
|
+
|
|
3
|
+
<!-- Brief description of the change -->
|
|
4
|
+
|
|
5
|
+
## Type of change
|
|
6
|
+
|
|
7
|
+
- [ ] Bug fix
|
|
8
|
+
- [ ] New feature
|
|
9
|
+
- [ ] Documentation update
|
|
10
|
+
- [ ] Performance improvement
|
|
11
|
+
- [ ] Other
|
|
12
|
+
|
|
13
|
+
## Testing
|
|
14
|
+
|
|
15
|
+
- [ ] Tested on Windows
|
|
16
|
+
- [ ] Built successfully (`npm run build`)
|
|
17
|
+
- [ ] Tested in Claude Desktop with a real audio file
|
|
18
|
+
|
|
19
|
+
## Checklist
|
|
20
|
+
|
|
21
|
+
- [ ] Version bumped in `package.json` and `src/index.ts`
|
|
22
|
+
- [ ] README updated if new tools or parameters added
|
|
23
|
+
- [ ] TROUBLESHOOTING.md updated if fixing a known issue
|
|
24
|
+
- [ ] No new external runtime dependencies added
|
|
25
|
+
|
|
26
|
+
## Related issues
|
|
27
|
+
|
|
28
|
+
<!-- Closes #xxx -->
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our standards
|
|
4
|
+
|
|
5
|
+
This project is built to be useful to a wide range of people — developers, journalists, legal professionals, researchers, language students, video editors, and anyone else who needs local audio transcription on Windows.
|
|
6
|
+
|
|
7
|
+
We expect contributors and community members to:
|
|
8
|
+
|
|
9
|
+
- Be respectful and constructive in issues and pull requests
|
|
10
|
+
- Focus feedback on the work, not the person
|
|
11
|
+
- Accept that different people have different use cases and hardware setups
|
|
12
|
+
- Help newcomers get set up — not everyone is a developer
|
|
13
|
+
|
|
14
|
+
## Unacceptable behavior
|
|
15
|
+
|
|
16
|
+
- Harassment, personal attacks, or discriminatory language
|
|
17
|
+
- Dismissing bug reports because they involve non-English languages or non-NVIDIA hardware
|
|
18
|
+
- Spam or off-topic promotion
|
|
19
|
+
|
|
20
|
+
## Enforcement
|
|
21
|
+
|
|
22
|
+
Issues or pull requests that violate these standards will be closed. Repeat violations may result in being blocked from the repository.
|
|
23
|
+
|
|
24
|
+
## Reporting
|
|
25
|
+
|
|
26
|
+
If you experience or witness unacceptable behavior, open a private vulnerability report or contact the maintainer directly through GitHub.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
This Code of Conduct is intentionally minimal. The goal is a functional, welcoming project — not bureaucracy.
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Contributing to whisper-windows-mcp
|
|
2
|
+
|
|
3
|
+
Thanks for your interest in contributing. This is a Windows-native MCP server for local audio transcription — contributions that improve Windows compatibility, GPU support, and usability for non-technical users are especially welcome.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Before you start
|
|
8
|
+
|
|
9
|
+
Check the [open issues](https://github.com/eviscerations/whisper-windows-mcp/issues) before starting work to avoid duplicating effort. If you want to work on something not listed, open an issue first to discuss it.
|
|
10
|
+
|
|
11
|
+
See [ROADMAP.md](ROADMAP.md) for planned features and known bugs.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## What we need most
|
|
16
|
+
|
|
17
|
+
- **GPU acceleration testing** — if you've tested on NVIDIA, Intel Arc, or AMD hardware not listed in the README, please share your results (GPU model, VRAM, model size, observed throughput)
|
|
18
|
+
- **Bug reports with reproduction steps** — especially for Windows-specific issues
|
|
19
|
+
- **Multilingual testing** — results with non-English audio and the large-v3 model
|
|
20
|
+
- **Documentation improvements** — especially for non-English speakers
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Development setup
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
git clone https://github.com/eviscerations/whisper-windows-mcp
|
|
28
|
+
cd whisper-windows-mcp
|
|
29
|
+
npm install
|
|
30
|
+
npm run build
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The server is a single TypeScript file at `src/index.ts`. The compiled output goes to `dist/`.
|
|
34
|
+
|
|
35
|
+
To test locally, update your `claude_desktop_config.json` to point at the local build:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"mcpServers": {
|
|
40
|
+
"whisper": {
|
|
41
|
+
"command": "node",
|
|
42
|
+
"args": ["C:\\path\\to\\whisper-windows-mcp\\dist\\index.js"],
|
|
43
|
+
"env": {
|
|
44
|
+
"WHISPER_CLI_PATH": "C:\\whisper\\Release\\whisper-cli.exe",
|
|
45
|
+
"WHISPER_MODEL": "C:\\whisper\\models\\ggml-medium.en.bin"
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Restart Claude Desktop after each build to pick up changes.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Pull request guidelines
|
|
57
|
+
|
|
58
|
+
- Keep PRs focused — one fix or feature per PR
|
|
59
|
+
- Test on Windows (this is a Windows-only tool)
|
|
60
|
+
- If adding a new tool, update the tool list in README.md
|
|
61
|
+
- If fixing a bug, add a note to TROUBLESHOOTING.md if it's something other users will hit
|
|
62
|
+
- Bump the version in `package.json` and the version string in `src/index.ts` before submitting
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Code style
|
|
67
|
+
|
|
68
|
+
- TypeScript, no external runtime dependencies beyond `@modelcontextprotocol/sdk`
|
|
69
|
+
- All file I/O must handle non-ASCII filenames (Unicode, Japanese, Chinese, emoji)
|
|
70
|
+
- New tools go in the `CallToolRequestSchema` handler following the existing pattern
|
|
71
|
+
- Error messages should be actionable — tell the user what to do, not just what went wrong
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Reporting bugs
|
|
76
|
+
|
|
77
|
+
Open an issue with:
|
|
78
|
+
- Your OS version (`winver`)
|
|
79
|
+
- Node.js version (`node --version`)
|
|
80
|
+
- whisper-windows-mcp version
|
|
81
|
+
- GPU model and whether you're using the Vulkan build
|
|
82
|
+
- Exact steps to reproduce
|
|
83
|
+
- Full error output if available
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## License
|
|
88
|
+
|
|
89
|
+
By contributing, you agree that your contributions will be licensed under the MIT license.
|