feat: Add tool annotations for improved LLM tool understanding#27
Open
bryankthompson wants to merge 1 commit intoiFurySt:mainfrom
Open
feat: Add tool annotations for improved LLM tool understanding#27bryankthompson wants to merge 1 commit intoiFurySt:mainfrom
bryankthompson wants to merge 1 commit intoiFurySt:mainfrom
Conversation
Add readOnlyHint and openWorldHint annotations to all MCP tools to help LLMs better understand tool behavior and make safer decisions. Changes: - Add readOnlyHint: true to read-only tools (search_notes, get_note_content, get_note_comments) - Add openWorldHint: true to all tools (they interact with external Xiaohongshu API) - Add human-readable title annotations for better display - Bump @modelcontextprotocol/sdk from ^1.9.0 to 1.11.0 for annotation support - Fix TypeScript type errors in stdioLogger.ts for SDK compatibility 🤖 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,title) to all 4 tools to help LLMs better understand tool behavior and make safer decisions about tool execution.Changes
readOnlyHint: trueto read-only tools (search, get content, get comments)openWorldHint: trueto all tools (they interact with external Xiaohongshu API)titleannotations@modelcontextprotocol/sdkfrom^1.9.0to1.11.0for annotation supportstdioLogger.tsfor SDK compatibilityWhy This Matters
Testing
npm run build)tools/listreturns annotations for all 4 toolsBefore/After
Before:
{ "name": "search_notes", "description": "根据关键词搜索笔记" }After:
{ "name": "search_notes", "description": "根据关键词搜索笔记", "annotations": { "title": "Search Notes", "readOnlyHint": true, "openWorldHint": true } }🤖 Generated with Claude Code