fix: update tool category for collection-indexes #630
Merged
+37
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chore: add some toolbase docs
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the tool category for collection-indexes and enhances documentation by adding comprehensive JSDoc comments for tool types and operation categories.
- Adds detailed JSDoc documentation for
OperationType,ToolCategory,TelemetryToolMetadata, andformatUntrustedDatafunction - Updates README documentation to clarify metadata operation type description
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/tools/tool.ts | Adds comprehensive JSDoc documentation for tool types and utility functions |
| README.md | Updates metadata operation type description to include indexes |
blva
approved these changes
Oct 9, 2025
kmruiz
approved these changes
Oct 9, 2025
blva
reviewed
Oct 9, 2025
| - `delete` - Tools that delete resources, such as delete document, drop collection, etc. | ||
| - `read` - Tools that read resources, such as find, aggregate, list clusters, etc. | ||
| - `metadata` - Tools that read metadata, such as list databases, list collections, collection schema, etc. | ||
| - `metadata` - Tools that read metadata, such as list databases/collections/indexes, infer collection schema, etc. |
There was a problem hiding this comment.
nit: can we update the PR title update tool category for collection-indexes from read to metadata to help users find this out in the changelog
himanshusinghs
approved these changes
Oct 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Additionally, adds some docs