Frequently Asked Questions about UBOS MCP Server for ts-morph Refactoring

Q: What is an MCP Server? A: MCP (Model Context Protocol) standardizes how applications provide context to LLMs, enabling AI models to interact with external data and tools.

Q: What is ts-morph? A: Ts-morph is a TypeScript compiler API wrapper, providing an Abstract Syntax Tree (AST) representation of TypeScript and JavaScript code, enabling precise code analysis and transformations.

Q: What functionalities does the MCP Server with ts-morph provide? A: It offers symbol renaming, file/folder renaming with automatic import/export updates, comprehensive reference finding, and path alias management.

Q: How do I configure the MCP Server? A: You need to add configuration to your mcp.json file, specifying the server’s name, command, arguments, and environment variables.

Q: Which editors and IDEs support the MCP protocol? A: Editors like Cursor support the MCP protocol, allowing you to access the server’s functionalities directly from your coding environment.

Q: How does the symbol renaming feature work? A: The rename_symbol_by_tsmorph function renames a specified symbol across the entire project, ensuring consistent updates of all references.

Q: What happens when I rename a file or folder using the MCP Server? A: The rename_filesystem_entry_by_tsmorph function automatically updates all import and export statements that reference the renamed file or folder.

Q: Can the MCP Server handle path aliases? A: Yes, it supports path aliases (e.g., @/components) and provides the option to convert them to relative paths if needed.

Q: How do I find all references to a symbol in my project? A: The find_references_by_tsmorph function lists all occurrences of a symbol in the project, helping you understand the impact of changes.

Q: How does the MCP Server ensure code integrity during refactoring? A: By using AST-based refactoring, the server ensures semantic correctness and prevents unintended side effects.

Q: Is the MCP Server suitable for large projects? A: Yes, the server is designed to handle large projects efficiently, minimizing the time required for refactoring operations.

Q: Can I extend the MCP Server with custom refactoring features? A: Yes, the server is designed to be extensible, allowing developers to add new refactoring features and customize existing ones.

Q: What prerequisites do I need to develop with the MCP Server? A: You need Node.js, pnpm, and a basic understanding of TypeScript and ts-morph.

Q: How do I install the dependencies for the MCP Server? A: Run pnpm install in the project directory after cloning the repository.

Q: How do I build the MCP Server? A: Run pnpm build to compile the TypeScript code into JavaScript.

Q: Where are the build artifacts located? A: The build artifacts are located in the dist directory.

Q: How do I run the unit tests for the MCP Server? A: Run pnpm test in the project directory.

Q: How do I lint and format the code? A: Use pnpm lint for linting, pnpm lint:fix for automatic linting fixes, and pnpm format for code formatting.

Q: What is UBOS, and how does the MCP Server integrate with it? A: UBOS is a full-stack AI Agent Development Platform. The MCP Server integrates seamlessly with UBOS, providing a comprehensive solution for AI-powered code management and enabling developers to build robust and maintainable software projects.

Q: What is the license for this project? A: This project is licensed under the MIT License. See the LICENSE file for details.