feat: add MCP tool annotations for readOnlyHint and destructiveHint #58
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
Add tool annotations to all 13 MCP tools to improve client behavior hints: Read-only tools (readOnlyHint: true): - chroma_list_collections - chroma_peek_collection - chroma_get_collection_info - chroma_get_collection_count - chroma_query_documents - chroma_get_documents Write tools (readOnlyHint: false, destructiveHint: false): - chroma_create_collection - chroma_modify_collection - chroma_fork_collection - chroma_add_documents - chroma_update_documents Destructive tools (destructiveHint: true): - chroma_delete_collection - chroma_delete_documents These annotations help MCP clients make informed decisions about tool execution, enabling features like confirmation prompts for destructive operations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR adds MCP tool annotations (
readOnlyHintanddestructiveHint) to all 13 tools, improving client integration and enabling features like confirmation prompts for destructive operations.Annotation Mapping
Read-only tools (
readOnlyHint: true, destructiveHint: false):chroma_list_collectionschroma_peek_collectionchroma_get_collection_infochroma_get_collection_countchroma_query_documentschroma_get_documentsWrite tools (
readOnlyHint: false, destructiveHint: false):chroma_create_collectionchroma_modify_collectionchroma_fork_collectionchroma_add_documentschroma_update_documentsDestructive tools (
readOnlyHint: false, destructiveHint: true):chroma_delete_collectionchroma_delete_documentsMotivation
MCP tool annotations provide hints to clients about tool behavior:
readOnlyHint: true- Tool only reads data, no modificationsdestructiveHint: true- Tool performs irreversible operations (deletions)These annotations help MCP clients:
Changes
annotations={"readOnlyHint": ..., "destructiveHint": ...}to all@mcp.tool()decoratorsTest plan