员工奖励管理服务器

用于与Bonusly API交互的MCP服务器,通过Claude和其他MCP客户端管理员工奖励。

  • by ajramos
  • Python
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 ajramos/mcp-bonusly

使用说明

mcp bonely

Bonely员工识别平台的综合MCP服务器

MCP服务器与Bonly API交互,通过Claude和其他MCP客户管理员工表彰奖金。

🚀 可用时间: 史密瑟里 便于本地安装!

目录

快速开始

快速安装

git clone https://github.com/ajramos/mcp-bonusly
cd mcp-bonusly
uv sync

快速设置

  1. 从获取Bonly API代币https://bonus.ly/api
  2. 创建一个 .env 使用您的令牌创建文件:
    BONUSLY_API_TOKEN=your_api_token_here
    
  3. 配置Claude Desktop以使用服务器

特性

✨ 完整的奖金管理

  • 列出奖金 具有高级过滤功能(包括用于团队分析的新useremail参数)
  • 创建新奖金 通过验证
  • 检索奖金详细信息 特定奖金

🔍 高级过滤

  • 按日期范围筛选
  • 按发件人电子邮件筛选
  • 按收件人电子邮件筛选
  • 按标签筛选
  • 限制结果数量

🛡️ 安全

  • 使用API令牌进行安全身份验证
  • 输入数据验证
  • 稳健的错误处理

安装

选项1:从Smithery安装(推荐)

此MCP可在 史密瑟里 作为本地安装:

  1. 访问 史密瑟里
  2. 搜索“mcp bonusly”
  3. 遵循本地MCP的安装说明
  4. 配置Bonally API令牌(请参阅下面的“设置”部分)

选项2:使用紫外线手动安装

git clone https://github.com/ajramos/mcp-bonusly
cd mcp-bonusly
uv sync

选项3:使用pip手动安装

git clone https://github.com/ajramos/mcp-bonusly
cd mcp-bonusly
pip install -e .

设置

1.获取Bonly API代币

  1. 首选https://bonus.ly/api
  2. 登录您的Bonusly帐户
  3. 创建新的API令牌
  4. 复制生成的令牌

2.配置环境变量

创建一个 .env 项目根目录中的文件:

BONUSLY_API_TOKEN=your_api_token_here

3.配置克劳德桌面

将此配置添加到您的Claude Desktop配置文件中:

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

可用工具

🎁 list_bonuses

列出带有可选过滤器的奖金。

参数:

  • limit (可选):要返回的奖金数量(1-100,默认值:20)
  • start_date (可选):开始日期(格式:YYYY-MM-DD)
  • end_date (可选):结束日期(格式:YYYY-MM-DD)
  • giver_email (可选):发件人的电子邮件地址
  • receiver_email (可选):收件人的电子邮件地址
  • user_email (可选):用户的电子邮件地址(该用户给予或收到的奖金)。 建议用于团队分析:单独搜索每个团队成员,以确保完全覆盖。
  • hashtag (可选):要过滤的标签(例如#teamwork)
  • include_children (可选):包括奖励回复

🆕 create_bonus

创建新的认可奖金。

参数:

  • giver_email (可选):赠送者的电子邮件地址(仅限管理员,普通用户以自己的名义发送奖金)
  • reason (必填):奖金原因(例如,“#团队合作+10@用户”)
  • parent_bonus_id (可选):用于回复的家长奖励ID

🔍 get_bonus

获取特定奖金的详细信息。

参数:

  • bonus_id (必填):要检索的奖金ID

示例提示

列出最近的奖金

"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"

发展

设置开发环境

git clone https://github.com/ajramos/mcp-bonusly
cd mcp-bonusly
uv sync
uv run mcp-bonusly

使用MCP检查器进行调试

为了获得最佳的调试体验,我们建议使用MCP检查器:

npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-bonusly run mcp-bonusly

查看服务器日志

# macOS
tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-bonusly.log

# Linux 
tail -n 20 -f ~/.config/Claude/logs/mcp-server-mcp-bonusly.log

# Windows
Get-Content "$env:APPDATA\Claude\logs\mcp-server-mcp-bonusly.log" -Wait -Tail 20

项目结构

mcp-bonusly/
├── src/
│   └── mcp_bonusly/
│       ├── __init__.py
│       ├── server.py          # Main MCP server
│       ├── client.py          # Bonusly API client
│       ├── models.py          # Pydantic models
│       └── exceptions.py      # Custom exceptions
├── tests/                     # Tests (coming soon)
├── .env.example              # Environment variables example
├── .gitignore
├── README.md
├── pyproject.toml
└── LICENSE

安全

  • 所有凭据都通过环境变量处理
  • API令牌存储安全
  • 除Bonly API外,不向第三方发送任何数据
  • 所有操作的输入验证

贡献

欢迎投稿!拜托:

  1. 分叉存储库
  2. 创建要素分支(git checkout -b feature/new-feature)
  3. 提交您的更改(git commit -am 'Add new feature')
  4. 推到分支(git push origin feature/new-feature)
  5. 打开拉取请求

许可证

MIT许可证-有关详细信息,请参阅许可证文件。

支持

如果您遇到任何问题:

  1. 检查日志 使用上面的调试说明
  2. 验证您的API令牌 在 .env 文件
  3. 打开一个问题 与:
    • 您的操作系统
    • Python版本
    • 错误消息或日志
    • 重现问题的步骤

关于Bonely

Bonusly是一个员工认可平台,使公司能够创造一种欣赏和参与的文化。员工可以通过反映公司价值观的个性化信息和标签互相打分。


创建于❤️ 安吉尔·拉莫斯