Canny MCP Server

# Canny MCP Server Setup Guide ## Overview The Canny MCP Server has been successfully built and is ready for use. This guide will help you configure and integrate it with Claude. ## Project Status ✅ ### Completed Components 1. **Core Server Implementation** - MCP server with proper error handling - TypeScript implementation with full type safety - Rate limiting and API validation - Comprehensive tool suite 2. **Available Tools** - `get_boards` - List all accessible Canny boards - `get_posts` - Get posts from specific board with filtering - `get_post` - Get detailed post information - `search_posts` - Search posts across boards - `create_post` - Create new posts - `update_post` - Update existing posts 3. **Built Features** - Input validation using Zod schemas - Rate limiting protection - Comprehensive error handling - TypeScript compilation successful - Ready-to-use distribution files ## Next Steps ### 1. Get Your Canny API Key 1. Go to your Canny account settings 2. Navigate to API section 3. Generate or copy your API key ### 2. Configure Environment Create a `.env` file in the project root: ```bash cp .env.example .env ``` Edit `.env` and add your API key: ``` CANNY_API_KEY=your_actual_api_key_here ``` ### 3. Claude Configuration Add this to your Claude MCP configuration file: ```json { "mcpServers": { "canny": { "command": "node", "args": ["/Users/briandawson/workspace/canny-mcp-server/dist/server.js"], "env": { "CANNY_API_KEY": "your_api_key_here" } } } } ``` ### 4. Test the Integration Try these commands with Claude: 1. **List boards**: "Show me all my Canny boards" 2. **Get posts**: "Get the latest posts from board ID 'your-board-id'" 3. **Search**: "Search for posts about 'feature request'" ## Development Commands - **Build**: `npm run build` - **Development**: `npm run dev` - **Test**: `npm test` - **Lint**: `npm run lint` ## Architecture Highlights Following CIQ's CODE2 principles: - **Customer-Centric**: Tools designed for easy feedback management - **Optimistic**: Robust error handling with helpful messages - **Dedicated**: Complete implementation with comprehensive features - **Efficient**: Rate limiting and optimized API calls - **Excellent**: Full TypeScript implementation with proper validation ## Troubleshooting ### Common Issues 1. **API Key Error**: Ensure your Canny API key is correctly set 2. **Build Issues**: Run `npm install` if dependencies are missing 3. **Rate Limits**: Server includes built-in rate limiting protection ### Support The server is production-ready and includes comprehensive error messaging to help debug any issues. ## Files Structure ``` /Users/briandawson/workspace/canny-mcp-server/ ├── src/ # Source code ├── dist/ # Built JavaScript files (ready for use) ├── tests/ # Test files ├── package.json # Dependencies and scripts ├── tsconfig.json # TypeScript configuration ├── README.md # Comprehensive documentation └── .env.example # Environment template ``` The server is now ready for use with Claude! 🚀