mcp-halflist 0.2.0__tar.gz
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.
- mcp_halflist-0.2.0/.claude/settings.local.json +19 -0
- mcp_halflist-0.2.0/.gitignore +224 -0
- mcp_halflist-0.2.0/CHANGELOG.md +38 -0
- mcp_halflist-0.2.0/LICENSE +21 -0
- mcp_halflist-0.2.0/PKG-INFO +287 -0
- mcp_halflist-0.2.0/README.md +260 -0
- mcp_halflist-0.2.0/pyproject.toml +54 -0
- mcp_halflist-0.2.0/src/halflist/__init__.py +1 -0
- mcp_halflist-0.2.0/src/halflist/bench.py +88 -0
- mcp_halflist-0.2.0/src/halflist/cli.py +628 -0
- mcp_halflist-0.2.0/src/halflist/client.py +90 -0
- mcp_halflist-0.2.0/src/halflist/constants.py +7 -0
- mcp_halflist-0.2.0/src/halflist/models.py +103 -0
- mcp_halflist-0.2.0/src/halflist/report.py +715 -0
- mcp_halflist-0.2.0/src/halflist/schema_gen.py +80 -0
- mcp_halflist-0.2.0/src/halflist/suites/__init__.py +0 -0
- mcp_halflist-0.2.0/src/halflist/suites/base.py +56 -0
- mcp_halflist-0.2.0/src/halflist/suites/handshake.py +61 -0
- mcp_halflist-0.2.0/src/halflist/suites/tools.py +135 -0
- mcp_halflist-0.2.0/src/halflist/watch.py +59 -0
- mcp_halflist-0.2.0/tests/__init__.py +0 -0
- mcp_halflist-0.2.0/tests/conftest.py +16 -0
- mcp_halflist-0.2.0/tests/servers/bad_server.py +24 -0
- mcp_halflist-0.2.0/tests/servers/good_server.py +37 -0
- mcp_halflist-0.2.0/tests/test_audit.py +67 -0
- mcp_halflist-0.2.0/tests/test_bench.py +77 -0
- mcp_halflist-0.2.0/tests/test_cli.py +80 -0
- mcp_halflist-0.2.0/tests/test_report.py +167 -0
- mcp_halflist-0.2.0/tests/test_schema_gen.py +95 -0
- mcp_halflist-0.2.0/tests/test_suites/__init__.py +0 -0
- mcp_halflist-0.2.0/tests/test_suites/test_description_check.py +100 -0
- mcp_halflist-0.2.0/tests/test_suites/test_handshake.py +25 -0
- mcp_halflist-0.2.0/tests/test_suites/test_tools.py +45 -0
- mcp_halflist-0.2.0/tests/test_watch.py +46 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"permissions": {
|
|
3
|
+
"allow": [
|
|
4
|
+
"Bash(git -C /Users/sabhishekh/personal-projects/mcp-halflist config user.name \"Abhishekh Singh\")",
|
|
5
|
+
"Bash(git -C /Users/sabhishekh/personal-projects/mcp-halflist config user.email \"abhishekcp.singh67@gmail.com\")",
|
|
6
|
+
"Bash(pip install *)",
|
|
7
|
+
"Bash(python3.11 -c \"import mcp; print\\(mcp.__version__\\)\")",
|
|
8
|
+
"Bash(pip show *)",
|
|
9
|
+
"Bash(python3.11 -c ' *)",
|
|
10
|
+
"Bash(python3.11 *)",
|
|
11
|
+
"Bash(halflist *)",
|
|
12
|
+
"Bash(ruff check *)",
|
|
13
|
+
"Bash(git *)",
|
|
14
|
+
"Bash(python3 -c \"import mcp\")",
|
|
15
|
+
"Bash(python *)",
|
|
16
|
+
"Bash(awk '{print $3}')"
|
|
17
|
+
]
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
# Architecture / design docs (not for version control)
|
|
2
|
+
mcp-halflist-architecture.md
|
|
3
|
+
|
|
4
|
+
# macOS
|
|
5
|
+
.DS_Store
|
|
6
|
+
|
|
7
|
+
# Byte-compiled / optimized / DLL files
|
|
8
|
+
__pycache__/
|
|
9
|
+
*.py[codz]
|
|
10
|
+
*$py.class
|
|
11
|
+
|
|
12
|
+
# C extensions
|
|
13
|
+
*.so
|
|
14
|
+
|
|
15
|
+
# Distribution / packaging
|
|
16
|
+
.Python
|
|
17
|
+
build/
|
|
18
|
+
develop-eggs/
|
|
19
|
+
dist/
|
|
20
|
+
downloads/
|
|
21
|
+
eggs/
|
|
22
|
+
.eggs/
|
|
23
|
+
lib/
|
|
24
|
+
lib64/
|
|
25
|
+
parts/
|
|
26
|
+
sdist/
|
|
27
|
+
var/
|
|
28
|
+
wheels/
|
|
29
|
+
share/python-wheels/
|
|
30
|
+
*.egg-info/
|
|
31
|
+
.installed.cfg
|
|
32
|
+
*.egg
|
|
33
|
+
MANIFEST
|
|
34
|
+
|
|
35
|
+
# PyInstaller
|
|
36
|
+
# Usually these files are written by a python script from a template
|
|
37
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
38
|
+
*.manifest
|
|
39
|
+
*.spec
|
|
40
|
+
|
|
41
|
+
# Installer logs
|
|
42
|
+
pip-log.txt
|
|
43
|
+
pip-delete-this-directory.txt
|
|
44
|
+
|
|
45
|
+
# Unit test / coverage reports
|
|
46
|
+
htmlcov/
|
|
47
|
+
.tox/
|
|
48
|
+
.nox/
|
|
49
|
+
.coverage
|
|
50
|
+
.coverage.*
|
|
51
|
+
.cache
|
|
52
|
+
nosetests.xml
|
|
53
|
+
coverage.xml
|
|
54
|
+
*.cover
|
|
55
|
+
*.py.cover
|
|
56
|
+
.hypothesis/
|
|
57
|
+
.pytest_cache/
|
|
58
|
+
cover/
|
|
59
|
+
|
|
60
|
+
# Translations
|
|
61
|
+
*.mo
|
|
62
|
+
*.pot
|
|
63
|
+
|
|
64
|
+
# Django stuff:
|
|
65
|
+
*.log
|
|
66
|
+
local_settings.py
|
|
67
|
+
db.sqlite3
|
|
68
|
+
db.sqlite3-journal
|
|
69
|
+
|
|
70
|
+
# Flask stuff:
|
|
71
|
+
instance/
|
|
72
|
+
.webassets-cache
|
|
73
|
+
|
|
74
|
+
# Scrapy stuff:
|
|
75
|
+
.scrapy
|
|
76
|
+
|
|
77
|
+
# Sphinx documentation
|
|
78
|
+
docs/_build/
|
|
79
|
+
|
|
80
|
+
# PyBuilder
|
|
81
|
+
.pybuilder/
|
|
82
|
+
target/
|
|
83
|
+
|
|
84
|
+
# Jupyter Notebook
|
|
85
|
+
.ipynb_checkpoints
|
|
86
|
+
|
|
87
|
+
# IPython
|
|
88
|
+
profile_default/
|
|
89
|
+
ipython_config.py
|
|
90
|
+
|
|
91
|
+
# pyenv
|
|
92
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
93
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
94
|
+
# .python-version
|
|
95
|
+
|
|
96
|
+
# pipenv
|
|
97
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
98
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
99
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
100
|
+
# install all needed dependencies.
|
|
101
|
+
# Pipfile.lock
|
|
102
|
+
|
|
103
|
+
# UV
|
|
104
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
105
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
106
|
+
# commonly ignored for libraries.
|
|
107
|
+
# uv.lock
|
|
108
|
+
|
|
109
|
+
# poetry
|
|
110
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
111
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
112
|
+
# commonly ignored for libraries.
|
|
113
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
114
|
+
# poetry.lock
|
|
115
|
+
# poetry.toml
|
|
116
|
+
|
|
117
|
+
# pdm
|
|
118
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
119
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
120
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
121
|
+
# pdm.lock
|
|
122
|
+
# pdm.toml
|
|
123
|
+
.pdm-python
|
|
124
|
+
.pdm-build/
|
|
125
|
+
|
|
126
|
+
# pixi
|
|
127
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
128
|
+
# pixi.lock
|
|
129
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
130
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
131
|
+
.pixi
|
|
132
|
+
|
|
133
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
134
|
+
__pypackages__/
|
|
135
|
+
|
|
136
|
+
# Celery stuff
|
|
137
|
+
celerybeat-schedule
|
|
138
|
+
celerybeat.pid
|
|
139
|
+
|
|
140
|
+
# Redis
|
|
141
|
+
*.rdb
|
|
142
|
+
*.aof
|
|
143
|
+
*.pid
|
|
144
|
+
|
|
145
|
+
# RabbitMQ
|
|
146
|
+
mnesia/
|
|
147
|
+
rabbitmq/
|
|
148
|
+
rabbitmq-data/
|
|
149
|
+
|
|
150
|
+
# ActiveMQ
|
|
151
|
+
activemq-data/
|
|
152
|
+
|
|
153
|
+
# SageMath parsed files
|
|
154
|
+
*.sage.py
|
|
155
|
+
|
|
156
|
+
# Environments
|
|
157
|
+
.env
|
|
158
|
+
.envrc
|
|
159
|
+
.venv
|
|
160
|
+
env/
|
|
161
|
+
venv/
|
|
162
|
+
ENV/
|
|
163
|
+
env.bak/
|
|
164
|
+
venv.bak/
|
|
165
|
+
|
|
166
|
+
# Spyder project settings
|
|
167
|
+
.spyderproject
|
|
168
|
+
.spyproject
|
|
169
|
+
|
|
170
|
+
# Rope project settings
|
|
171
|
+
.ropeproject
|
|
172
|
+
|
|
173
|
+
# mkdocs documentation
|
|
174
|
+
/site
|
|
175
|
+
|
|
176
|
+
# mypy
|
|
177
|
+
.mypy_cache/
|
|
178
|
+
.dmypy.json
|
|
179
|
+
dmypy.json
|
|
180
|
+
|
|
181
|
+
# Pyre type checker
|
|
182
|
+
.pyre/
|
|
183
|
+
|
|
184
|
+
# pytype static type analyzer
|
|
185
|
+
.pytype/
|
|
186
|
+
|
|
187
|
+
# Cython debug symbols
|
|
188
|
+
cython_debug/
|
|
189
|
+
|
|
190
|
+
# PyCharm
|
|
191
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
192
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
193
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
194
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
195
|
+
# .idea/
|
|
196
|
+
|
|
197
|
+
# Abstra
|
|
198
|
+
# Abstra is an AI-powered process automation framework.
|
|
199
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
200
|
+
# Learn more at https://abstra.io/docs
|
|
201
|
+
.abstra/
|
|
202
|
+
|
|
203
|
+
# Visual Studio Code
|
|
204
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
|
205
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
206
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
|
207
|
+
# you could uncomment the following to ignore the entire vscode folder
|
|
208
|
+
# .vscode/
|
|
209
|
+
# Temporary file for partial code execution
|
|
210
|
+
tempCodeRunnerFile.py
|
|
211
|
+
|
|
212
|
+
# Ruff stuff:
|
|
213
|
+
.ruff_cache/
|
|
214
|
+
|
|
215
|
+
# PyPI configuration file
|
|
216
|
+
.pypirc
|
|
217
|
+
|
|
218
|
+
# Marimo
|
|
219
|
+
marimo/_static/
|
|
220
|
+
marimo/_lsp/
|
|
221
|
+
__marimo__/
|
|
222
|
+
|
|
223
|
+
# Streamlit
|
|
224
|
+
.streamlit/secrets.toml
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.2.0 (2026-04-28)
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
- `halflist audit` — full conformance check + benchmark in one shot
|
|
7
|
+
- Runs all suites + benchmarks all tools with a single connection
|
|
8
|
+
- Combined `AuditReport` JSON with both suites and benchmarks
|
|
9
|
+
- `halflist report` auto-detects audit JSON for markdown generation
|
|
10
|
+
- `halflist bench` — latency benchmarking per tool with p50/p95/p99 percentiles
|
|
11
|
+
- `--tool` filter (repeatable), `--all`, `--iterations/-n`, `--warmup/-w`
|
|
12
|
+
- Rich terminal output with live progress and results table
|
|
13
|
+
- JSON output (`--format json`)
|
|
14
|
+
- `halflist watch` — continuous health monitoring with JSONL output
|
|
15
|
+
- `--interval/-i`, `--count/-c`, `--log/-l` for file logging
|
|
16
|
+
- Per-probe status: ok / degraded / down
|
|
17
|
+
- `halflist report` — generate markdown or SVG badge from JSON output
|
|
18
|
+
- `--badge` for shields.io-style SVG
|
|
19
|
+
- `--format markdown` (default)
|
|
20
|
+
- `-o` to write to file
|
|
21
|
+
- Schema-based dummy argument generation reused for bench tool calls
|
|
22
|
+
- Differentiated empty vs absent tool description warnings in tools suite
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
- `--quiet` / `-q` flag now suppresses server stderr (auto-enabled with `--format json`)
|
|
26
|
+
|
|
27
|
+
## 0.1.0 (2026-04-28)
|
|
28
|
+
|
|
29
|
+
Initial release.
|
|
30
|
+
|
|
31
|
+
- `halflist check` command with stdio transport
|
|
32
|
+
- Handshake suite (6 checks)
|
|
33
|
+
- Tools suite (11 checks)
|
|
34
|
+
- Terminal output with Rich formatting
|
|
35
|
+
- JSON output (`--format json`)
|
|
36
|
+
- Schema-based dummy argument generation for tool smoke tests
|
|
37
|
+
- Suite filtering (`--suite`)
|
|
38
|
+
- CI-friendly exit codes (0 = pass, 1 = fail, 2 = transport error, 3 = config error)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Abhishekh Singh
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,287 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mcp-halflist
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: CI-first conformance testing and benchmarking CLI for MCP servers. Lint your MCP server before your users do.
|
|
5
|
+
Project-URL: Homepage, https://github.com/abhishekhsingh/mcp-halflist
|
|
6
|
+
Project-URL: Repository, https://github.com/abhishekhsingh/mcp-halflist
|
|
7
|
+
Project-URL: Issues, https://github.com/abhishekhsingh/mcp-halflist/issues
|
|
8
|
+
Author-email: Abhishekh Singh <abhishekcp.singh67@gmail.com>
|
|
9
|
+
License: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: cli,conformance,mcp,model-context-protocol,testing
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Topic :: Software Development :: Testing
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Requires-Dist: mcp>=1.0.0
|
|
20
|
+
Requires-Dist: pydantic>=2.0
|
|
21
|
+
Requires-Dist: typer>=0.9.0
|
|
22
|
+
Provides-Extra: dev
|
|
23
|
+
Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
|
|
24
|
+
Requires-Dist: pytest>=7.0; extra == 'dev'
|
|
25
|
+
Requires-Dist: ruff>=0.4; extra == 'dev'
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# mcp-halflist
|
|
29
|
+
|
|
30
|
+
**Lint your MCP server before your users do.**
|
|
31
|
+
|
|
32
|
+
CI-first conformance testing CLI for [Model Context Protocol](https://modelcontextprotocol.io) servers. Point it at your server, get a scored health report.
|
|
33
|
+
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pip install mcp-halflist
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Quick Start
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# Full audit of the official MCP reference server
|
|
44
|
+
halflist audit --stdio "npx -y @modelcontextprotocol/server-everything"
|
|
45
|
+
|
|
46
|
+
# JSON output for CI pipelines
|
|
47
|
+
halflist audit --stdio "npx -y @modelcontextprotocol/server-everything" --format json
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Test your own server
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
halflist audit --stdio "python3 my_server.py"
|
|
54
|
+
halflist check --stdio "python3 my_server.py" --format json
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### More examples
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Time server
|
|
61
|
+
halflist check --stdio "npx -y @modelcontextprotocol/server-time"
|
|
62
|
+
|
|
63
|
+
# Fetch server
|
|
64
|
+
halflist check --stdio "npx -y @modelcontextprotocol/server-fetch"
|
|
65
|
+
|
|
66
|
+
# Filesystem server
|
|
67
|
+
halflist check --stdio "npx -y @modelcontextprotocol/server-filesystem /tmp"
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Commands
|
|
71
|
+
|
|
72
|
+
### `halflist audit` — Full Audit (Recommended)
|
|
73
|
+
|
|
74
|
+
Run conformance checks + benchmark every tool in a single shot.
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# One command, full picture
|
|
78
|
+
halflist audit --stdio "npx -y @modelcontextprotocol/server-everything"
|
|
79
|
+
|
|
80
|
+
# JSON output for CI
|
|
81
|
+
halflist audit --stdio "python3 my_server.py" --format json
|
|
82
|
+
|
|
83
|
+
# Control benchmark iterations
|
|
84
|
+
halflist audit --stdio "python3 my_server.py" --iterations 50
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### `halflist check` — Conformance Testing
|
|
88
|
+
|
|
89
|
+
Run protocol conformance checks against an MCP server.
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
halflist check --stdio "npx -y @modelcontextprotocol/server-everything"
|
|
93
|
+
halflist check --stdio "python3 my_server.py" --format json
|
|
94
|
+
halflist check --stdio "python3 my_server.py" --suite handshake --verbose
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### `halflist bench` — Latency Benchmarking
|
|
98
|
+
|
|
99
|
+
Benchmark latency per tool with p50/p95/p99 percentiles.
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
# Benchmark first 5 tools (default)
|
|
103
|
+
halflist bench --stdio "npx -y @modelcontextprotocol/server-everything"
|
|
104
|
+
|
|
105
|
+
# Benchmark specific tools
|
|
106
|
+
halflist bench --stdio "python3 my_server.py" --tool search --tool get_topic
|
|
107
|
+
|
|
108
|
+
# Benchmark all tools with 50 iterations
|
|
109
|
+
halflist bench --stdio "python3 my_server.py" --all --iterations 50
|
|
110
|
+
|
|
111
|
+
# JSON output
|
|
112
|
+
halflist bench --stdio "python3 my_server.py" --format json
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### `halflist watch` — Health Monitoring
|
|
116
|
+
|
|
117
|
+
Continuously monitor an MCP server's health.
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
# Probe every 60 seconds (default)
|
|
121
|
+
halflist watch --stdio "npx -y @modelcontextprotocol/server-time"
|
|
122
|
+
|
|
123
|
+
# Custom interval, log to file
|
|
124
|
+
halflist watch --stdio "python3 my_server.py" --interval 30 --log health.jsonl
|
|
125
|
+
|
|
126
|
+
# Run 10 probes and exit
|
|
127
|
+
halflist watch --stdio "python3 my_server.py" --count 10
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### `halflist report` — Markdown & Badges
|
|
131
|
+
|
|
132
|
+
Generate markdown or SVG badge from a halflist JSON report.
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
# Generate markdown from audit results
|
|
136
|
+
halflist audit --stdio "python3 my_server.py" --format json > results.json
|
|
137
|
+
halflist report results.json
|
|
138
|
+
|
|
139
|
+
# Generate SVG badge
|
|
140
|
+
halflist report results.json --badge -o badge.svg
|
|
141
|
+
|
|
142
|
+
# Generate markdown from bench results
|
|
143
|
+
halflist bench --stdio "python3 my_server.py" --format json > bench.json
|
|
144
|
+
halflist report bench.json -o BENCH.md
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
## What It Checks
|
|
148
|
+
|
|
149
|
+
### Handshake Suite
|
|
150
|
+
- Server responds to `initialize` with valid response
|
|
151
|
+
- Protocol version returned
|
|
152
|
+
- Capabilities object present
|
|
153
|
+
- Server info has name and version
|
|
154
|
+
- `notifications/initialized` accepted
|
|
155
|
+
- Ping returns pong
|
|
156
|
+
|
|
157
|
+
### Tools Suite
|
|
158
|
+
- `tools/list` returns valid array
|
|
159
|
+
- At least 1 tool exists
|
|
160
|
+
- Every tool has a non-empty name
|
|
161
|
+
- Every tool has a description
|
|
162
|
+
- `inputSchema` contains `"type": "object"`
|
|
163
|
+
- No duplicate tool names
|
|
164
|
+
- Tool names follow recommended pattern
|
|
165
|
+
- Tool call with generated args returns valid response
|
|
166
|
+
- Tool call with empty args handles gracefully
|
|
167
|
+
- Response content is a list
|
|
168
|
+
- Each content item has a type field
|
|
169
|
+
|
|
170
|
+
## Output Formats
|
|
171
|
+
|
|
172
|
+
### Terminal (default)
|
|
173
|
+
|
|
174
|
+
Rich, colored output with a scored summary:
|
|
175
|
+
|
|
176
|
+
```
|
|
177
|
+
╭─ mcp-halflist v0.2.0 ──────────────────────────────────────╮
|
|
178
|
+
│ │
|
|
179
|
+
│ Server: my-server v1.0.0 │
|
|
180
|
+
│ Transport: stdio │
|
|
181
|
+
│ Score: 94/100 ████████████████████░░ 94% │
|
|
182
|
+
│ │
|
|
183
|
+
╰──────────────────────────────────────────────────────────────╯
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### JSON (`--format json`)
|
|
187
|
+
|
|
188
|
+
Full structured report suitable for CI integration. Returns a `HalflistReport`, `BenchReport`, or `AuditReport` object with score, suites, benchmarks, and timing data.
|
|
189
|
+
|
|
190
|
+
### Markdown (`halflist report`)
|
|
191
|
+
|
|
192
|
+
Generate markdown tables from JSON output, suitable for embedding in README or PR comments.
|
|
193
|
+
|
|
194
|
+
### SVG Badge (`halflist report --badge`)
|
|
195
|
+
|
|
196
|
+
Shields.io-style SVG badge showing score or benchmark summary.
|
|
197
|
+
|
|
198
|
+
## Exit Codes
|
|
199
|
+
|
|
200
|
+
| Code | Meaning |
|
|
201
|
+
|------|---------|
|
|
202
|
+
| 0 | All checks passed (warnings OK) |
|
|
203
|
+
| 1 | One or more failures |
|
|
204
|
+
| 2 | Connection/transport error |
|
|
205
|
+
| 3 | Configuration error (bad flags) |
|
|
206
|
+
|
|
207
|
+
## CLI Options
|
|
208
|
+
|
|
209
|
+
```
|
|
210
|
+
halflist audit --stdio <command> Launch server via stdio (check + bench all tools)
|
|
211
|
+
-n / --iterations Benchmark iterations per tool (default: 10)
|
|
212
|
+
-w / --warmup Warmup iterations (default: 2)
|
|
213
|
+
--verbose Show all check details
|
|
214
|
+
--format <fmt> Output format: terminal or json
|
|
215
|
+
--quiet / -q Suppress server stderr
|
|
216
|
+
--timeout <secs> Timeout per operation (default: 30)
|
|
217
|
+
|
|
218
|
+
halflist check --stdio <command> Launch server via stdio
|
|
219
|
+
--format <fmt> Output format: terminal (default) or json
|
|
220
|
+
--suite <name> Filter to specific suite(s), repeatable
|
|
221
|
+
--verbose Show all check details
|
|
222
|
+
--quiet / -q Suppress server stderr
|
|
223
|
+
--timeout <secs> Timeout per operation (default: 30)
|
|
224
|
+
|
|
225
|
+
halflist bench --stdio <command> Launch server via stdio
|
|
226
|
+
--tool <name> Benchmark specific tool(s), repeatable
|
|
227
|
+
--all Benchmark all tools (default: first 5)
|
|
228
|
+
-n / --iterations Iterations per tool (default: 10)
|
|
229
|
+
-w / --warmup Warmup iterations (default: 2)
|
|
230
|
+
--format <fmt> Output format: terminal or json
|
|
231
|
+
--quiet / -q Suppress server stderr
|
|
232
|
+
--timeout <secs> Timeout per operation (default: 30)
|
|
233
|
+
|
|
234
|
+
halflist watch --stdio <command> Launch server via stdio
|
|
235
|
+
-i / --interval Seconds between probes (default: 60)
|
|
236
|
+
-c / --count Number of probes (default: infinite)
|
|
237
|
+
-l / --log <file> Append JSONL probes to file
|
|
238
|
+
--quiet / -q Suppress server stderr
|
|
239
|
+
--timeout <secs> Timeout per operation (default: 30)
|
|
240
|
+
|
|
241
|
+
halflist report <file.json> Path to halflist JSON report
|
|
242
|
+
--format <fmt> Output format: markdown (default)
|
|
243
|
+
--badge Generate SVG badge instead
|
|
244
|
+
-o / --output Write to file
|
|
245
|
+
|
|
246
|
+
halflist --version Print version and exit
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
## How It Compares
|
|
250
|
+
|
|
251
|
+
| | mcp-halflist | MCP Inspector | mcp-probe |
|
|
252
|
+
|---|---|---|---|
|
|
253
|
+
| **Approach** | Automated test suite | Interactive GUI | Request-level testing |
|
|
254
|
+
| **CI-first** | Yes | No | Partial |
|
|
255
|
+
| **Scored reports** | Yes | No | No |
|
|
256
|
+
| **Benchmarking** | Yes | No | No |
|
|
257
|
+
| **Zero config** | Yes | Yes | Yes |
|
|
258
|
+
|
|
259
|
+
Think of it this way: MCP Inspector and mcp-probe are Postman. mcp-halflist is pytest.
|
|
260
|
+
|
|
261
|
+
## Development
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
git clone https://github.com/abhishekhsingh/mcp-halflist.git
|
|
265
|
+
cd mcp-halflist
|
|
266
|
+
python3 -m venv .venv
|
|
267
|
+
source .venv/bin/activate
|
|
268
|
+
pip install -e ".[dev]"
|
|
269
|
+
|
|
270
|
+
# Run tests
|
|
271
|
+
pytest
|
|
272
|
+
|
|
273
|
+
# Run against fixture servers
|
|
274
|
+
halflist check --stdio "python tests/servers/good_server.py"
|
|
275
|
+
halflist check --stdio "python tests/servers/bad_server.py"
|
|
276
|
+
|
|
277
|
+
# Lint
|
|
278
|
+
ruff check src/ tests/
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
## License
|
|
282
|
+
|
|
283
|
+
MIT
|
|
284
|
+
|
|
285
|
+
## Author
|
|
286
|
+
|
|
287
|
+
Abhishekh Singh
|