Skip to content
Sign in

flagon-io/g1t

public
0

g1t/apps/api/src/tools.rs

931 lines55,218 bytesCodeBlame
1//! The MCP server's tools: a few resource tools, each with an `action`.
2//!
3//! Every operation is one action of one tool. A call is dispatched to the
4//! operation it names, so permissions, the audit log, billing and outcomes
5//! are exactly those of the REST API. A token sees only the actions its
6//! scopes allow, and a tool none of whose actions it may use is not listed.
7//!
8//! The listed input schema is one flat object: `action`, then every field
9//! any of its actions takes. Which fields each action needs is in the
10//! `action` field's description and checked on every call. Claude's API,
11//! and so most MCP clients, refuse a tool whose input schema has `oneOf`
12//! at its top level, so the schema keyed by action, with each action's
13//! required fields, is [`discriminated`], published on the server's card
14//! and in the docs.
15
16use g1t_contracts::credentials::NEVER;
17use g1t_contracts::identity::AgentScope;
18use g1t_contracts::scopes::{Level, NO_SCOPE, TokenAccess, scope_for};
19use serde_json::{Map, Value, json};
20
21use crate::about::AboutOp;
22use crate::deployments::DeploymentsOp;
23use crate::operations::Op;
24use crate::checks::ChecksOp;
25use crate::rules::RulesOp;
26use crate::security::SecurityOp;
27
28pub struct Action {
29 pub name: &'static str,
30 pub op: Op,
31 /// One line, for the `action` field's description.
32 pub summary: &'static str,
33}
34
35pub struct Tool {
36 pub name: &'static str,
37 pub title: &'static str,
38 /// What it is for, in a sentence or two.
39 pub description: &'static str,
40 pub actions: &'static [Action],
41 /// The action a call without one runs.
42 pub default_action: Option<&'static str>,
43}
44
45const fn a(name: &'static str, op: Op, summary: &'static str) -> Action {
46 Action { name, op, summary }
47}
48
49pub const TOOLS: &[Tool] = &[
50 Tool {
51 name: "search",
52 title: "Search",
53 description: "Find things. `code` (the default) searches all of g1t you can see: repositories, code, issues, pull requests and people, with qualifiers like repo:owner/name, language:rust, is:issue. `context` searches one workspace's catalog, docs, issues and memory by meaning.",
54 default_action: Some("code"),
55 actions: &[
56 a("code", Op::Search, "Search all of g1t: repositories, code, issues, pull requests, people"),
57 a("context", Op::SearchContext, "Search a workspace's context hub by meaning"),
58 a("entity", Op::GetEntity, "One catalog entry and its relations"),
59 a("ticket", Op::GetContext, "A Jira, Linear or Sentry item the work refers to, as it is now"),
60 ],
61 },
62 Tool {
63 name: "repository",
64 title: "Repositories",
65 description: "Repositories: find, read and create them, change their settings and rulesets (what may happen to branches and tags, and what a pull request needs to merge), check their CODEOWNERS file, manage their labels and milestones, see and dismiss their security alerts (secrets and vulnerable dependencies), read what their default branch says (languages, contributors, license), star them, and publish releases. Name one as \"owner/name\". Deleting, transferring and changing visibility need `confirm`.",
66 default_action: None,
67 actions: &[
68 a("list", Op::ListRepos, "Repositories you can see"),
69 a("get", Op::GetRepo, "One repository"),
70 a("create", Op::CreateRepo, "Create one, empty or copied from a public git URL"),
71 a("update", Op::UpdateRepo, "Change description, website, topics, default branch, protection"),
72 a("get_settings", Op::GetRepoSettings, "How pull requests merge, and the default branch's protection as its rules stack"),
73 a("update_settings", Op::UpdateRepoSettings, "Change how pull requests merge and the default branch protection ruleset"),
74 a("check_names", Op::ListCheckNames, "Check names reported lately, to require in a ruleset"),
75 a("list_rulesets", Op::Rules(RulesOp::ListRepoRulesets), "Its rulesets, and its workspace's that hold in it"),
76 a("get_ruleset", Op::Rules(RulesOp::GetRepoRuleset), "One ruleset"),
77 a("create_ruleset", Op::Rules(RulesOp::CreateRepoRuleset), "Create a ruleset for its branches or tags"),
78 a("update_ruleset", Op::Rules(RulesOp::UpdateRepoRuleset), "Change a ruleset"),
79 a("delete_ruleset", Op::Rules(RulesOp::DeleteRepoRuleset), "Delete a ruleset"),
80 a("branch_rules", Op::Rules(RulesOp::GetBranchRules), "Every rule that holds for a branch or tag, and where it comes from"),
81 a("rule_evaluations", Op::Rules(RulesOp::ListRuleEvaluations), "How its rules judged pushes and merges, with insights"),
82 a("codeowners", Op::GetCodeownersErrors, "Problems in its CODEOWNERS file, by line"),
83 a("list_labels", Op::ListLabels, "Labels, with colors and how many issues and pull requests carry each"),
84 a("create_label", Op::CreateLabel, "Create a label"),
85 a("update_label", Op::UpdateLabel, "Rename a label or change its color or description"),
86 a("delete_label", Op::DeleteLabel, "Delete a label, from everything that carries it"),
87 a("add_default_labels", Op::AddDefaultLabels, "Add the default labels it is missing"),
88 a("list_milestones", Op::ListMilestones, "Milestones, with progress and due dates"),
89 a("get_milestone", Op::GetMilestone, "One milestone with its issues and pull requests"),
90 a("create_milestone", Op::CreateMilestone, "Create a milestone"),
91 a("update_milestone", Op::UpdateMilestone, "Change a milestone's title, description, due date or state"),
92 a("delete_milestone", Op::DeleteMilestone, "Delete a milestone"),
93 a("list_events", Op::ListEvents, "Timeline: pushes, issues, pull requests, comments"),
94 a("languages", Op::About(AboutOp::GetLanguages), "Its languages by bytes, with colors and percentages"),
95 a("contributors", Op::About(AboutOp::ListContributors), "Who made it: commits per person, agent and author, by week"),
96 a("license", Op::About(AboutOp::GetLicense), "The license its LICENSE file holds"),
97 a("stargazers", Op::About(AboutOp::ListStargazers), "Who starred it"),
98 a("starred", Op::About(AboutOp::CheckStarred), "Whether you starred it, and how many have"),
99 a("star", Op::About(AboutOp::Star), "Star it"),
100 a("unstar", Op::About(AboutOp::Unstar), "Take your star back"),
101 a("list_starred", Op::About(AboutOp::ListStarred), "Repositories you starred"),
102 a("list_releases", Op::About(AboutOp::ListReleases), "Releases, newest first"),
103 a("latest_release", Op::About(AboutOp::GetLatestRelease), "The latest release"),
104 a("get_release", Op::About(AboutOp::GetRelease), "One release by id"),
105 a("get_release_by_tag", Op::About(AboutOp::GetReleaseByTag), "The release of a tag"),
106 a("create_release", Op::About(AboutOp::CreateRelease), "Publish a release of a tag, making the tag if needed"),
107 a("update_release", Op::About(AboutOp::UpdateRelease), "Change a release's title, notes, draft or prerelease"),
108 a("delete_release", Op::About(AboutOp::DeleteRelease), "Delete a release; its tag stays"),
109 a("rename_branch", Op::RenameBranch, "Rename a branch"),
110 a("rename", Op::RenameRepo, "Rename it; old addresses redirect"),
111 a("transfer", Op::TransferRepo, "Move it to another workspace you own"),
112 a("archive", Op::ArchiveRepo, "Make it read-only"),
113 a("unarchive", Op::UnarchiveRepo, "Make it writable again"),
114 a("set_visibility", Op::SetRepoVisibility, "Make it public or private"),
115 a("delete", Op::DeleteRepo, "Delete it; restorable for 30 days"),
116 a("list_deleted", Op::ListDeletedRepos, "A workspace's deleted repositories"),
117 a("restore", Op::RestoreRepo, "Restore a deleted one"),
118 a("purge", Op::PurgeRepo, "Remove a deleted one for good"),
119 a("security_alerts", Op::ListSecurityAlerts, "Secret and dependency alerts, filtered by state"),
120 a("dismiss_alert", Op::DismissSecurityAlert, "Dismiss an alert with a reason"),
121 a("reopen_alert", Op::ReopenSecurityAlert, "Reopen a dismissed alert"),
122 ],
123 },
124 Tool {
125 name: "issue",
126 title: "Issues",
127 description: "Issues: what should change. Read one before working on it to see the pull requests already made for it. Issues and pull requests share numbers; `comment` works on either.",
128 default_action: None,
129 actions: &[
130 a("list", Op::ListIssues, "Issues on a repository, newest first"),
131 a("get", Op::GetIssue, "One issue with comments and its pull requests"),
132 a("create", Op::CreateIssue, "Open an issue"),
133 a("update", Op::UpdateIssue, "Change title, body, labels, milestone or assignees"),
134 a("labels", Op::ListIssueLabels, "The labels an issue or pull request carries"),
135 a("add_labels", Op::AddIssueLabels, "Add labels to an issue or pull request"),
136 a("set_labels", Op::SetIssueLabels, "Replace the labels of an issue or pull request"),
137 a("remove_labels", Op::RemoveIssueLabels, "Take labels off an issue or pull request"),
138 a("close", Op::CloseIssue, "Close it without a pull request"),
139 a("reopen", Op::ReopenIssue, "Reopen it"),
140 a("comment", Op::AddComment, "Comment on an issue or pull request; path and line for one line of a change"),
141 a("import", Op::ImportIssue, "Open an issue from a Jira, Linear or Sentry item"),
142 ],
143 },
144 Tool {
145 name: "pull_request",
146 title: "Pull requests",
147 description: "Pull requests: start a change for an issue, record your session, mark it ready, ask people and teams to review, review and merge. Read `overlaps` and `behind` on `get` before going far, and `code_owners` for whose approval it needs.",
148 default_action: None,
149 actions: &[
150 a("list", Op::ListPullRequests, "Pull requests on a repository, newest first"),
151 a("get", Op::GetPullRequest, "Status, checks and required checks, reviews, overlaps, whether it is behind"),
152 a("changes", Op::GetPullRequestChanges, "Files and line-by-line diff"),
153 a("create", Op::CreatePullRequest, "Start a draft with its own fork to push to, or open one from a pushed branch"),
154 a("update", Op::UpdatePullRequest, "Change its base branch, labels, milestone, assignees or reviewers"),
155 a("record_session", Op::RecordSession, "Append prompt, reasoning and tool entries to its session"),
156 a("read_session", Op::ReadSession, "Its recorded session"),
157 a("ready", Op::MarkPullRequestReady, "Mark a draft ready, with a summary"),
158 a("request_reviewers", Op::RequestReviewers, "Ask people or teams to review it"),
159 a("remove_requested_reviewers", Op::RemoveRequestedReviewers, "Stop asking people or teams to review it"),
160 a("review", Op::ReviewPullRequest, "Approve or request changes"),
161 a("close", Op::ClosePullRequest, "Close without merging"),
162 a("merge", Op::MergePullRequest, "Land it, or join the merge queue"),
163 a("merge_queue", Op::GetMergeQueue, "The repository's merge queue"),
164 ],
165 },
166 Tool {
167 name: "agent",
168 title: "g1t agents",
169 description: "Put g1t's agent to work and talk to it. One agent per issue; to do more at once, use more issues. Starting an agent uses the workspace's money.",
170 default_action: None,
171 actions: &[
172 a("delegate", Op::Delegate, "Open an issue and put an agent on it in one step"),
173 a("assign", Op::AssignIssue, "Put an agent on an existing issue"),
174 a("message", Op::MessageAgent, "Tell the agent on a pull request something, or ask another agent"),
175 a("answer", Op::AnswerMessage, "Answer a question or handoff sent to you"),
176 a("take_messages", Op::TakeMessages, "For a g1t agent: messages not seen yet"),
177 ],
178 },
179 Tool {
180 name: "plan",
181 title: "Plans",
182 description: "Turn an outcome into issues: an agent proposes them with what done means and their dependencies; nothing opens until you apply the plan.",
183 default_action: None,
184 actions: &[
185 a("create", Op::PlanWork, "Ask an agent for a plan; read it with get until ready"),
186 a("get", Op::GetPlan, "A plan and the issues it proposes"),
187 a("apply", Op::ApplyPlan, "Open its issues; with assign, agents start in dependency order"),
188 ],
189 },
190 Tool {
191 name: "memory",
192 title: "Memory",
193 description: "What the project and its workspace remember for the next agent: how to build, conventions, decisions, traps. Recall before you start; remember one short fact at a time, never a secret.",
194 default_action: None,
195 actions: &[
196 a("recall", Op::Recall, "Search memory, or list it all"),
197 a("remember", Op::Remember, "Save one fact"),
198 ],
199 },
200 Tool {
201 name: "workflow",
202 title: "Workflows",
203 description: "GitHub Actions workflows from .g1t/workflows: their runs, jobs and logs, and running, cancelling or rerunning them. Deployments wherever they run (reported from any CI, made by jobs with an `environment:`, or built on g1t.page), their statuses and environments, and reporting your own. Checks on commits: statuses, check runs (a g1t Actions job is one) and check suites, to read where a commit stands or report on it from CI or an integration. Also the self-hosted runners they run on: a workspace's (`workspace`) or a repository's own (`repo`), their groups, and where agent work runs.",
204 default_action: None,
205 actions: &[
206 a("list", Op::ListWorkflows, "Workflows on the default branch"),
207 a("list_runs", Op::ListWorkflowRuns, "Runs, newest first"),
208 a("get_run", Op::GetWorkflowRun, "One run with its jobs and steps"),
209 a("job_logs", Op::GetJobLogs, "A job's log after a sequence number"),
210 a("dispatch", Op::DispatchWorkflow, "Run a workflow_dispatch workflow"),
211 a("cancel", Op::CancelWorkflowRun, "Cancel a run"),
212 a("rerun", Op::RerunWorkflowRun, "Run a finished run again"),
213 a("update", Op::UpdateWorkflow, "Turn a workflow on or off"),
214 a("combined_status", Op::Checks(ChecksOp::GetCombinedStatus), "A commit's statuses and the state they add up to"),
215 a("list_statuses", Op::Checks(ChecksOp::ListCommitStatuses), "A commit's statuses, newest first"),
216 a("set_status", Op::Checks(ChecksOp::CreateCommitStatus), "Set a status on a commit"),
217 a("list_check_runs", Op::Checks(ChecksOp::ListCheckRunsForRef), "A commit's check runs, g1t Actions jobs included"),
218 a("get_check_run", Op::Checks(ChecksOp::GetCheckRun), "One check run with its report"),
219 a("check_run_annotations", Op::Checks(ChecksOp::ListCheckRunAnnotations), "What a check run says about lines of files"),
220 a("create_check_run", Op::Checks(ChecksOp::CreateCheckRun), "Report a check run on a commit"),
221 a("update_check_run", Op::Checks(ChecksOp::UpdateCheckRun), "Move a check run on, complete it, add annotations"),
222 a("rerequest_check_run", Op::Checks(ChecksOp::RerequestCheckRun), "Ask for a check run to run again"),
223 a("list_check_suites", Op::Checks(ChecksOp::ListCheckSuitesForRef), "A commit's check suites, one per reporter or workflow run"),
224 a("get_check_suite", Op::Checks(ChecksOp::GetCheckSuite), "One check suite"),
225 a("rerequest_check_suite", Op::Checks(ChecksOp::RerequestCheckSuite), "Ask for a check suite to run again"),
226 a("list_deployments", Op::Deployments(DeploymentsOp::ListDeployments), "Deployments wherever they run, newest first, filtered"),
227 a("get_deployment", Op::Deployments(DeploymentsOp::GetDeployment), "One deployment with every status it has had"),
228 a("create_deployment", Op::Deployments(DeploymentsOp::CreateDeployment), "Report a deployment of a ref to an environment"),
229 a("deployment_statuses", Op::Deployments(DeploymentsOp::ListDeploymentStatuses), "A deployment's statuses, newest first"),
230 a("create_deployment_status", Op::Deployments(DeploymentsOp::CreateDeploymentStatus), "Report where a deployment is: in_progress, success, failure"),
231 a("list_environments", Op::Deployments(DeploymentsOp::ListEnvironments), "Environments with their current and latest deployments"),
232 a("get_environment", Op::Deployments(DeploymentsOp::GetEnvironment), "One environment by name"),
233 a("list_runners", Op::ListRunners, "Self-hosted runners, with status, labels and what each is doing"),
234 a("create_runner_token", Op::CreateRunnerRegistrationToken, "A one-hour token for g1t-runner register"),
235 a("remove_runner", Op::RemoveRunner, "Remove a self-hosted runner"),
236 a("list_runner_groups", Op::ListRunnerGroups, "A workspace's runner groups"),
237 a("create_runner_group", Op::CreateRunnerGroup, "Make a group, for some repositories"),
238 a("update_runner_group", Op::UpdateRunnerGroup, "Rename a group or change its repositories"),
239 a("delete_runner_group", Op::DeleteRunnerGroup, "Delete a group; its runners join the default"),
240 a("get_runner_settings", Op::GetRunnerSettings, "Where agent work runs; whether forks may use runners"),
241 a("update_runner_settings", Op::UpdateRunnerSettings, "Change them"),
242 ],
243 },
244 Tool {
245 name: "secret",
246 title: "Secrets and variables",
247 description: "A repository's or workspace's secrets and variables, read by workflows and deployments. Secret values are never returned.",
248 default_action: None,
249 actions: &[
250 a("list_secrets", Op::ListActionsSecrets, "Secrets, without values"),
251 a("set_secret", Op::SetActionsSecret, "Add or change a secret"),
252 a("delete_secret", Op::DeleteActionsSecret, "Remove a secret"),
253 a("list_variables", Op::ListActionsVariables, "Variables, with values"),
254 a("set_variable", Op::SetActionsVariable, "Add or change a variable"),
255 a("delete_variable", Op::DeleteActionsVariable, "Remove a variable"),
256 ],
257 },
258 Tool {
259 name: "webhook",
260 title: "Webhooks",
261 description: "HTTPS addresses sent signed events as they happen, for a repository or a whole workspace.",
262 default_action: None,
263 actions: &[
264 a("list", Op::ListWebhooks, "Webhooks, without secrets"),
265 a("create", Op::CreateWebhook, "Register one; a ping is sent"),
266 a("update", Op::UpdateWebhook, "Change address, events or active"),
267 a("delete", Op::DeleteWebhook, "Remove one"),
268 a("ping", Op::PingWebhook, "Send a ping"),
269 a("list_deliveries", Op::ListWebhookDeliveries, "Latest deliveries"),
270 a("redeliver", Op::RedeliverWebhook, "Send a delivery again"),
271 ],
272 },
273 Tool {
274 name: "access",
275 title: "Who has access",
276 description: "Who has access to a repository and with which role (read, triage, write, maintain, admin), outside collaborators, and a workspace's base permission.",
277 default_action: None,
278 actions: &[
279 a("list_collaborators", Op::ListCollaborators, "Everyone with a role, and pending invitations"),
280 a("get_permission", Op::GetCollaboratorPermission, "One person's role and capabilities"),
281 a("add_collaborator", Op::AddCollaborator, "Give someone a role, by username or email"),
282 a("update_collaborator", Op::UpdateCollaborator, "Change a direct role"),
283 a("remove_collaborator", Op::RemoveCollaborator, "Take away a direct role"),
284 a("list_invitations", Op::ListRepoInvitations, "Pending invitations to a repository"),
285 a("revoke_invitation", Op::RevokeRepoInvitation, "Withdraw one"),
286 a("set_base_permission", Op::SetBasePermission, "What every member gets on each repository"),
287 a("list_outside_collaborators", Op::ListOutsideCollaborators, "People with roles who are not members"),
288 ],
289 },
290 Tool {
291 name: "team",
292 title: "Teams",
293 description: "Teams: groups of a workspace's members, given roles on repositories together, mentioned as @workspace/team and asked to review together. Name one by `workspace` and its slug (`team`). Any member may create a team; the workspace's owners and the team's maintainers manage it. A secret team is seen only by its people and the owners.",
294 default_action: None,
295 actions: &[
296 a("list", Op::ListTeams, "A workspace's teams you can see"),
297 a("get", Op::GetTeam, "One team"),
298 a("create", Op::CreateTeam, "Create a team; you become its maintainer"),
299 a("update", Op::UpdateTeam, "Change its name, slug, description, visibility, parent or notifications"),
300 a("delete", Op::DeleteTeam, "Delete it; its child teams move up"),
301 a("list_members", Op::ListTeamMembers, "Its people and their roles, child teams' with include_child_teams"),
302 a("set_member", Op::SetTeamMember, "Add a member of the workspace, or change their role"),
303 a("remove_member", Op::RemoveTeamMember, "Take someone out of it"),
304 a("list_child_teams", Op::ListChildTeams, "The teams nested under it"),
305 a("list_repos", Op::ListTeamRepos, "The repositories it has a role on"),
306 a("set_repo", Op::SetTeamRepo, "Give it a role on a repository"),
307 a("remove_repo", Op::RemoveTeamRepo, "Take its role on a repository away"),
308 a("set_review_assignment", Op::SetTeamReviewAssignment, "Whom it picks when asked to review"),
309 a("list_user_teams", Op::ListUserTeams, "The teams someone is in"),
310 ],
311 },
312 Tool {
313 name: "workspace",
314 title: "Workspaces",
315 description: "Workspaces own repositories (g1t.sh/{workspace}/{repo}): create, update or delete one, invite members, connect integrations and model providers, set rulesets that hold across its repositories, read and change its projects (what each is, where it runs, its links), and keep your own pinned projects at the top of its sidebar.",
316 default_action: None,
317 actions: &[
318 a("get", Op::GetWorkspace, "A workspace's details and settings"),
319 a("create", Op::CreateWorkspace, "Create a workspace"),
320 a("delete", Op::DeleteWorkspace, "Delete a workspace and everything in it (support can restore it for 30 days)"),
321 a("update", Op::UpdateWorkspace, "Change its name, description, base permission or who may create teams"),
322 a("list_invites", Op::ListWorkspaceInvites, "Its invites"),
323 a("invite_member", Op::InviteMember, "Invite an email address"),
324 a("revoke_invite", Op::RevokeWorkspaceInvite, "Revoke a pending invite"),
325 a("list_integrations", Op::ListIntegrations, "Model providers, alert sources, trackers"),
326 a("connect_integration", Op::ConnectIntegration, "Connect one"),
327 a("update_integration", Op::UpdateIntegration, "Change one: rotate its key, choose its AI Gateway models"),
328 a("disconnect_integration", Op::DisconnectIntegration, "Remove one"),
329 a("test_integration", Op::TestIntegration, "Check its credentials"),
330 a("get_model_routes", Op::GetModelRoutes, "Where each kind of work's model requests go"),
331 a("set_model_routes", Op::SetModelRoutes, "Replace them"),
332 a("list_projects", Op::ListProjects, "Its projects you can see: what each is, where it runs, its links"),
333 a("get_project", Op::GetProject, "One project"),
334 a("update_project", Op::UpdateProject, "Change a project's name, description, kind, where it runs or its links"),
335 a("list_pinned_projects", Op::ListPinnedProjects, "Your pinned projects in it, in your order"),
336 a("pin_project", Op::PinProject, "Pin a project, at a position or the end"),
337 a("unpin_project", Op::UnpinProject, "Unpin a project"),
338 a("reorder_pinned_projects", Op::ReorderPinnedProjects, "Put your pins in a new order"),
339 a("list_rulesets", Op::Rules(RulesOp::ListWorkspaceRulesets), "Its rulesets, which hold across its repositories"),
340 a("get_ruleset", Op::Rules(RulesOp::GetWorkspaceRuleset), "One of its rulesets"),
341 a("create_ruleset", Op::Rules(RulesOp::CreateWorkspaceRuleset), "Create a ruleset for some or all of its repositories"),
342 a("update_ruleset", Op::Rules(RulesOp::UpdateWorkspaceRuleset), "Change one of its rulesets"),
343 a("delete_ruleset", Op::Rules(RulesOp::DeleteWorkspaceRuleset), "Delete one of its rulesets"),
344 a("rule_evaluations", Op::Rules(RulesOp::ListWorkspaceRuleEvaluations), "How rules judged changes across its repositories"),
345 ],
346 },
347 Tool {
348 name: "billing",
349 title: "Billing",
350 description: "A workspace's billing: its usage by product, project and day, its budget (the monthly spend limit, alerts and whether usage pauses at it), its AI credit, its invoices, and its AI Gateway requests. Amounts are whole millionths of a dollar (`_micros`), or cents (`_cents`) where named. Members read it; changing the budget and buying credit are for owners, as people, and never for g1t's agents.",
351 default_action: Some("usage"),
352 actions: &[
353 a("usage", Op::GetUsage, "Usage over a range of days, by product, meter, project and day, and what paid for it"),
354 a("budget", Op::GetBudget, "The monthly spend limit, what was spent, alerts and whether usage pauses at the limit"),
355 a("set_budget", Op::SetBudget, "Change the spend limit, alerts, pausing or the alert webhook"),
356 a("ai_credit", Op::GetAiCredit, "AI credit left, its grants, auto-reload and how to buy more"),
357 a("buy_ai_credit", Op::BuyAiCredit, "A payment page to buy AI credit, for a person to open"),
358 a("invoices", Op::ListInvoices, "Every invoice, the itemised usage invoices, and the next one so far"),
359 a("billing_details", Op::GetBillingDetails, "Who invoices are made out to and the payment method on file"),
360 a("gateway_requests", Op::ListGatewayRequests, "Recent AI Gateway requests: model, tokens, cost, status and token"),
361 ],
362 },
363 Tool {
364 name: "security",
365 title: "Security",
366 description: "A repository's security: secret scanning alerts and push protection bypasses, custom secret patterns, code scanning alerts and SARIF uploads, vulnerability alerts, the dependency graph and its SBOM, dependency review, settings, and a workspace's overview. Fix an alert with g1t. Findings are shown to those who can change the code only. Give `repo` (owner/name), or `workspace` for lists across one.",
367 default_action: Some("secret_alerts"),
368 actions: &[
369 a("secret_alerts", Op::Security(SecurityOp::ListSecretAlerts), "Secret scanning alerts; by state, secret_type, validity, bypassed"),
370 a("secret_alert", Op::Security(SecurityOp::GetSecretAlert), "One secret alert, with where it was found and its bypass requests"),
371 a("update_secret_alert", Op::Security(SecurityOp::UpdateSecretAlert), "Dismiss a secret alert with a reason, or reopen it"),
372 a("secret_locations", Op::Security(SecurityOp::ListSecretLocations), "Every file, line and commit a secret is in"),
373 a("bypass", Op::Security(SecurityOp::BypassPushProtection), "Push past push protection with a reason, or ask to"),
374 a("check_validity", Op::Security(SecurityOp::CheckSecretValidity), "Ask a secret's issuer whether it still works"),
375 a("bypass_requests", Op::Security(SecurityOp::ListBypassRequests), "A workspace's push protection bypass requests"),
376 a("review_bypass", Op::Security(SecurityOp::ReviewBypassRequest), "Approve, deny or cancel a bypass request"),
377 a("patterns", Op::Security(SecurityOp::ListCustomPatterns), "Custom secret patterns of a repository or workspace"),
378 a("create_pattern", Op::Security(SecurityOp::CreateCustomPattern), "Create a custom secret pattern, as a draft or published"),
379 a("update_pattern", Op::Security(SecurityOp::UpdateCustomPattern), "Change, publish or unpublish a custom pattern"),
380 a("delete_pattern", Op::Security(SecurityOp::DeleteCustomPattern), "Delete a custom pattern"),
381 a("dry_run_pattern", Op::Security(SecurityOp::DryRunCustomPattern), "Run a pattern over the default branch without saving it"),
382 a("code_alerts", Op::Security(SecurityOp::ListCodeAlerts), "Code scanning alerts; by state, severity, tool, rule_id"),
383 a("code_alert", Op::Security(SecurityOp::GetCodeAlert), "One code scanning alert by number"),
384 a("update_code_alert", Op::Security(SecurityOp::UpdateCodeAlert), "Dismiss a code scanning alert with a reason, or reopen it"),
385 a("analyses", Op::Security(SecurityOp::ListAnalyses), "Code scanning analyses, newest first"),
386 a("upload_sarif", Op::Security(SecurityOp::UploadSarif), "Upload a SARIF file, gzipped and base64-encoded"),
387 a("sarif_upload", Op::Security(SecurityOp::GetSarifUpload), "Whether a SARIF upload was read, and its analyses"),
388 a("vulnerability_alerts", Op::Security(SecurityOp::ListVulnerabilityAlerts), "Vulnerable dependencies; by state, severity, ecosystem, package"),
389 a("vulnerability_alert", Op::Security(SecurityOp::GetVulnerabilityAlert), "One vulnerability alert"),
390 a("update_vulnerability_alert", Op::Security(SecurityOp::UpdateVulnerabilityAlert), "Dismiss a vulnerability alert with a reason, or reopen it"),
391 a("fix", Op::Security(SecurityOp::FixAlert), "Put g1t on an issue to fix an alert"),
392 a("dependency_graph", Op::Security(SecurityOp::GetDependencyGraph), "Every package the lockfiles resolve, direct or transitive"),
393 a("sbom", Op::Security(SecurityOp::GetSbom), "The dependency graph as an SPDX 2.3 document"),
394 a("compare_dependencies", Op::Security(SecurityOp::CompareDependencies), "What changes in dependencies between base...head"),
395 a("settings", Op::Security(SecurityOp::GetSettings), "A repository's security settings"),
396 a("update_settings", Op::Security(SecurityOp::UpdateSettings), "Change when checks fail and dependency review's policy"),
397 a("workspace_settings", Op::Security(SecurityOp::GetWorkspaceSettings), "A workspace's delegated bypass and validity checks"),
398 a("update_workspace_settings", Op::Security(SecurityOp::UpdateWorkspaceSettings), "Turn delegated bypass or validity checks on or off"),
399 a("overview", Op::Security(SecurityOp::GetOverview), "A workspace's alerts, trends and coverage"),
400 ],
401 },
402 Tool {
403 name: "notifications",
404 title: "Notifications",
405 description: "Your inbox: what needs you, and what you follow. One thread per issue, pull request, workflow or deployment, with why you were told (`reason`): an agent waiting on you, a review asked of you, an assignment, a mention, your work's checks, or what you subscribe to and watch. Mark threads read or done once handled, and choose what you hear of with subscribe, unsubscribe and watch. Your own: a personal token.",
406 default_action: Some("list"),
407 actions: &[
408 a("list", Op::ListNotifications, "Unread threads, latest first; all, a view, a reason, a repository"),
409 a("get", Op::GetNotificationThread, "One thread with its recent activity and your subscription"),
410 a("mark_read", Op::MarkThreadRead, "Mark a thread read, or unread"),
411 a("mark_all_read", Op::MarkNotificationsRead, "Mark everything read up to a time, or one repository's"),
412 a("done", Op::MarkThreadDone, "Mark a thread done; new activity brings it back"),
413 a("save", Op::SaveThread, "Save a thread, or unsave it"),
414 a("snooze", Op::SnoozeThread, "Snooze a thread until a time, or bring it back"),
415 a("subscription", Op::GetThreadSubscription, "Your subscription to an issue or pull request"),
416 a("subscribe", Op::SetThreadSubscription, "Subscribe to an issue or pull request, or ignore it"),
417 a("unsubscribe", Op::DeleteThreadSubscription, "Unsubscribe until you comment or are mentioned"),
418 a("watching", Op::GetRepoSubscription, "How you watch a repository"),
419 a("watch", Op::SetRepoSubscription, "Watch a repository: participating, all, ignore or custom"),
420 a("unwatch", Op::DeleteRepoSubscription, "Stop watching a repository"),
421 a("watched", Op::ListWatchedRepos, "Repositories you watch other than the default way"),
422 ],
423 },
424 Tool {
425 name: "account",
426 title: "Your account",
427 description: "Who this token acts as and its workspaces (`whoami`), your email addresses, your invites, and invitations to repositories waiting for you.",
428 default_action: Some("whoami"),
429 actions: &[
430 a("whoami", Op::Whoami, "Who the token acts as, and its workspaces"),
431 a("list_emails", Op::ListEmails, "Your addresses"),
432 a("add_email", Op::AddEmail, "Add an address"),
433 a("remove_email", Op::RemoveEmail, "Remove an address"),
434 a("update_email_settings", Op::UpdateEmailSettings, "Primary, backup and privacy"),
435 a("list_invites", Op::ListInvites, "Your invites to g1t"),
436 a("create_invite", Op::CreateInvite, "Make an invite"),
437 a("revoke_invite", Op::RevokeInvite, "Revoke one"),
438 a("list_repository_invitations", Op::ListMyRepoInvitations, "Invitations to repositories for you"),
439 a("accept_repository_invitation", Op::AcceptRepoInvitation, "Accept one"),
440 a("decline_repository_invitation", Op::DeclineRepoInvitation, "Decline one"),
441 ],
442 },
443];
444
445/// Operations that cannot be undone, or reach beyond g1t's own records:
446/// clients ask before running a tool that has any of them.
447fn destructive(op: Op) -> bool {
448 matches!(
449 op,
450 Op::Security(SecurityOp::DeleteCustomPattern | SecurityOp::BypassPushProtection)
451 | Op::Rules(RulesOp::DeleteRepoRuleset | RulesOp::DeleteWorkspaceRuleset)
452 | Op::DeleteWorkspace
453 | Op::UpdateWorkspace
454 | Op::DeleteRepo
455 | Op::PurgeRepo
456 | Op::TransferRepo
457 | Op::SetRepoVisibility
458 | Op::RemoveEmail
459 | Op::RemoveCollaborator
460 | Op::DisconnectIntegration
461 | Op::UpdateIntegration
462 | Op::DeleteWebhook
463 | Op::DeleteActionsSecret
464 | Op::DeleteActionsVariable
465 | Op::SetActionsSecret
466 | Op::SetActionsVariable
467 | Op::SetModelRoutes
468 | Op::SetBasePermission
469 | Op::DeleteTeam
470 | Op::RemoveTeamRepo
471 | Op::MergePullRequest
472 | Op::RemoveRunner
473 | Op::DeleteRunnerGroup
474 | Op::UpdateRunnerSettings
475 )
476}
477
478/// Whether an operation only reads.
479pub fn reads_only(op: Op) -> bool {
480 NO_SCOPE.contains(&op.name())
481 || scope_for(op.name()).is_some_and(|scope| scope.level() == Level::Read)
482}
483
484/// What decides which actions a caller sees.
485pub enum Gate<'a> {
486 /// No limit beyond the person's own role.
487 Everything,
488 /// A g1t agent's token: the operations its run lists.
489 Agent(&'a AgentScope),
490 /// An access token with scopes.
491 Token(&'a TokenAccess),
492}
493
494impl Gate<'_> {
495 pub fn allows(&self, op: Op) -> bool {
496 match self {
497 Gate::Everything => true,
498 Gate::Agent(scope) => op.allowed_by(scope) && !NEVER.contains(&op.name()),
499 Gate::Token(access) => {
500 if NO_SCOPE.contains(&op.name()) {
501 return true;
502 }
503 match scope_for(op.name()) {
504 Some(scope) => access.allows(scope),
505 None => access.scopes.is_none(),
506 }
507 }
508 }
509 }
510}
511
512impl Tool {
513 pub fn by_name(name: &str) -> Option<&'static Tool> {
514 TOOLS.iter().find(|tool| tool.name == name)
515 }
516
517 pub fn action(&self, name: &str) -> Option<&'static Action> {
518 // The tools are 'static; find through TOOLS to keep the lifetime.
519 TOOLS
520 .iter()
521 .find(|tool| tool.name == self.name)
522 .and_then(|tool| tool.actions.iter().find(|action| action.name == name))
523 }
524
525 pub fn visible(&self, gate: &Gate) -> Vec<&'static Action> {
526 TOOLS
527 .iter()
528 .find(|tool| tool.name == self.name)
529 .map(|tool| tool.actions.iter().filter(|action| gate.allows(action.op)).collect())
530 .unwrap_or_default()
531 }
532
533 /// The flat input schema of the actions given.
534 pub fn input_schema(&self, actions: &[&Action]) -> Value {
535 let mut properties = Map::new();
536 let lines: Vec<String> = actions
537 .iter()
538 .map(|action| {
539 let required: Vec<String> = action.op.required();
540 if required.is_empty() {
541 format!("{}: {}.", action.name, action.summary)
542 } else {
543 format!("{} ({}): {}.", action.name, required.join(", "), action.summary)
544 }
545 })
546 .collect();
547 let mut action_schema = json!({
548 "type": "string",
549 "enum": actions.iter().map(|action| action.name).collect::<Vec<_>>(),
550 "description": lines.join("\n"),
551 });
552 if let Some(default) = self.default_action.filter(|name| actions.iter().any(|action| action.name == *name)) {
553 action_schema["default"] = json!(default);
554 }
555 properties.insert("action".to_owned(), action_schema);
556 for action in actions {
557 for (name, schema) in action.op.properties() {
558 merge_property(&mut properties, name, schema);
559 }
560 }
561 let mut required = vec![];
562 if self.default_action.is_none() {
563 required.push("action");
564 }
565 let mut schema = json!({ "type": "object", "properties": properties });
566 if !required.is_empty() {
567 schema["required"] = json!(required);
568 }
569 schema
570 }
571
572 /// The input schema keyed by action: one `oneOf` branch per action,
573 /// each with its own fields and the ones it needs.
574 pub fn discriminated(&self, actions: &[&Action]) -> Value {
575 let branches: Vec<Value> = actions
576 .iter()
577 .map(|action| {
578 let mut properties = Map::new();
579 properties.insert("action".to_owned(), json!({ "const": action.name }));
580 properties.extend(action.op.properties());
581 let mut required = vec![Value::String("action".to_owned())];
582 // The default action may leave `action` out.
583 if self.default_action == Some(action.name) {
584 required.clear();
585 }
586 required.extend(action.op.required().into_iter().map(Value::String));
587 json!({
588 "title": action.name,
589 "description": action.summary,
590 "type": "object",
591 "properties": properties,
592 "required": required,
593 })
594 })
595 .collect();
596 json!({ "type": "object", "oneOf": branches })
597 }
598
599 /// MCP's hints about the actions given: whether the tool only reads,
600 /// whether it can destroy something, and whether calling it twice is
601 /// the same as once.
602 pub fn annotations(&self, actions: &[&Action]) -> Value {
603 let read_only = actions.iter().all(|action| reads_only(action.op));
604 json!({
605 "title": self.title,
606 "readOnlyHint": read_only,
607 "destructiveHint": !read_only && actions.iter().any(|action| destructive(action.op)),
608 "idempotentHint": read_only,
609 "openWorldHint": false,
610 })
611 }
612
613 /// The tool as `tools/list` gives it, for a caller behind `gate`, or
614 /// `None` when it may use none of its actions.
615 pub fn listed(&self, gate: &Gate) -> Option<Value> {
616 let actions = self.visible(gate);
617 if actions.is_empty() {
618 return None;
619 }
620 Some(json!({
621 "name": self.name,
622 "title": self.title,
623 "description": self.description,
624 "inputSchema": self.input_schema(&actions),
625 "annotations": self.annotations(&actions),
626 }))
627 }
628}
629
630/// Adds a property to a tool's flat schema. The first action to use a name
631/// describes it; a later one with other allowed values adds them.
632fn merge_property(properties: &mut Map<String, Value>, name: String, schema: Value) {
633 match properties.get_mut(&name) {
634 None => {
635 properties.insert(name, schema);
636 }
637 Some(existing) => {
638 if let (Some(Value::Array(had)), Some(Value::Array(more))) =
639 (existing.get("enum").cloned(), schema.get("enum"))
640 {
641 let mut merged = had;
642 for value in more {
643 if !merged.contains(value) {
644 merged.push(value.clone());
645 }
646 }
647 existing["enum"] = Value::Array(merged);
648 }
649 // Different kinds of value under one name: say less, accept both.
650 if existing.get("type") != schema.get("type")
651 && let Some(fields) = existing.as_object_mut()
652 {
653 fields.remove("type");
654 fields.remove("items");
655 }
656 }
657 }
658}
659
660/// What a call to a tool runs: the operation its action names, or why not.
661pub fn resolve(tool: &Tool, arguments: &Value) -> Result<Op, String> {
662 let names = || {
663 tool.actions
664 .iter()
665 .map(|action| action.name)
666 .collect::<Vec<_>>()
667 .join(", ")
668 };
669 let Some(name) = arguments["action"].as_str().or(tool.default_action) else {
670 return Err(format!("Give an action: one of {}.", names()));
671 };
672 let Some(action) = tool.action(name) else {
673 return Err(format!("{} has no action {name}. Its actions: {}.", tool.name, names()));
674 };
675 let missing: Vec<String> = action
676 .op
677 .required()
678 .into_iter()
679 .filter(|field| arguments.get(field).is_none_or(Value::is_null))
680 .collect();
681 if !missing.is_empty() {
682 return Err(format!("{}.{name} needs {}.", tool.name, missing.join(", ")));
683 }
684 Ok(action.op)
685}
686
687#[cfg(test)]
688mod tests {
689 use super::*;
690 use g1t_contracts::scopes::{Preset, Scope};
691
692 fn listed(gate: &Gate) -> Vec<Value> {
693 TOOLS.iter().filter_map(|tool| tool.listed(gate)).collect()
694 }
695
696 fn token(scopes: Option<Vec<Scope>>) -> TokenAccess {
697 TokenAccess {
698 token_id: "tok_1".to_owned(),
699 scopes: scopes.map(|scopes| scopes.iter().map(|scope| scope.as_str().to_owned()).collect()),
700 legacy: false,
701 name: None,
702 }
703 }
704
705 #[test]
706 fn every_operation_is_exactly_one_action_of_one_tool() {
707 for op in Op::ALL {
708 let count = TOOLS
709 .iter()
710 .flat_map(|tool| tool.actions.iter())
711 .filter(|action| action.op == op)
712 .count();
713 assert_eq!(count, 1, "{} is {count} actions", op.name());
714 }
715 for tool in TOOLS {
716 let mut names = std::collections::HashSet::new();
717 for action in tool.actions {
718 assert!(names.insert(action.name), "{}.{} twice", tool.name, action.name);
719 }
720 if let Some(default) = tool.default_action {
721 assert!(tool.action(default).is_some(), "{}", tool.name);
722 }
723 }
724 assert!(TOOLS.len() <= 17, "{} tools", TOOLS.len());
725 }
726
727 #[test]
728 fn every_operation_needs_exactly_one_scope_or_none() {
729 use g1t_contracts::scopes::OPERATIONS;
730 for op in Op::ALL {
731 let mapped = OPERATIONS.iter().filter(|(name, _)| *name == op.name()).count();
732 let free = NO_SCOPE.contains(&op.name());
733 assert_eq!(mapped + usize::from(free), 1, "{}", op.name());
734 }
735 for (name, _) in OPERATIONS {
736 assert!(Op::by_name(name).is_some(), "{name} is not an operation");
737 }
738 }
739
740 #[test]
741 fn each_tool_schema_is_valid_with_one_branch_per_action() {
742 for tool in TOOLS {
743 let actions: Vec<&Action> = tool.actions.iter().collect();
744 let flat = tool.input_schema(&actions);
745 assert_eq!(flat["type"], "object");
746 assert!(flat.get("oneOf").is_none(), "no oneOf at the top level");
747 let listed: Vec<&str> = flat["properties"]["action"]["enum"]
748 .as_array()
749 .unwrap()
750 .iter()
751 .map(|name| name.as_str().unwrap())
752 .collect();
753 assert_eq!(listed, tool.actions.iter().map(|action| action.name).collect::<Vec<_>>());
754 for action in tool.actions {
755 for field in action.op.required() {
756 assert!(flat["properties"].get(&field).is_some(), "{}.{}: {field}", tool.name, action.name);
757 }
758 }
759 let keyed = tool.discriminated(&actions);
760 let branches = keyed["oneOf"].as_array().unwrap();
761 assert_eq!(branches.len(), tool.actions.len());
762 for (branch, action) in branches.iter().zip(tool.actions) {
763 assert_eq!(branch["properties"]["action"]["const"], action.name);
764 for field in branch["required"].as_array().unwrap() {
765 assert!(branch["properties"].get(field.as_str().unwrap()).is_some(), "{}.{}: {field}", tool.name, action.name);
766 }
767 }
768 // A well-formed JSON Schema object throughout.
769 let text = serde_json::to_string(&flat).unwrap();
770 assert!(serde_json::from_str::<Value>(&text).is_ok());
771 }
772 }
773
774 #[test]
775 fn a_read_only_token_sees_read_actions_only() {
776 let access = token(Preset::ReadOnly.scopes());
777 let gate = Gate::Token(&access);
778 for tool in TOOLS {
779 for action in tool.visible(&gate) {
780 assert!(reads_only(action.op), "{}.{}", tool.name, action.name);
781 }
782 }
783 let tools = listed(&gate);
784 for tool in &tools {
785 assert_eq!(tool["annotations"]["readOnlyHint"], true, "{}", tool["name"]);
786 assert_eq!(tool["annotations"]["destructiveHint"], false);
787 }
788 let issue = tools.iter().find(|tool| tool["name"] == "issue").unwrap();
789 assert_eq!(issue["inputSchema"]["properties"]["action"]["enum"], json!(["list", "get", "labels"]));
790 // Nothing of the agent tool is a read.
791 assert!(!tools.iter().any(|tool| tool["name"] == "agent"));
792 }
793
794 #[test]
795 fn a_narrow_token_sees_only_its_tools() {
796 let access = token(Some(vec![Scope::IssuesWrite]));
797 let names: Vec<Value> = listed(&Gate::Token(&access)).into_iter().map(|tool| tool["name"].clone()).collect();
798 // Labels and milestones are the repository's, managed with issues:write.
799 assert_eq!(names, vec![json!("repository"), json!("issue"), json!("plan"), json!("account")]);
800 // Notifications are a resource of their own: reading them lists
801 // only what reads.
802 let reader = token(Some(vec![Scope::NotificationsRead]));
803 let tools = listed(&Gate::Token(&reader));
804 let notifications = tools.iter().find(|tool| tool["name"] == "notifications").unwrap();
805 assert_eq!(
806 notifications["inputSchema"]["properties"]["action"]["enum"],
807 json!(["list", "get", "subscription", "watching", "watched"])
808 );
809 assert_eq!(notifications["annotations"]["readOnlyHint"], true);
810 let full = token(None);
811 assert_eq!(listed(&Gate::Token(&full)).len(), TOOLS.len());
812 assert_eq!(listed(&Gate::Everything).len(), TOOLS.len());
813 }
814
815 #[test]
816 fn a_tool_that_can_destroy_says_so() {
817 let tools = listed(&Gate::Everything);
818 let repository = tools.iter().find(|tool| tool["name"] == "repository").unwrap();
819 assert_eq!(repository["annotations"]["destructiveHint"], true);
820 assert_eq!(repository["annotations"]["readOnlyHint"], false);
821 let memory = tools.iter().find(|tool| tool["name"] == "memory").unwrap();
822 assert_eq!(memory["annotations"]["destructiveHint"], false);
823 }
824
825 #[test]
826 fn calls_resolve_to_their_operation_or_say_what_is_missing() {
827 let issue = Tool::by_name("issue").unwrap();
828 assert_eq!(resolve(issue, &json!({ "action": "get", "repo": "a/b", "number": 1 })), Ok(Op::GetIssue));
829 assert_eq!(resolve(issue, &json!({ "action": "get", "repo": "a/b" })), Err("issue.get needs number.".to_owned()));
830 assert!(resolve(issue, &json!({})).unwrap_err().starts_with("Give an action"));
831 assert!(resolve(issue, &json!({ "action": "explode" })).unwrap_err().contains("no action explode"));
832 let search = Tool::by_name("search").unwrap();
833 assert_eq!(resolve(search, &json!({ "query": "x" })), Ok(Op::Search));
834 let account = Tool::by_name("account").unwrap();
835 assert_eq!(resolve(account, &json!({})), Ok(Op::Whoami));
836 }
837
838 #[test]
839 fn teams_are_one_tool_and_a_workspace_reader_sees_only_its_reads() {
840 let team = Tool::by_name("team").unwrap();
841 let names: Vec<&str> = team.actions.iter().map(|action| action.name).collect();
842 assert_eq!(
843 names,
844 [
845 "list",
846 "get",
847 "create",
848 "update",
849 "delete",
850 "list_members",
851 "set_member",
852 "remove_member",
853 "list_child_teams",
854 "list_repos",
855 "set_repo",
856 "remove_repo",
857 "set_review_assignment",
858 "list_user_teams",
859 ]
860 );
861 let reader = token(Some(vec![Scope::WorkspaceRead]));
862 let tools = listed(&Gate::Token(&reader));
863 let listed_team = tools.iter().find(|tool| tool["name"] == "team").unwrap();
864 assert_eq!(
865 listed_team["inputSchema"]["properties"]["action"]["enum"],
866 json!(["list", "get", "list_members", "list_child_teams", "list_repos", "list_user_teams"])
867 );
868 assert_eq!(listed_team["annotations"]["readOnlyHint"], true);
869 // A team's role on a repository is who has access.
870 let admin = token(Some(vec![Scope::WorkspaceAdmin]));
871 let tools = listed(&Gate::Token(&admin));
872 let listed_team = tools.iter().find(|tool| tool["name"] == "team").unwrap();
873 let actions = listed_team["inputSchema"]["properties"]["action"]["enum"].as_array().unwrap();
874 assert!(actions.contains(&json!("set_review_assignment")) && !actions.contains(&json!("set_repo")));
875 let access = token(Some(vec![Scope::AccessAdmin]));
876 let tools = listed(&Gate::Token(&access));
877 let listed_team = tools.iter().find(|tool| tool["name"] == "team").unwrap();
878 assert_eq!(listed_team["inputSchema"]["properties"]["action"]["enum"], json!(["set_repo", "remove_repo"]));
879 // Both kinds of role a schema names are offered.
880 let roles = &listed(&Gate::Everything).into_iter().find(|tool| tool["name"] == "team").unwrap()["inputSchema"]
881 ["properties"]["role"]["enum"];
882 for role in ["member", "maintainer", "read", "admin"] {
883 assert!(roles.as_array().unwrap().contains(&json!(role)), "{role}");
884 }
885 assert_eq!(
886 resolve(team, &json!({ "action": "set_repo", "workspace": "acme", "team": "backend", "repo": "rocket" })),
887 Err("team.set_repo needs role.".to_owned())
888 );
889 }
890
891 #[test]
892 fn reviewers_and_code_owners_are_actions_of_their_tools() {
893 let pull = Tool::by_name("pull_request").unwrap();
894 assert_eq!(
895 resolve(pull, &json!({ "action": "request_reviewers", "repo": "a/b", "number": 1, "team_reviewers": ["backend"] })),
896 Ok(Op::RequestReviewers)
897 );
898 assert_eq!(pull.action("remove_requested_reviewers").map(|action| action.op), Some(Op::RemoveRequestedReviewers));
899 let repository = Tool::by_name("repository").unwrap();
900 assert_eq!(resolve(repository, &json!({ "action": "codeowners", "repo": "a/b" })), Ok(Op::GetCodeownersErrors));
901 assert!(reads_only(Op::GetCodeownersErrors));
902 assert!(!reads_only(Op::RequestReviewers));
903 }
904
905 /// How much smaller `tools/list` is than one tool per operation. Run
906 /// with `--nocapture` to see the numbers.
907 #[test]
908 fn the_tool_list_is_much_smaller_than_one_tool_per_operation() {
909 let before: Vec<Value> = Op::ALL
910 .into_iter()
911 .map(|op| json!({ "name": op.name(), "description": op.description(), "inputSchema": op.input() }))
912 .collect();
913 let after = listed(&Gate::Everything);
914 let before_bytes = serde_json::to_string(&json!({ "tools": before })).unwrap().len();
915 let after_bytes = serde_json::to_string(&json!({ "tools": after })).unwrap().len();
916 let agent = token(Preset::Agent.scopes());
917 let agent_bytes = serde_json::to_string(&json!({ "tools": listed(&Gate::Token(&agent)) })).unwrap().len();
918 let read = token(Preset::ReadOnly.scopes());
919 let read_bytes = serde_json::to_string(&json!({ "tools": listed(&Gate::Token(&read)) })).unwrap().len();
920 println!(
921 "tools/list: before {} tools, {before_bytes} bytes (~{} tokens); after {} tools, {after_bytes} bytes (~{} tokens); agent preset {agent_bytes} bytes (~{} tokens); read only {read_bytes} bytes (~{} tokens)",
922 before.len(),
923 before_bytes / 4,
924 after.len(),
925 after_bytes / 4,
926 agent_bytes / 4,
927 read_bytes / 4,
928 );
929 assert!(after_bytes * 2 < before_bytes, "{after_bytes} vs {before_bytes}");
930 }
931}