Skip to content

Commit 54db7f7

Browse files
committed
feat: finalize 1.0 stabilization and docs
1 parent a15d155 commit 54db7f7

37 files changed

Lines changed: 2480 additions & 684 deletions

.github/workflows/ci.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,5 +120,9 @@ jobs:
120120
run: |
121121
wireshark-mcp --version
122122
python -m wireshark_mcp.server --version
123+
wireshark-mcp config
124+
wireshark-mcp doctor
125+
wireshark-mcp doctor --format json
126+
wireshark-mcp clients
127+
wireshark-mcp clients --format json
123128
wireshark-mcp --config
124-
wireshark-mcp --doctor

.github/workflows/publish.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,12 @@ jobs:
3939
run: |
4040
wireshark-mcp --version
4141
python -m wireshark_mcp.server --version
42+
wireshark-mcp config
43+
wireshark-mcp doctor
44+
wireshark-mcp doctor --format json
45+
wireshark-mcp clients
46+
wireshark-mcp clients --format json
4247
wireshark-mcp --config
43-
wireshark-mcp --doctor
4448
4549
- name: Publish to PyPI
4650
uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ htmlcov/
1919

2020
# Runtime caches
2121
urlhaus_cache.txt
22+
.mcpregistry_*
2223

2324
# Spec (internal)
24-
spec/
25+
spec/

CHANGELOG.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [1.0.0] - 2026-03-16
11+
1012
### Added
1113
- Added suite capability reporting via `wireshark_get_capabilities` and the `wireshark://capabilities` resource.
1214
- Added optional Wireshark suite tools for `editcap`-based trimming, splitting, time shifting, and deduplication, plus `text2pcap` import support.
15+
- Added regression tests for startup-wide contextual tool registration, `wireshark_open_file` recommendations, `capinfos`-free open-file fallback, and deterministic URLhaus URL/domain matching.
16+
- Added machine-readable `--format json` output for `wireshark-mcp doctor` and `wireshark-mcp clients`.
17+
- Added focused `docs/` guides for manual configuration and prompt engineering so the main README can stay closer to a landing page.
1318

1419
### Changed
20+
- Promoted the project to a 1.0-stable release and pinned the runtime `mcp` dependency to the 1.x line to reduce future compatibility drift.
21+
- The MCP server now keeps a stable tool surface for the full session: contextual tools are registered at startup, and `wireshark_open_file` recommends the most relevant tools for a capture instead of mutating the tool catalog mid-session.
22+
- `wireshark_open_file` now degrades gracefully when `capinfos` is unavailable, so the recommended capture-opening workflow still works on minimal `tshark`-only installations.
23+
- `wireshark_check_threats` now matches captured HTTP URLs plus DNS/TLS hostnames against cached URLhaus data, replacing the earlier IP-oriented matching semantics with a more reproducible URL/domain workflow.
24+
- `wireshark_security_audit`, MCP prompts, MCP resources, and both READMEs were updated to align with the stable 1.0 workflow and the new threat-intelligence semantics.
25+
- The CLI documentation, CI smoke tests, and contribution docs now use the stable subcommand-oriented interface (`install`, `doctor`, `config`, `clients`) while still documenting legacy flag compatibility.
1526
- Live capture now prefers `dumpcap` when available while keeping `tshark` as the only required Wireshark dependency.
1627
- Installer diagnostics now classify Wireshark tools as required, recommended, or optional.
28+
- Release metadata and support-policy files now agree on the 1.0 version line across packaging, registry metadata, and security documentation.
29+
30+
### Deprecated
31+
- `wireshark_read_packets` remains available for 1.x compatibility, but new workflows should use `wireshark_get_packet_list` plus `wireshark_get_packet_details`.
32+
33+
### Removed
34+
- Removed the unused root `requirements.txt` file to avoid implying a second, undocumented installation path alongside the packaged release flow.
1735

1836
## [0.6.4] - 2026-03-14
1937

@@ -102,7 +120,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
102120
- Decoding: `wireshark_decode_payload` with auto-detection (Base64, Hex, URL, Gzip, Deflate, Rot13)
103121
- Visualization: ASCII traffic plot, ASCII protocol hierarchy tree
104122

105-
[Unreleased]: https://github.com/bx33661/Wireshark-MCP/compare/v0.6.4...HEAD
123+
[Unreleased]: https://github.com/bx33661/Wireshark-MCP/compare/v1.0.0...HEAD
124+
[1.0.0]: https://github.com/bx33661/Wireshark-MCP/compare/v0.6.4...v1.0.0
106125
[0.6.4]: https://github.com/bx33661/Wireshark-MCP/compare/v0.6.3...v0.6.4
107126
[0.6.3]: https://github.com/bx33661/Wireshark-MCP/compare/v0.6.2...v0.6.3
108127
[0.6.2]: https://github.com/bx33661/Wireshark-MCP/compare/v0.6.1...v0.6.2

CONTRIBUTING.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,14 @@ Thank you for your interest in contributing! This guide will help you get starte
1111
git clone https://github.com/bx33661/Wireshark-MCP.git
1212
cd Wireshark-MCP
1313

14-
# Install in editable mode with dev dependencies
15-
pip install -e .
16-
pip install pytest pytest-asyncio ruff mypy
14+
# Install the locked development environment
15+
uv sync --group dev
1716
```
1817

1918
## Running Tests
2019

2120
```sh
22-
# Run all tests
23-
python -m unittest discover tests
24-
25-
# Or with pytest
26-
pytest tests/
21+
uv run python -m pytest tests/
2722
```
2823

2924
## Code Style
@@ -32,13 +27,16 @@ This project uses [ruff](https://docs.astral.sh/ruff/) for linting and formattin
3227

3328
```sh
3429
# Check for issues
35-
ruff check src/
30+
uv run python -m ruff check src/ tests/
3631

3732
# Auto-fix
38-
ruff check --fix src/
33+
uv run python -m ruff check --fix src/ tests/
3934

4035
# Format
41-
ruff format src/
36+
uv run python -m ruff format src/ tests/
37+
38+
# Type check
39+
uv run python -m mypy --package wireshark_mcp --ignore-missing-imports --no-namespace-packages
4240
```
4341

4442
**Key conventions:**
@@ -68,11 +66,14 @@ src/wireshark_mcp/
6866

6967
1. **Fork** the repository and create a branch from `main`
7068
2. **Write or update tests** for your changes
71-
3. **Ensure all tests pass**: `pytest tests/`
72-
4. **Lint your code**: `ruff check src/`
69+
3. **Ensure all tests pass**: `uv run python -m pytest tests/`
70+
4. **Lint your code**: `uv run python -m ruff check src/ tests/`
7371
5. **Add a change record** under `spec/changes/` following the format in `spec/README.md`
7472
6. **Open a Pull Request** — fill in the PR template
7573

74+
For release work, use [docs/release-checklist.md](docs/release-checklist.md) and
75+
[docs/platform-validation.md](docs/platform-validation.md) before tagging a version.
76+
7677
## Adding a New Tool
7778

7879
1. Add your tool function to the appropriate file in `src/wireshark_mcp/tools/`

0 commit comments

Comments
 (0)