📝 Add docstrings to issue-345-withany

[coderabbitai]

Summary

Adds comprehensive godoc comments to the new WithAny function and related code in PR #618, improving documentation for the flexible tool properties feature.

Problem

PR #618 introduced the WithAny function for flexible tool properties but lacked comprehensive godoc documentation. The new function and updated example code needed proper documentation to help developers understand how to use the any-type property feature.

Solution

Added detailed godoc comments following Go documentation conventions to:

• The new WithAny function in mcp/tools.go
• The updated WithArray function (expanded its existing docstring)
• The Properties function (clarified its purpose)
• The main function in examples/typed_tools/main.go
• The typedGreetingHandler function (documenting the new AnyData field behavior)

Changes Made

• Added comprehensive godoc for WithAny function explaining its purpose, behavior, and how it handles the required flag
• Enhanced WithArray godoc to better describe its behavior with PropertyOption functions and the required field handling
• Clarified Properties function godoc to explain it sets the "properties" map for object schemas
• Documented the main function in typed_tools example, explaining the server setup and tool registration
• Documented the typedGreetingHandler function, including error handling and the new AnyData parameter formatting

Breaking Changes

• No breaking changes
• Breaking changes (describe below)

Testing

• Unit tests added/updated
• Integration tests added/updated
• Manual testing performed

How to verify it

• Run tests: go test ./... -race - All tests pass
• Run linter: golangci-lint run - 0 issues found
• Check coverage: go test -coverprofile=coverage.txt -covermode=atomic $(go list ./... | grep -v '/examples/' | grep -v '/testdata' | grep -v '/mcptest' | grep -v '/server/internal/gen') - Coverage maintained (67-80% across packages)

Checklist

• Documentation updated (if needed)
• Examples updated (if needed)
• Changelog entry added (if user-facing)

Additional Notes

This is a documentation-only PR generated by CodeRabbit AI bot in response to a request from @otaviof on PR #618. The changes improve code documentation without modifying any functionality. Since this only adds documentation comments and doesn't change user-facing behavior, no changelog entry is required.

[coderabbitai]

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Merging this branch will not change overall coverage

Impacted Packages	Coverage Δ	🤖
github.com/mark3labs/mcp-go/examples/typed_tools	0.00% (ø)
github.com/mark3labs/mcp-go/mcp	80.21% (ø)

---

Coverage by file

Changed files (no unit tests)

Changed File	Coverage Δ	Total	Covered	Missed	🤖
github.com/mark3labs/mcp-go/examples/typed_tools/main.go	0.00% (ø)	0	0	0
github.com/mark3labs/mcp-go/mcp/tools.go	84.15% (ø)	410	345	65

Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code.