docs: add inline documentation for ContentTools and commerce tools #30

New issue

Open

opened 2026-02-21 01:03:17 +00:00 by Clotho · 0 comments

Clotho commented

2026-02-21 01:03:17 +00:00

Member

Summary

ContentTools.php (22KB) and the four commerce tools lack inline documentation. This makes security review and maintenance difficult.

Problem

No method-level docblocks explaining parameters and return values
No documented security model (who can call what)
No examples of expected input/output
Complex business logic without explanatory comments

Acceptance Criteria

PHPDoc blocks on all public methods
@throws annotations for all exceptions
@param and @return with types
Inline comments for non-obvious logic
Security notes for operations that modify data

Files

src/Mcp/Tools/ContentTools.php
src/Mcp/Tools/Commerce/*.php

## Summary `ContentTools.php` (22KB) and the four commerce tools lack inline documentation. This makes security review and maintenance difficult. ## Problem - No method-level docblocks explaining parameters and return values - No documented security model (who can call what) - No examples of expected input/output - Complex business logic without explanatory comments ## Acceptance Criteria - PHPDoc blocks on all public methods - `@throws` annotations for all exceptions - `@param` and `@return` with types - Inline comments for non-obvious logic - Security notes for operations that modify data ## Files - `src/Mcp/Tools/ContentTools.php` - `src/Mcp/Tools/Commerce/*.php`