-
Notifications
You must be signed in to change notification settings - Fork 62
Open
Description
Overview
Exported tool definitions and handler functions currently lack JSDoc comments. Adding documentation improves maintainability and enables IDE tooling.
Proposed Work
- Add JSDoc blocks to all exported constants in
src/maps-tools/mapsTools.ts:- Document each tool's purpose, input schema fields (
@param), and return shape (@returns)
- Document each tool's purpose, input schema fields (
- Add JSDoc to any exported handler functions with
@param,@returns, and@throwstags - Add an
@exampleblock for the most commonly used tools (search_nearby,get_place_details) - Optionally configure
typedocto generate an HTML docs site from the JSDoc
Acceptance Criteria
- All exported symbols have at least a summary line,
@paramfor each parameter, and@returns - No undocumented exports remain in
src/maps-tools/
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels