feat: enhance search_notes tool documentation with comprehensive syntax examples by phernandez · Pull Request #186 · basicmachines-co/basic-memory · GitHub
Skip to content

feat: enhance search_notes tool documentation with comprehensive syntax examples - #186

Merged
phernandez merged 4 commits into
mainfrom
claude/issue-179-20250626_155103
Jun 26, 2025
Merged

feat: enhance search_notes tool documentation with comprehensive syntax examples#186
phernandez merged 4 commits into
mainfrom
claude/issue-179-20250626_155103

Conversation

@phernandez

Copy link
Copy Markdown
Member

Enhances the search_notes MCP tool documentation with comprehensive search syntax examples and improved error handling as requested in issue #179.

Changes

  • Added detailed "Search Syntax Examples" section with basic, boolean, and advanced searches
  • Include content-specific patterns (tag:, category:, author:) as requested
  • Enhanced error messages with comprehensive guidance and alternatives
  • Added advanced pattern examples with complex boolean logic
  • Improved troubleshooting steps with specific search strategies
  • Expanded no-results guidance with 6 different search approaches

Impact

  • Users now have comprehensive examples for effective searching
  • Failed searches provide actionable guidance with specific alternatives
  • Documentation covers edge cases and advanced search patterns
  • Improved search success rate through better user education

Fixes #179

🤖 Generated with Claude Code

…ax examples

- Add detailed "Search Syntax Examples" section covering basic, boolean, and advanced searches
- Include content-specific patterns (tag:, category:, author:) as requested in issue
- Enhance error messages with more comprehensive guidance and alternatives
- Add advanced pattern examples with complex boolean logic and filtering
- Improve troubleshooting steps with specific search strategies
- Expand no-results guidance with 6 different search approaches
- Add search syntax reference to generic error handling

Addresses issue #179 for better search tool user experience.

Co-authored-by: Paul Hernandez <phernandez@users.noreply.github.com>
@phernandez

Copy link
Copy Markdown
Member Author

@claude

claude Bot commented Jun 26, 2025

Copy link
Copy Markdown
Contributor

claude Bot and others added 3 commits June 26, 2025 19:13
…format

The search_notes function now returns formatted error strings instead of 
SearchResponse objects when errors occur. Updated all test functions to:

- Import SearchResponse for explicit type checking
- Handle both success (SearchResponse) and error (string) return types
- Fail tests with informative messages when search errors occur

This ensures test compatibility with the enhanced error handling added 
in the search tool documentation improvements.

Co-authored-by: Paul Hernandez <phernandez@users.noreply.github.com>
Update test to match actual error message format in search tool.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: phernandez <paul@basicmachines.co>
@phernandez
phernandez merged commit a589f8b into main Jun 26, 2025
@phernandez
phernandez deleted the claude/issue-179-20250626_155103 branch June 26, 2025 20:51
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.

Add search syntax examples to tool documentation

1 participant