docs: enhance MCP tool descriptions with usage examples

[hudrazine]

This PR updates the descriptions for three MCP tools (library_docs_lookup, github_repo_analyzer, web_research_assistant) by adding detailed use cases and input prompt examples. This improves developer guidance and tool usability.

Summary by CodeRabbit

• Documentation
  • Improved in-app descriptions for Library Docs Lookup, GitHub Repo Analyzer, and Web Research Assistant with clearer purpose, ideal use cases, and example prompts.
  • Descriptions are now static, multi-line texts for better readability and guidance when selecting and using tools.
  • No changes to tool behavior or input requirements; only the displayed descriptions were updated.

[coderabbitai]

Walkthrough

Static, multi-line description strings replaced previous dynamic getDescription() calls for three tool registrations in src/index.ts: library_docs_lookup, github_repo_analyzer, and web_research_assistant. No schema, API, or control-flow changes. Runtime behavior is unchanged aside from exposed description text.

Changes

Cohort / File(s)	Summary of Changes
Tool description updates src/index.ts	Replaced dynamic getDescription() with explicit multi-line string literals for library_docs_lookup, github_repo_analyzer, and web_research_assistant descriptions; no changes to inputSchema or control flow.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I nibble on docs with delighted cheer,
Swapped whispers for paragraphs, loud and clear.
Three tools now speak in tidy prose,
Their prompts well-groomed like carrot rows.
Thump-thump! I hop through lines so neat—
Descriptions crisp, a reviewer’s treat.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly and concisely summarizes the main change by indicating that the documentation for MCP tool descriptions is being enhanced with usage examples, which directly reflects the PR’s modifications. It uses the conventional “docs:” prefix and specifies the scope (“MCP tool descriptions”) and nature (“enhance… with usage examples”) of the change. This makes it easy for reviewers and teammates to understand the primary purpose of the pull request at a glance.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch develop

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 575f910 and 7d3c1e6.

📒 Files selected for processing (1)

• src/index.ts (3 hunks)

🔇 Additional comments (3)

src/index.ts (3)

26-35: LGTM! Clear and helpful documentation enhancement.

The expanded description effectively guides users with concrete use cases and examples. The content aligns well with the inputSchema examples and provides practical guidance for developers.

---

124-133: LGTM! Well-structured repository analysis guidance.

The description provides clear differentiation from the library docs tool by focusing on repository-specific implementation details and architecture. The examples effectively demonstrate the depth of analysis users can expect.

---

223-232: LGTM! Comprehensive web research tool documentation.

The description effectively positions this tool for broad information gathering, distinct from the specialized documentation and repository analysis tools. The diverse examples (technical comparisons, scientific topics, best practices) showcase the tool's versatility.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull Request Overview

This PR enhances MCP tool descriptions by replacing generic method calls with detailed, user-friendly descriptions that include use cases and example prompts. The changes improve developer guidance for three key tools: library documentation lookup, GitHub repository analysis, and web research assistance.

• Replaced dynamic description generation with static, comprehensive descriptions
• Added structured use case sections explaining optimal scenarios for each tool
• Included practical input prompt examples to guide developers on effective tool usage

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Copilot]

The example uses a hardcoded year '2025' which will become outdated. Consider using 'latest' or 'current' instead to make the example more timeless.

Suggested change

	- "Tell me about the 2025 performance comparison between React and Vue, including the latest benchmarks and trends"
	- "Tell me about the latest performance comparison between React and Vue, including the latest benchmarks and trends"