mirror of
https://github.com/penpot/penpot.git
synced 2026-02-12 14:42:56 +00:00
Original repository: https://github.com/penpot/penpot-mcp Imported commit: fcfa67e908fc54e23a3a3543dee432472dc90c5d
1.7 KiB
1.7 KiB
Task Completion Guidelines
After Making Code Changes
1. Build and Test
cd mcp-server
npm run build:full # or npm run build for faster bundling only
2. Verify TypeScript Compilation
npx tsc --noEmit
3. Test the Server
# Start in development mode to test changes
npm run dev
4. Code Quality Checks
- Ensure all code follows the established conventions
- Verify JSDoc comments are complete and accurate
- Check that error handling is appropriate
- Use clean imports WITHOUT file extensions (esbuild handles resolution)
- Validate that tool interfaces are properly implemented
5. Integration Testing
- Test tool registration in the main server
- Verify MCP protocol compliance
- Ensure tool definitions match implementation
Before Committing Changes
- Build Successfully:
npm run build:fullcompletes without errors - No TypeScript Errors:
npx tsc --noEmitpasses - Documentation Updated: JSDoc comments reflect changes
- Tool Registry Updated: New tools added to
registerTools()method - Interface Compliance: All tools implement the
Toolinterface correctly
File Organization
- Place new tools in
src/tools/directory - Update main server registration in
src/index.ts - Follow existing naming conventions
Common Patterns
- All tools must implement the
Toolinterface - Use readonly properties for tool definitions
- Include comprehensive error handling
- Follow the established documentation style
- Import WITHOUT file extensions (esbuild resolves them automatically)
Build System
- Uses esbuild for fast bundling and TypeScript for declarations
- Import statements should omit file extensions entirely
- IDE refactoring is safe - no extension-related build failures