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)
- Add JSDoc to any exported handler functions with
@param, @returns, and @throws tags
- Add an
@example block for the most commonly used tools (search_nearby, get_place_details)
- Optionally configure
typedoc to generate an HTML docs site from the JSDoc
Acceptance Criteria
- All exported symbols have at least a summary line,
@param for each parameter, and @returns
- No undocumented exports remain in
src/maps-tools/
Overview
Exported tool definitions and handler functions currently lack JSDoc comments. Adding documentation improves maintainability and enables IDE tooling.
Proposed Work
src/maps-tools/mapsTools.ts:@param), and return shape (@returns)@param,@returns, and@throwstags@exampleblock for the most commonly used tools (search_nearby,get_place_details)typedocto generate an HTML docs site from the JSDocAcceptance Criteria
@paramfor each parameter, and@returnssrc/maps-tools/