feat: Add tool annotations for improved LLM tool understanding#39
Open
bryankthompson wants to merge 1 commit intozcaceres:mainfrom
Open
feat: Add tool annotations for improved LLM tool understanding#39bryankthompson wants to merge 1 commit intozcaceres:mainfrom
bryankthompson wants to merge 1 commit intozcaceres:mainfrom
Conversation
Add readOnlyHint and openWorldHint annotations to all MCP tools to help LLMs better understand tool behavior and make safer decisions. Changes: - Bump @modelcontextprotocol/sdk from 1.0.1 to ^1.7.0 for annotation support - Bump zod from ^3.24.1 to ^3.25.0 for SDK compatibility - Added readOnlyHint: true to all 10 tools (pure converters) - Added openWorldHint: true to URL-based tools (youtube, bing, webpage) - Added human-readable title annotations to all tools This improves tool safety metadata for MCP clients. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds MCP tool annotations (
readOnlyHint,openWorldHint) to all 10 tools to help LLMs better understand tool behavior and make safer decisions about tool execution.Changes
@modelcontextprotocol/sdkfrom 1.0.1 to ^1.7.0 for annotation supportzodfrom ^3.24.1 to ^3.25.0 for SDK compatibilityreadOnlyHint: trueto all 10 tools (pure converters, no side effects)openWorldHint: trueto URL-based tools that fetch external content:youtube-to-markdownbing-search-to-markdownwebpage-to-markdowntitleannotations for human-readable displayWhy This Matters
readOnlyHint: trueenables MCP clients to auto-approve safe operationsopenWorldHint: truesignals tools that access external resourcesTesting
pnpm run buildsucceedstools/listreturns annotationsBefore/After
Before:
{ "name": "youtube-to-markdown", "description": "Convert a YouTube video to markdown..." }After:
{ "name": "youtube-to-markdown", "description": "Convert a YouTube video to markdown...", "annotations": { "title": "YouTube to Markdown", "readOnlyHint": true, "openWorldHint": true } }