CRMEB/backend/modules/service/mcp/tools/UserLabelCreateTool.php
sugar1569 a30565b3a0 feat: 新增MCP工具集合,包含用户、财务类业务接口
本次提交新增12个MCP工具,覆盖用户管理与财务统计场景:
- 用户类:用户标签列表、标签创建/删除/设置、分组设置、会员等级/时长赠送、用户资料/备注修改
- 财务类:充值记录/统计、余额流水、佣金流水、提现申请/统计、发票记录
所有工具均实现完整的入参校验、业务逻辑与脱敏处理,符合管理后台同链路操作逻辑。
2026-09-24 11:58:20 +08:00

183 lines
6.2 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
// +----------------------------------------------------------------------
// | CRMEB [ CRMEB赋能开发者,助力企业发展 ]
// +----------------------------------------------------------------------
// | Copyright (c) 2016~2026 https://www.crmeb.com All rights reserved.
// +----------------------------------------------------------------------
// | Licensed CRMEB并不是自由软件,未经许可不能去掉CRMEB相关版权
// +----------------------------------------------------------------------
// | Author: CRMEB Team <admin@crmeb.com>
// +----------------------------------------------------------------------
declare(strict_types=1);
namespace modules\service\mcp\tools;
use app\services\user\UserLabelCateServices;
use app\services\user\UserLabelServices;
use crmeb\exceptions\AdminException;
use crmeb\interfaces\McpToolInterface;
use modules\service\mcp\McpException;
/**
* MCP 工具:创建用户标签
*
* 与管理后台「用户标签」同链路:调用 UserLabelServices::save 新建标签;
* 参数预检在工具层完成(McpException 消息可透传),服务层业务校验不因 AI 调用而豁免。
*/
class UserLabelCreateTool implements McpToolInterface
{
/**
* 用户标签服务
* @var UserLabelServices
*/
private UserLabelServices $services;
/**
* 标签分类服务
* @var UserLabelCateServices
*/
private UserLabelCateServices $cateServices;
/**
* 构造函数
* @param UserLabelServices $services 用户标签服务
* @param UserLabelCateServices $cateServices 标签分类服务
*/
public function __construct(UserLabelServices $services, UserLabelCateServices $cateServices)
{
$this->services = $services;
$this->cateServices = $cateServices;
}
/**
* 工具名称
* @return string
*/
public function name(): string
{
return 'crmeb_user_label_create';
}
/**
* 交互声明:创建标签会新增系统配置数据,需用户确认后才真实执行
* @return string execute=需确认后执行
*/
public function interaction(): string
{
return 'execute';
}
/**
* 工具描述
* @return string
*/
public function description(): string
{
return '创建一个用户标签(管理后台「用户标签」体系),成功后即可通过后台给用户打标;返回创建结果摘要;'
. '必填参数:label_name 标签名称(非空,50 字以内);label_cate 标签分类 ID(大于 0 的整数,'
. '必须是已存在的分类,可用分类见 crmeb_user_label_list 返回的 cates 字段);'
. '同一分类下不允许与既有标签重名;创建成功后可通过 crmeb_user_label_list 查询确认,'
. '修改已有标签用 crmeb_user_label_update,删除标签用 crmeb_user_label_delete。';
}
/**
* 工具中文名(管理后台展示)
* @return string
*/
public function label(): string
{
return '标签创建';
}
/**
* 工具分类(管理后台分组展示)
* @return string
*/
public function category(): string
{
return '用户';
}
/**
* 入参 Schema
* @return array
*/
public function inputSchema(): array
{
return [
'type' => 'object',
'required' => ['label_name', 'label_cate'],
'properties' => [
'label_name' => ['type' => 'string', 'maxLength' => 50, 'description' => '标签名称,非空,50 字以内'],
'label_cate' => ['type' => 'integer', 'minimum' => 1, 'description' => '标签分类 ID,必须是已存在的分类,可用分类见 crmeb_user_label_list 返回的 cates'],
],
];
}
/**
* 执行工具
*
* @param array $args 参数(label_name/label_cate)
* @return array 创建结果摘要
* @throws McpException 参数非法或服务层业务校验失败
*/
public function execute(array $args): array
{
$name = trim((string)($args['label_name'] ?? ''));
if ($name === '') {
throw new McpException('label_name 不能为空');
}
if (mb_strlen($name) > 50) {
throw new McpException('label_name 不能超过 50 个字');
}
$cateId = self::positiveIntegerArg($args, 'label_cate');
if (!$this->cateExists($cateId)) {
throw new McpException('label_cate 标签分类不存在,可用分类见 crmeb_user_label_list 返回的 cates');
}
// 与 UserLabelController::save 的 postMore 结构保持一致,由服务层完成入库与查重
try {
$this->services->save(0, ['id' => 0, 'label_cate' => $cateId, 'label_name' => $name]);
} catch (AdminException $e) {
// 服务层业务校验失败:转 McpException 让消息透传给 AI 客户端
throw new McpException($e->getMessage());
}
return [
'label_name' => $name,
'label_cate' => $cateId,
'message' => '用户标签创建成功,可通过 crmeb_user_label_list 查询确认',
];
}
/**
* 校验标签分类是否存在
* @param int $cateId 分类 ID
* @return bool 是否存在
*/
private function cateExists(int $cateId): bool
{
$cateIds = array_map('intval', array_column($this->cateServices->getLabelCateAll(), 'id'));
return in_array($cateId, $cateIds, true);
}
/**
* @param array $args 工具参数
* @param string $name 参数名称
* @return int 大于 0 的整数
* @throws McpException 非整数或小于等于 0
*/
private static function positiveIntegerArg(array $args, string $name): int
{
$value = $args[$name] ?? null;
if (!is_int($value) && (!is_string($value) || !ctype_digit($value))) {
throw new McpException($name . ' 必须是大于 0 的整数');
}
$number = (int)$value;
if ($number <= 0) {
throw new McpException($name . ' 必须是大于 0 的整数');
}
return $number;
}
}