Skip to content

docs: add JSDoc documentation to utility functions #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Raghuboi
Copy link

This PR adds JSDoc documentation to utility functions in oauthUtils.ts and jsonUtils.ts to improve code maintainability and enable better LLM code interpretation.

Changes

  • oauthUtils.ts: Added JSDoc documentation to parseOAuthCallbackParams and generateOAuthErrorDescription
  • jsonUtils.ts: Added JSDoc documentation to getDataType and tryParseJson

Motivation and Context

Added JSDoc documentation to improve code discoverability and enable LLMs to better understand utility function behavior, parameters, and return values.

How Has This Been Tested?

  • Verified existing functionality remains unchanged
  • Confirmed JSDoc comments render properly in IDE tooltips
  • Ran existing tests to ensure no regressions
  • Functions continue to work as expected in their current usage contexts (OAuth callbacks, JSON parsing/manipulation in forms)

Breaking Changes

None. This is purely additive documentation with no functional changes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant