mirror of
https://github.com/opf/openproject.git
synced 2026-06-14 03:30:14 +00:00
Jan Sandbrink
1279c0dc2c
We separated projects from portfolios and programs conceptually. While older APIs can return mixed results for backwards-compatibility purposes, the MCP API already purely returns projects from the search_projects tool, thus we need additional tools for results of other types.
77 lines
2.8 KiB
Ruby
77 lines
2.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
#-- copyright
|
|
# OpenProject is an open source project management software.
|
|
# Copyright (C) the OpenProject GmbH
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License version 3.
|
|
#
|
|
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
|
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
|
# Copyright (C) 2010-2013 the ChiliProject Team
|
|
#
|
|
# 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 2
|
|
# 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, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
#
|
|
# See COPYRIGHT and LICENSE files for more details.
|
|
#++
|
|
|
|
module McpTools
|
|
class SearchPrograms < Base
|
|
default_title "Search programs"
|
|
default_description "Search programs matching all of the passed input parameters. " \
|
|
"Parameters not passed are ignored. Results are limited to a maximum " \
|
|
"of #{page_size} programs. To get the rest of the results, call the tool again with a" \
|
|
"page number of 2 or higher."
|
|
|
|
name "search_programs"
|
|
annotations read_only: true, idempotent: true, destructive: false
|
|
enable_pagination
|
|
|
|
filter :name, filter_class: Queries::Projects::Filters::NameFilter, operator: "~"
|
|
filter :identifier
|
|
filter :status_code
|
|
|
|
input_schema(
|
|
type: :object,
|
|
properties: {
|
|
name: { type: "string", description: "Name of the program. Accepts partial names, not case-sensitive." },
|
|
identifier: { type: "string", description: "Program identifier. Case-sensitive, matching exactly." },
|
|
status_code: { type: "string", enum: Project.status_codes.keys, description: "The program status." }
|
|
}
|
|
)
|
|
|
|
output_schema(
|
|
type: :object,
|
|
required: ["items"],
|
|
properties: {
|
|
items: {
|
|
type: :array,
|
|
items: JsonSchemaLoader.new.load("program_model")
|
|
}
|
|
}
|
|
)
|
|
|
|
def call(page: nil, **filters)
|
|
filtered = apply_filters(Project.program.visible, filters)
|
|
programs = apply_pagination(filtered, page)
|
|
|
|
{
|
|
items: programs.map { |p| API::V3::Projects::ProjectRepresenter.create(p, current_user:) }
|
|
}
|
|
end
|
|
end
|
|
end
|