docs: add TypeScript MCP (lsmcp) usage instructions - #412
Conversation
- Add TypeScript MCP to external MCP servers list - Add important note to always use lsmcp for TypeScript code search - Ensure consistent TypeScript symbol/function searching methodology
|
Caution Review failedThe pull request is closed. WalkthroughThe documentation was updated to introduce the "TypeScript MCP (lsmcp)" server tool for searching TypeScript code elements. An important note was also added, directing users to utilize TypeScript MCP tools for searching code structures instead of generic command-line tools like grep or rg. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ryoppippi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
I've updated the documentation to provide clear instructions on using TypeScript MCP (lsmcp) for navigating TypeScript codebases. The primary goal is to ensure that developers use the appropriate tools for accurate symbol and definition lookups, moving away from less precise text-based searches. This change adds lsmcp to the list of available MCP servers and includes an important note guiding users on the correct methodology for searching TypeScript code.
Highlights
- Documentation of TypeScript MCP (lsmcp): I've updated the list of external MCP servers to include TypeScript MCP, also known as lsmcp. This addition clarifies that lsmcp is specifically designed for searching TypeScript functions, types, and symbols across the codebase, providing a dedicated tool for this purpose.
- Guidance on TypeScript Code Search Methodology: I've added a crucial instruction in the 'Tips' section emphasizing that for TypeScript code searches (functions, types, symbols), users should always utilize TypeScript MCP (lsmcp) tools such as
get_definitions,find_references, andget_hover. This change explicitly advises against using general text-based search tools likegreporrgfor TypeScript code structures, ensuring more accurate and context-aware results.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
commit: |
There was a problem hiding this comment.
Code Review
This pull request updates the CLAUDE.md file to include instructions for using the TypeScript MCP server (lsmcp). The changes add lsmcp to the list of available MCP servers and include an important directive to use it for TypeScript code searches instead of generic text search tools. The changes are clear and achieve the goal of the PR. I have one minor suggestion to improve the formatting consistency of the new instruction within the document.
| - [gunshi](https://gunshi.dev/llms.txt) - Documentation available via Gunshi MCP server | ||
| - Context7 MCP server available for library documentation lookup | ||
| - do not use console.log. use logger.ts instead | ||
| - **IMPORTANT**: When searching for TypeScript functions, types, or symbols in the codebase, ALWAYS use TypeScript MCP (lsmcp) tools like `get_definitions`, `find_references`, `get_hover`, etc. DO NOT use grep/rg for searching TypeScript code structures. |
There was a problem hiding this comment.
For better readability and consistency with other items in this document (e.g., **Import conventions**: on line 111), consider using a topical prefix like **TypeScript Search**: instead of **IMPORTANT**. This makes the list of tips easier to scan. I've also added backticks to grep/rg for consistent code formatting.
| - **IMPORTANT**: When searching for TypeScript functions, types, or symbols in the codebase, ALWAYS use TypeScript MCP (lsmcp) tools like `get_definitions`, `find_references`, `get_hover`, etc. DO NOT use grep/rg for searching TypeScript code structures. | |
| - **TypeScript Search**: When searching for TypeScript functions, types, or symbols in the codebase, ALWAYS use TypeScript MCP (lsmcp) tools like `get_definitions`, `find_references`, `get_hover`, etc. DO NOT use `grep`/`rg` for searching TypeScript code structures. |
1 participant
Summary
Context
This change documents the requirement to use TypeScript Language Server MCP tools when searching for TypeScript functions, types, and symbols in the codebase. This provides more accurate and context-aware search results compared to text-based search tools.
Changes
get_definitions,find_references,get_hover, etc.) for TypeScript code searchSummary by CodeRabbit