Merge pull request #3 from incident-io/chris/post-migration-tidy-up

Prepare repository for public use

Author: evnsio

.claude/settings.local.json

@@ -5,4 +5,4 @@
 INCIDENT_IO_API_KEY=your_api_key_here
 
 # Optional: Custom incident.io endpoint
-# INCIDENTIO_ENDPOINT=https://api.incident.io
+# INCIDENT_IO_BASE_URL=https://api.incident.io/v2

.env.example

@@ -31,4 +31,7 @@ Thumbs.db
 
 # Environment
 .env
-*.env
+*.env
+
+# Claude Code settings
+.claude/settings.local.json

.gitignore

@@ -0,0 +1,143 @@
+# Configuration Guide
+
+This document covers environment variables, server configuration, and deployment options for the incident.io MCP server.
+
+## Environment Variables
+
+### Required
+
+- **`INCIDENT_IO_API_KEY`** - Your incident.io API key for authentication
+  - Obtain from your incident.io account settings
+  - Required for all API operations
+
+### Optional
+
+- **`INCIDENT_IO_BASE_URL`** - Base URL for incident.io API
+  - Default: `https://api.incident.io/v2`
+  - Only change if using a different incident.io instance
+
+## Configuration Files
+
+### `.env` File
+
+Create a `.env` file in the project root for local development:
+
+```bash
+# Copy from example
+cp .env.example .env
+
+# Edit with your values
+INCIDENT_IO_API_KEY=your_api_key_here
+# INCIDENT_IO_BASE_URL=https://api.incident.io/v2  # Optional
+```
+
+## MCP Client Configuration
+
+### Claude Desktop
+
+Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "incident-io": {
+      "command": "/path/to/your/project/start-mcp-server.sh",
+      "env": {
+        "INCIDENT_IO_API_KEY": "your_api_key_here"
+      }
+    }
+  }
+}
+```
+
+### Other MCP Clients
+
+For other MCP clients, configure them to:
+
+1. Execute the `start-mcp-server.sh` script
+2. Set the `INCIDENT_IO_API_KEY` environment variable
+3. Optionally set `INCIDENT_IO_BASE_URL` if needed
+
+## Server Options
+
+### Standard Server
+
+```bash
+./start-mcp-server.sh
+```
+
+- Minimal startup validation
+- Graceful handling of missing API key
+
+### Validated Server
+
+```bash
+./start-with-env.sh
+```
+
+- Validates API key is set before starting
+- Auto-builds server if binary is missing
+- Exits with error if API key is missing
+
+## Deployment Considerations
+
+### Docker
+
+If deploying with Docker, ensure environment variables are passed:
+
+```dockerfile
+ENV INCIDENT_IO_API_KEY=${INCIDENT_IO_API_KEY}
+```
+
+### System Service
+
+When running as a system service, ensure:
+
+1. Environment variables are properly set
+2. Working directory is set to the project root
+3. Binary has appropriate permissions
+
+### Security Notes
+
+- **Never commit API keys to version control**
+- Use environment variables or secure secret management
+- Restrict file permissions on configuration files containing secrets
+- Consider using dedicated service accounts with minimal required permissions
+
+## API Rate Limits
+
+The incident.io API has rate limits. The server handles these gracefully, but be aware:
+
+- Plan API usage according to your incident.io plan limits
+- Consider caching strategies for frequently accessed data
+- Monitor API usage through incident.io dashboard
+
+## Troubleshooting Configuration
+
+### Missing API Key
+
+```
+Error: INCIDENT_IO_API_KEY environment variable is not set
+```
+
+**Solution**: Set the API key in your `.env` file or environment
+
+### Invalid API Key
+
+```
+Authentication failed
+```
+
+**Solution**: Verify your API key is correct and has necessary permissions
+
+### Connection Issues
+
+```
+Failed to connect to incident.io API
+```
+
+**Solutions**:
+
+- Check network connectivity
+- Verify `INCIDENT_IO_BASE_URL` if using custom endpoint
+- Check firewall settings

CONFIGURATION.md

@@ -55,7 +55,7 @@ git clone https://github.com/your-username/incidentio-mcp-golang.git
 cd incidentio-mcp-golang
 
 # Add upstream remote
-git remote add upstream https://github.com/twentworth12/incidentio-mcp-golang.git
+git remote add upstream https://github.com/incident-io/incidentio-mcp-golang.git
 
 # Install dependencies
 go mod download

CONTRIBUTING.md

@@ -11,7 +11,7 @@
 ### 1. Clone and Build
 
 ```bash
-git clone https://github.com/tomwentworth/incidentio-mcp-golang.git
+git clone https://github.com/incident-io/incidentio-mcp-golang.git
 cd incidentio-mcp-golang
 go build -o bin/mcp-server ./cmd/mcp-server
 ```

DEPLOYMENT.md

@@ -0,0 +1,114 @@
+# Development Guide
+
+This document covers development setup, testing, and contribution guidelines for the incident.io MCP server.
+
+## Prerequisites
+
+- Go 1.21 or higher
+- Access to incident.io API (for testing)
+
+## Setup
+
+1. Clone the repository
+2. Copy `.env.example` to `.env` and configure your API key:
+   ```bash
+   cp .env.example .env
+   # Edit .env and add your INCIDENT_IO_API_KEY
+   ```
+
+## Building
+
+Build the MCP server:
+```bash
+go build -o bin/mcp-server ./cmd/mcp-server
+```
+
+## Running
+
+### Quick Start
+```bash
+./start-mcp-server.sh
+```
+
+### With Environment Validation
+```bash
+./start-with-env.sh
+```
+
+This script will:
+- Load environment variables from `.env`
+- Validate that required API keys are set
+- Build the server if needed
+- Start the MCP server
+
+### Testing API Connection
+```bash
+./tests/test_api.sh
+```
+
+## Testing
+
+### Unit Tests
+```bash
+# Run all tests
+go test ./...
+
+# Run specific package tests
+go test ./internal/incidentio/...
+
+# Run tests with verbose output
+go test -v ./...
+```
+
+### Integration Tests
+```bash
+# Test API endpoints
+./tests/test_endpoints.sh
+```
+
+## Code Quality
+
+### Formatting
+```bash
+go fmt ./...
+```
+
+### Linting
+```bash
+# If golangci-lint is available
+golangci-lint run
+```
+
+## Project Structure
+
+- `/cmd/` - Entry points for different server configurations
+- `/internal/incidentio/` - incident.io API client implementation  
+- `/internal/tools/` - MCP tool implementations
+- `/internal/server/` - MCP server logic
+- `/tests/` - Integration test scripts
+
+## Development Standards
+
+- Use Go 1.21+ features and idioms
+- Follow standard Go formatting (gofmt)
+- Use meaningful variable and function names
+- Handle errors explicitly, don't ignore them
+- Write tests for new functionality
+- Update documentation for API changes
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes following the development standards
+4. Add tests for new functionality
+5. Run the full test suite
+6. Submit a pull request
+
+## Debugging
+
+For debugging issues:
+1. Check that your API key is correctly set
+2. Verify API connectivity with `./tests/test_api.sh`
+3. Check server logs for detailed error messages
+4. Use Go's built-in debugging tools for development