Getting Started

If you don't want to read anything else, and just want to get rolling, the URL for our MCP server is: https://bonus.ly/mcp. In any AI tool that accepts custom connectors, you should be able to add it and the tool should be able to handle the rest.

We've found a couple of tools that don't quite support all of OAuth client discovery, so you might need to add the scopes to the configuration (we found this in Cursor, but it might be true for others). Here's the entire list:

"user:read","company:read","user:write","user:administer","company:administer","billing:administer","reports:administer","finance:administer","recognition:read","recognition:write","recognition:administer","rewards:read","rewards:administer","awards:read","awards:write","awards:administer","celebrations:read","celebrations:administer","incentives:read","incentives:write","incentives:administer","nominations:read","nominations:write","nominations:administer","announcements:read","announcements:administer","growth:read","growth:write","growth:administer","goals:read","goals:write","goals:administer","checkins:read","checkins:write","checkins:administer","uploads:write"

Read on for more details and current status! The rest of the API docs here can tell you what's available! If you have other questions or feedback, we'd love to hear it! Reach out to [email protected]!

What is MCP anyway?

MCP stands for "Model Context Protocol" which no one needs to remember, not even me. You can think of it as a "connector" - it's a server that allows an AI to access data and/or perform actions on behalf of a user.

When you connect Bonusly's MCP Server to Claude, this is what happens:

  • It will ask you to connect, which will open a browser and ask you to log in to Bonusly and then ask you to authorize Claude to act as you. That's called a "grant". You're basically delegating your permissions to Claude, so whatever Claude does, it's doing on your behalf.
  • Once you authorize the grant, you'll get redirected back to Claude, and in the background, Claude will get a token that it can use to make requests.
  • With that token, Claude will ask the MCP Server what it can do: it asks for a list of prompts, resources and tools. Right now, we only provide tools, but may provide other things in the future. This site also lists all the tools we currently provide. Any AI that connects will get basically the same information: title, description and input schema.

Now that your AI (we're using Claude as a convenience, any AI tool that supports MCP connections and OAuth client discovery should work) is connected and has a token, you can ask it to either use specific tools, or just describe what you want it to do with Bonusly and see if it can figure out what tools to use based on their titles and descriptions.