Frequently Asked Questions (FAQ) about the Bonusly MCP Server

Q: What is the Bonusly MCP Server? A: The Bonusly MCP (Model Context Protocol) Server is a tool that allows you to interact with the Bonusly employee recognition platform using natural language commands through AI models like Claude. It acts as a bridge between the AI and the Bonusly API, making it easier to manage bonuses, filter data, and gain insights into employee recognition.

Q: What is Smithery and why is it recommended for installation? A: Smithery is a platform that simplifies the installation of local MCPs (Model Context Protocols). It’s recommended because it provides a streamlined process, ensuring compatibility with the latest versions of the Bonusly MCP server and its dependencies.

Q: How do I get a Bonusly API token? A: 1. Go to https://bonus.ly/api. 2. Sign in to your Bonusly account. 3. Create a new API token. 4. Copy the generated token and store it securely.

Q: Where do I store the Bonusly API token? A: You should store the Bonusly API token in a .env file located in the root directory of the mcp-bonusly project. The file should contain the line BONUSLY_API_TOKEN=your_api_token_here, replacing your_api_token_here with your actual token.

Q: How do I configure Claude Desktop to use the Bonusly MCP Server? A: Add the following configuration to your Claude Desktop configuration file, adjusting the paths as necessary:

{ “mcpServers”: { “mcp-bonusly”: { “command”: “uv”, “args”: [ “–directory”, “/full/path/to/mcp-bonusly”, “run”, “mcp-bonusly” ], “env”: { “BONUSLY_API_TOKEN”: “your_api_token_here” } } } }

Replace /full/path/to/mcp-bonusly with the actual path to your mcp-bonusly directory and your_api_token_here with your Bonusly API token.

Q: What are the available tools in the Bonusly MCP Server? A: The available tools are:

• list_bonuses: Lists bonuses with optional filters.
• create_bonus: Creates a new recognition bonus.
• get_bonus: Gets details of a specific bonus.

Q: What are some example prompts I can use with the Bonusly MCP Server? A: Here are a few examples:

• "Show me the last 10 bonuses given"
• "Create a 5-point bonus for john@company.com for excellent work on the project with #teamwork"
• "Show me all bonuses with hashtag #innovation from last month"
• "Get details for bonus with ID 24abcdef1234567890abcdef"

Q: What is the purpose of the user_email parameter in the list_bonuses tool? A: The user_email parameter allows you to filter bonuses given or received by a specific user. It’s particularly recommended for team analysis to ensure complete coverage when searching for bonuses related to individual team members.

Q: How do I view the server logs for debugging? A: The server logs can be found in the following locations:

• macOS: ~/Library/Logs/Claude/mcp-server-mcp-bonusly.log
• Linux: ~/.config/Claude/logs/mcp-server-mcp-bonusly.log
• Windows: $env:APPDATAClaudelogsmcp-server-mcp-bonusly.log

Q: What should I do if I encounter issues with the Bonusly MCP Server? A: 1. Check the logs for error messages. 2. Verify your API token in the .env file. 3. Open an issue on the GitHub repository with details about your operating system, Python version, error messages, and steps to reproduce the issue.

Q: Can I contribute to the development of the Bonusly MCP Server? A: Yes! Contributions are welcome. Please fork the repository, create a feature branch, commit your changes, push to the branch, and open a pull request.