Skip to content

Commit f44faf4

Browse files
committed
docs: Phase 3 - Add LICENSE, CHANGELOG, and enhance pyproject.toml
Added: - LICENSE file (MIT) - CHANGELOG.md (Keep a Changelog format) Updated pyproject.toml: - Bumped version to 2.0.6 - Added readme = README.md - Added license = MIT - Added authors - Added keywords for PyPI discoverability - Added Python version classifiers (3.10-3.13) - Added topic classifiers This prepares the package for v2.0.6 release.
1 parent b883c52 commit f44faf4

File tree

4 files changed

+162
-17
lines changed

4 files changed

+162
-17
lines changed

CHANGELOG.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
- Improvement plan for future enhancements
13+
14+
### Changed
15+
16+
- Code cleanup and dead code removal
17+
18+
## [2.0.6] - 2026-01-26
19+
20+
### Removed
21+
22+
- Removed 5 redundant script/test files (~800 lines)
23+
- Removed unused `get_http_client()` function
24+
- Removed unused `sanitize_identifier()` function
25+
- Removed unused `WebhookInfo` class
26+
- Removed unused `WebhookRequest` class
27+
- Cleaned up unused imports across 5 files
28+
29+
### Added
30+
31+
- `LICENSE` file (MIT)
32+
- `CHANGELOG.md` (this file)
33+
- Improvement plan documentation
34+
35+
## [2.0.5] - 2026-01-26
36+
37+
### Fixed
38+
39+
- Console script wrapper for proper uvx execution
40+
- Entry point configuration for MCP server
41+
42+
## [2.0.4] - 2026-01-26
43+
44+
### Fixed
45+
46+
- F-string syntax error in request service
47+
48+
## [2.0.3] - 2026-01-26
49+
50+
### Fixed
51+
52+
- uvx compatibility for MCP server startup
53+
- Module path resolution issues
54+
55+
## [2.0.2] - 2026-01-26
56+
57+
### Fixed
58+
59+
- Syntax error in request_service.py
60+
- Import organization issues
61+
62+
## [2.0.1] - 2026-01-26
63+
64+
### Fixed
65+
66+
- Package structure and imports
67+
- Build configuration
68+
69+
## [2.0.0] - 2026-01-25
70+
71+
### Added
72+
73+
- Complete rewrite with 21 MCP tools
74+
- Webhook management tools (create, configure, update, delete)
75+
- Request management tools (list, search, delete)
76+
- Bug bounty payload generators (SSRF, XSS, canary tokens)
77+
- Email and DNS endpoint support
78+
- Real-time request waiting with SSE
79+
- Link extraction from captured requests
80+
- Comprehensive validation and error handling
81+
- Async HTTP client with proper connection management
82+
- Structured logging with configurable levels
83+
84+
### Changed
85+
86+
- Migrated to MCP SDK 1.0.0
87+
- Improved code architecture with service layer pattern
88+
- Enhanced type hints throughout codebase
89+
90+
## [1.0.0] - 2026-01-24
91+
92+
### Added
93+
94+
- Initial release with basic webhook.site integration
95+
- Core webhook creation and management
96+
- Request capture and retrieval
97+
98+
[Unreleased]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.6...HEAD
99+
[2.0.6]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.5...v2.0.6
100+
[2.0.5]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.4...v2.0.5
101+
[2.0.4]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.3...v2.0.4
102+
[2.0.3]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.2...v2.0.3
103+
[2.0.2]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.1...v2.0.2
104+
[2.0.1]: https://github.com/zebbern/webhook-mcp-server/compare/v2.0.0...v2.0.1
105+
[2.0.0]: https://github.com/zebbern/webhook-mcp-server/compare/v1.0.0...v2.0.0
106+
[1.0.0]: https://github.com/zebbern/webhook-mcp-server/releases/tag/v1.0.0

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 zebbern
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.

plan/IMPROVEMENT_PLAN.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,35 +55,36 @@
5555

5656
### Unused Imports REMOVED
5757

58-
| File | Removed Import |
59-
| -------------------- | ------------------------- |
60-
| `webhook_service.py` | `WebhookInfo`|
61-
| `request_service.py` | `WebhookRequest`|
58+
| File | Removed Import |
59+
| -------------------- | ------------------------------------------ |
60+
| `webhook_service.py` | `WebhookInfo` |
61+
| `request_service.py` | `WebhookRequest` |
6262
| `http_client.py` | `asynccontextmanager`, `AsyncGenerator`|
63-
| `models/__init__.py` | `WebhookInfo`, `WebhookRequest`|
64-
| `utils/__init__.py` | `sanitize_identifier`|
63+
| `models/__init__.py` | `WebhookInfo`, `WebhookRequest` |
64+
| `utils/__init__.py` | `sanitize_identifier` |
6565

6666
**Estimated lines removed:** ~120 lines ✅ DONE
6767

6868
---
6969

70-
## Phase 3: Documentation Fixes (Priority: HIGH)
70+
## Phase 3: Documentation Fixes (Priority: HIGH) ✅ COMPLETED
7171

7272
### Missing Files to CREATE
7373

74-
- [ ] Create `LICENSE` file (MIT license)
75-
- [ ] Create `CHANGELOG.md` (following Keep a Changelog format)
76-
- [ ] Create `CONTRIBUTING.md` (extract from README)
74+
- [x] Create `LICENSE` file (MIT license)
75+
- [x] Create `CHANGELOG.md` (following Keep a Changelog format)
76+
- [ ] Create `CONTRIBUTING.md` (extract from README) - deferred
7777

7878
### pyproject.toml Updates
7979

80-
- [ ] Add `readme = "README.md"`
81-
- [ ] Add `license = {text = "MIT"}`
82-
- [ ] Add `authors = [{name = "zebbern"}]`
83-
- [ ] Add `keywords = ["mcp", "webhook", "testing", "model-context-protocol", "bugbounty"]`
84-
- [ ] Add `classifiers` for Python versions and categories
80+
- [x] Add `readme = "README.md"`
81+
- [x] Add `license = {text = "MIT"}`
82+
- [x] Add `authors = [{name = "zebbern"}]`
83+
- [x] Add `keywords = ["mcp", "webhook", "testing", "model-context-protocol", "bugbounty"]`
84+
- [x] Add `classifiers` for Python versions and categories
85+
- [x] Bump version to 2.0.6
8586

86-
### README.md Fixes
87+
### README.md Fixes (deferred to future version)
8788

8889
- [ ] Update tool count badge (16 → 21 or reduce tools)
8990
- [ ] Add missing 5 bug bounty tools to documentation

pyproject.toml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
11
[project]
22
name = "webhook-mcp-server"
3-
version = "2.0.5"
3+
version = "2.0.6"
44
description = "MCP Server for webhook.site API integration with layered architecture"
5+
readme = "README.md"
6+
license = {text = "MIT"}
7+
authors = [{name = "zebbern", email = "zebbern@users.noreply.github.com"}]
8+
keywords = ["mcp", "webhook", "testing", "model-context-protocol", "bugbounty", "api-testing"]
9+
classifiers = [
10+
"Development Status :: 5 - Production/Stable",
11+
"Intended Audience :: Developers",
12+
"License :: OSI Approved :: MIT License",
13+
"Operating System :: OS Independent",
14+
"Programming Language :: Python :: 3",
15+
"Programming Language :: Python :: 3.10",
16+
"Programming Language :: Python :: 3.11",
17+
"Programming Language :: Python :: 3.12",
18+
"Programming Language :: Python :: 3.13",
19+
"Topic :: Software Development :: Testing",
20+
"Topic :: Internet :: WWW/HTTP",
21+
]
522
requires-python = ">=3.10"
623
dependencies = [
724
"mcp>=1.0.0",

0 commit comments

Comments
 (0)