mcptool.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2026 Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2026 Nick Fragoulis
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
abstract class McpTool
{
  const RIGHTS_ENFORCED_DOWNSTREAM = 'downstream';
 
  const RIGHTS_UNDECLARED = 'undeclared';
 
  const NO_WRITE = '';
 
  protected $db;
 
  protected $user;
 
  protected $conf;
 
  public function __construct($db, $user, $conf)
  {
    $this->db = $db;
    $this->user = $user;
    $this->conf = $conf;
  }
 
  abstract public function getDefinitions(): array;
 
  abstract public function execute(string $toolName, array $args);
 
  public function getCategories(): array
  {
    return ['global']; // Default
  }
 
  public function isSystem()
  {
    return false;
  }
 
  public function getRequiredRights(string $toolName)
  {
    return self::RIGHTS_UNDECLARED;
  }
  public function writeConfirmationPreview(string $toolName, array $args)
  {
    return self::NO_WRITE;
  }
}