Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OPENAI_API_KEY | No | Your OpenAI API key for using OpenAI models for image analysis. | |
| PEEKABOO_CLI_PATH | No | Optional override for the Swift peekaboo CLI executable path. | uses bundled CLI |
| PEEKABOO_LOG_FILE | No | Path to the server's log file. If the specified directory is not writable, falls back to the system temp directory. | ~/Library/Logs/peekaboo-mcp.log |
| PEEKABOO_LOG_LEVEL | No | Logging level (trace, debug, info, warn, error, fatal). | info |
| PEEKABOO_CLI_TIMEOUT | No | Timeout in milliseconds for Swift CLI operations. Prevents hanging processes. | 30000 |
| PEEKABOO_AI_PROVIDERS | No | JSON string defining AI providers for image analysis. Format: 'provider_name/model_identifier' using commas or semicolons as separators. | |
| PEEKABOO_CONSOLE_LOGGING | No | Boolean ("true"/"false") for development console logs. | false |
| PEEKABOO_OLLAMA_BASE_URL | No | Base URL for the Ollama API server. Only needed if Ollama is running on a non-default address. | http://localhost:11434 |
| PEEKABOO_DEFAULT_SAVE_PATH | No | Default directory for saving captured images when no path is specified. | System temp directory |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| image | Captures macOS screen content and optionally analyzes it. Targets can be entire screen, specific app window, or all windows of an app (via app_target). Supports foreground/background capture. Output via file path or inline Base64 data (format: "data"). If a question is provided, image is analyzed by an AI model (auto-selected from PEEKABOO_AI_PROVIDERS). Window shadows/frames excluded. Peekaboo MCP 1.1.0 using openai/gpt-4-vision, anthropic/claude-3-opus, google/gemini-pro-vision |
| analyze | Analyzes a pre-existing image file from the local filesystem using a configured AI model. This tool is useful when an image already exists (e.g., previously captured, downloaded, or generated) and you need to understand its content, extract text, or answer specific questions about it. Capabilities:
Example: If you have an image '/tmp/chart.png' showing a bar chart, you could ask: { "image_path": "/tmp/chart.png", "question": "Which category has the highest value in this bar chart?" } The AI will analyze the image and attempt to answer your question based on its visual content. Peekaboo MCP 1.1.0 using openai/gpt-4-vision, anthropic/claude-3-opus, google/gemini-pro-vision |
| list | Lists various system items on macOS, providing situational awareness. Capabilities:
Use Cases:
|