| 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 | |
| 16 | use g1t_contracts::credentials::NEVER; |
| 17 | use g1t_contracts::identity::AgentScope; |
| 18 | use g1t_contracts::scopes::{Level, NO_SCOPE, TokenAccess, scope_for}; |
| 19 | use serde_json::{Map, Value, json}; |
| 20 | |
| 21 | use crate::about::AboutOp; |
| 22 | use crate::run_artifacts::ArtifactsOp; |
| 23 | use crate::archives::ArchiveOp; |
| 24 | use crate::deploy_keys::DeployKeysOp; |
| 25 | use crate::deployments::DeploymentsOp; |
| 26 | use crate::telemetry::TelemetryOp; |
| 27 | use crate::packages::PackagesOp; |
| 28 | use crate::folios::FoliosOp; |
| 29 | use crate::protection::ProtectionOp; |
| 30 | use crate::token_policy::TokenOp; |
| 31 | use crate::operations::Op; |
| 32 | use crate::checks::ChecksOp; |
| 33 | use crate::rules::RulesOp; |
| 34 | use crate::security::SecurityOp; |
| 35 | |
| 36 | pub struct Action { |
| 37 | pub name: &'static str, |
| 38 | pub op: Op, |
| 39 | /// One line, for the `action` field's description. |
| 40 | pub summary: &'static str, |
| 41 | } |
| 42 | |
| 43 | pub struct Tool { |
| 44 | pub name: &'static str, |
| 45 | pub title: &'static str, |
| 46 | /// What it is for, in a sentence or two. |
| 47 | pub description: &'static str, |
| 48 | pub actions: &'static [Action], |
| 49 | /// The action a call without one runs. |
| 50 | pub default_action: Option<&'static str>, |
| 51 | } |
| 52 | |
| 53 | const fn a(name: &'static str, op: Op, summary: &'static str) -> Action { |
| 54 | Action { name, op, summary } |
| 55 | } |
| 56 | |
| 57 | pub const TOOLS: &[Tool] = &[ |
| 58 | Tool { |
| 59 | name: "search", |
| 60 | title: "Search", |
| 61 | 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. `ticket` reads a Jira, Linear or Sentry item the work refers to.", |
| 62 | default_action: Some("code"), |
| 63 | actions: &[ |
| 64 | a("code", Op::Search, "Search all of g1t: repositories, code, issues, pull requests, people"), |
| 65 | a("ticket", Op::GetContext, "A Jira, Linear or Sentry item the work refers to, as it is now"), |
| 66 | ], |
| 67 | }, |
| 68 | Tool { |
| 69 | name: "repository", |
| 70 | title: "Repositories", |
| 71 | 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`.", |
| 72 | default_action: None, |
| 73 | actions: &[ |
| 74 | a("list", Op::ListRepos, "Repositories you can see"), |
| 75 | a("get", Op::GetRepo, "One repository"), |
| 76 | a("tarball", Op::Archives(ArchiveOp::DownloadTarball), "A 10-minute link to a branch, tag or commit as a .tar.gz"), |
| 77 | a("zipball", Op::Archives(ArchiveOp::DownloadZipball), "A 10-minute link to a branch, tag or commit as a .zip"), |
| 78 | a("create", Op::CreateRepo, "Create one, empty or copied from a public git URL"), |
| 79 | a("update", Op::UpdateRepo, "Change description, website, topics, default branch, protection"), |
| 80 | a("get_settings", Op::GetRepoSettings, "How pull requests merge, and the default branch's protection as its rules stack"), |
| 81 | a("update_settings", Op::UpdateRepoSettings, "Change how pull requests merge and the default branch protection ruleset"), |
| 82 | a("check_names", Op::ListCheckNames, "Check names reported lately, to require in a ruleset"), |
| 83 | a("list_rulesets", Op::Rules(RulesOp::ListRepoRulesets), "Its rulesets, and its workspace's that hold in it"), |
| 84 | a("get_ruleset", Op::Rules(RulesOp::GetRepoRuleset), "One ruleset"), |
| 85 | a("create_ruleset", Op::Rules(RulesOp::CreateRepoRuleset), "Create a ruleset for its branches or tags"), |
| 86 | a("update_ruleset", Op::Rules(RulesOp::UpdateRepoRuleset), "Change a ruleset"), |
| 87 | a("delete_ruleset", Op::Rules(RulesOp::DeleteRepoRuleset), "Delete a ruleset"), |
| 88 | a("branch_rules", Op::Rules(RulesOp::GetBranchRules), "Every rule that holds for a branch or tag, and where it comes from"), |
| 89 | a("rule_evaluations", Op::Rules(RulesOp::ListRuleEvaluations), "How its rules judged pushes and merges, with insights"), |
| 90 | a("codeowners", Op::GetCodeownersErrors, "Problems in its CODEOWNERS file, by line"), |
| 91 | a("list_labels", Op::ListLabels, "Labels, with colors and how many issues and pull requests carry each"), |
| 92 | a("create_label", Op::CreateLabel, "Create a label"), |
| 93 | a("update_label", Op::UpdateLabel, "Rename a label or change its color or description"), |
| 94 | a("delete_label", Op::DeleteLabel, "Delete a label, from everything that carries it"), |
| 95 | a("add_default_labels", Op::AddDefaultLabels, "Add the default labels it is missing"), |
| 96 | a("list_milestones", Op::ListMilestones, "Milestones, with progress and due dates"), |
| 97 | a("get_milestone", Op::GetMilestone, "One milestone with its issues and pull requests"), |
| 98 | a("create_milestone", Op::CreateMilestone, "Create a milestone"), |
| 99 | a("update_milestone", Op::UpdateMilestone, "Change a milestone's title, description, due date or state"), |
| 100 | a("delete_milestone", Op::DeleteMilestone, "Delete a milestone"), |
| 101 | a("list_events", Op::ListEvents, "Timeline: pushes, issues, pull requests, comments"), |
| 102 | a("languages", Op::About(AboutOp::GetLanguages), "Its languages by bytes, with colors and percentages"), |
| 103 | a("contributors", Op::About(AboutOp::ListContributors), "Who made it: commits per person, agent and author, by week"), |
| 104 | a("license", Op::About(AboutOp::GetLicense), "The license its LICENSE file holds"), |
| 105 | a("stargazers", Op::About(AboutOp::ListStargazers), "Who starred it"), |
| 106 | a("starred", Op::About(AboutOp::CheckStarred), "Whether you starred it, and how many have"), |
| 107 | a("star", Op::About(AboutOp::Star), "Star it"), |
| 108 | a("unstar", Op::About(AboutOp::Unstar), "Take your star back"), |
| 109 | a("list_starred", Op::About(AboutOp::ListStarred), "Repositories you starred"), |
| 110 | a("list_releases", Op::About(AboutOp::ListReleases), "Releases, newest first"), |
| 111 | a("latest_release", Op::About(AboutOp::GetLatestRelease), "The latest release"), |
| 112 | a("get_release", Op::About(AboutOp::GetRelease), "One release by id"), |
| 113 | a("get_release_by_tag", Op::About(AboutOp::GetReleaseByTag), "The release of a tag"), |
| 114 | a("create_release", Op::About(AboutOp::CreateRelease), "Publish a release of a tag, making the tag if needed"), |
| 115 | a("update_release", Op::About(AboutOp::UpdateRelease), "Change a release's title, notes, draft or prerelease"), |
| 116 | a("delete_release", Op::About(AboutOp::DeleteRelease), "Delete a release; its tag stays"), |
| 117 | a("rename_branch", Op::RenameBranch, "Rename a branch"), |
| 118 | a("create_branch", Op::CreateBranch, "Make a branch at a branch, tag or commit"), |
| 119 | a("delete_branch", Op::DeleteBranch, "Delete a branch; make it again at its commit to restore it"), |
| 120 | a("rename", Op::RenameRepo, "Rename it; old addresses redirect"), |
| 121 | a("transfer", Op::TransferRepo, "Move it to another workspace you own"), |
| 122 | a("archive", Op::ArchiveRepo, "Make it read-only"), |
| 123 | a("unarchive", Op::UnarchiveRepo, "Make it writable again"), |
| 124 | a("set_visibility", Op::SetRepoVisibility, "Make it public or private"), |
| 125 | a("delete", Op::DeleteRepo, "Delete it; restorable for 30 days"), |
| 126 | a("list_deleted", Op::ListDeletedRepos, "A workspace's deleted repositories"), |
| 127 | a("restore", Op::RestoreRepo, "Restore a deleted one"), |
| 128 | a("purge", Op::PurgeRepo, "Remove a deleted one for good"), |
| 129 | a("security_alerts", Op::ListSecurityAlerts, "Secret and dependency alerts, filtered by state"), |
| 130 | a("dismiss_alert", Op::DismissSecurityAlert, "Dismiss an alert with a reason"), |
| 131 | a("reopen_alert", Op::ReopenSecurityAlert, "Reopen a dismissed alert"), |
| 132 | ], |
| 133 | }, |
| 134 | Tool { |
| 135 | name: "issue", |
| 136 | title: "Issues", |
| 137 | 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.", |
| 138 | default_action: None, |
| 139 | actions: &[ |
| 140 | a("list", Op::ListIssues, "Issues on a repository, newest first"), |
| 141 | a("get", Op::GetIssue, "One issue with comments and its pull requests"), |
| 142 | a("create", Op::CreateIssue, "Open an issue"), |
| 143 | a("update", Op::UpdateIssue, "Change title, body, labels, milestone or assignees"), |
| 144 | a("labels", Op::ListIssueLabels, "The labels an issue or pull request carries"), |
| 145 | a("add_labels", Op::AddIssueLabels, "Add labels to an issue or pull request"), |
| 146 | a("set_labels", Op::SetIssueLabels, "Replace the labels of an issue or pull request"), |
| 147 | a("remove_labels", Op::RemoveIssueLabels, "Take labels off an issue or pull request"), |
| 148 | a("close", Op::CloseIssue, "Close it without a pull request"), |
| 149 | a("reopen", Op::ReopenIssue, "Reopen it"), |
| 150 | a("comment", Op::AddComment, "Comment on an issue or pull request; path and line for one line of a change"), |
| 151 | a("edit_comment", Op::EditComment, "Change a comment's text: your own, or any with the Maintain role"), |
| 152 | a("delete_comment", Op::DeleteComment, "Delete a comment: your own, or any with the Maintain role"), |
| 153 | a("import", Op::ImportIssue, "Open an issue from a Jira, Linear or Sentry item"), |
| 154 | ], |
| 155 | }, |
| 156 | Tool { |
| 157 | name: "pull_request", |
| 158 | title: "Pull requests", |
| 159 | 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.", |
| 160 | default_action: None, |
| 161 | actions: &[ |
| 162 | a("list", Op::ListPullRequests, "Pull requests on a repository, newest first"), |
| 163 | a("get", Op::GetPullRequest, "Status, checks and required checks, reviews, overlaps, whether it is behind"), |
| 164 | a("changes", Op::GetPullRequestChanges, "Files and line-by-line diff"), |
| 165 | a("create", Op::CreatePullRequest, "Start a draft with its own fork to push to, or open one from a pushed branch"), |
| 166 | a("update", Op::UpdatePullRequest, "Change its base branch, labels, milestone, assignees or reviewers"), |
| 167 | a("record_session", Op::RecordSession, "Append prompt, reasoning and tool entries to its session"), |
| 168 | a("read_session", Op::ReadSession, "Its recorded session"), |
| 169 | a("ready", Op::MarkPullRequestReady, "Mark a draft ready, with a summary"), |
| 170 | a("draft", Op::ConvertPullRequestToDraft, "Turn it back into a draft"), |
| 171 | a("request_reviewers", Op::RequestReviewers, "Ask people or teams to review it"), |
| 172 | a("remove_requested_reviewers", Op::RemoveRequestedReviewers, "Stop asking people or teams to review it"), |
| 173 | a("review", Op::ReviewPullRequest, "Approve or request changes"), |
| 174 | a("close", Op::ClosePullRequest, "Close without merging"), |
| 175 | a("reopen", Op::ReopenPullRequest, "Reopen a closed one"), |
| 176 | a("merge", Op::MergePullRequest, "Land it, or join the merge queue"), |
| 177 | a("merge_queue", Op::GetMergeQueue, "The repository's merge queue"), |
| 178 | ], |
| 179 | }, |
| 180 | Tool { |
| 181 | name: "memory", |
| 182 | title: "Memory", |
| 183 | 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.", |
| 184 | default_action: None, |
| 185 | actions: &[ |
| 186 | a("recall", Op::Recall, "Search memory, or list it all"), |
| 187 | a("remember", Op::Remember, "Save one fact"), |
| 188 | ], |
| 189 | }, |
| 190 | Tool { |
| 191 | name: "workflow", |
| 192 | title: "Workflows", |
| 193 | description: "GitHub Actions workflows from .g1t/workflows: their runs, jobs and logs, and running, cancelling or rerunning them. Runs' artifacts: listing, a download link, deleting, and how long they are kept. 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; environments' protection rules, approving or rejecting the jobs they hold, approving a pull request's run from outside, the token's default permissions, repository dispatch, and the workflows a workspace runs in its repositories without a file in them. 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`), and their groups.", |
| 194 | default_action: None, |
| 195 | actions: &[ |
| 196 | a("list", Op::ListWorkflows, "Workflows on the default branch"), |
| 197 | a("get", Op::GetWorkflow, "One workflow by id, file or name, with its file on a branch or tag"), |
| 198 | a("list_runs", Op::ListWorkflowRuns, "Runs, newest first"), |
| 199 | a("get_run", Op::GetWorkflowRun, "One run with its jobs and steps; an earlier attempt with attempt"), |
| 200 | a("job_logs", Op::GetJobLogs, "A job's log after a sequence number"), |
| 201 | a("dispatch", Op::DispatchWorkflow, "Run a workflow_dispatch workflow"), |
| 202 | a("cancel", Op::CancelWorkflowRun, "Cancel a run, letting its jobs clean up; force stops them outright"), |
| 203 | a("rerun", Op::RerunWorkflowRun, "Run a finished run again: all, failed_only, or one job; debug for debug logging"), |
| 204 | a("update", Op::UpdateWorkflow, "Turn a workflow on or off"), |
| 205 | a("list_artifacts", Op::Artifacts(ArtifactsOp::ListArtifacts), "A repository's artifacts, newest first; or a run's with run_artifacts"), |
| 206 | a("run_artifacts", Op::Artifacts(ArtifactsOp::ListRunArtifacts), "One run's artifacts"), |
| 207 | a("get_artifact", Op::Artifacts(ArtifactsOp::GetArtifact), "One artifact: size, digest, expiry, run"), |
| 208 | a("download_artifact", Op::Artifacts(ArtifactsOp::DownloadArtifact), "A 10-minute link to an artifact's zip"), |
| 209 | a("delete_artifact", Op::Artifacts(ArtifactsOp::DeleteArtifact), "Delete an artifact before it expires"), |
| 210 | a("artifact_retention", Op::Artifacts(ArtifactsOp::GetArtifactRetention), "Days the repository keeps artifacts"), |
| 211 | a("set_artifact_retention", Op::Artifacts(ArtifactsOp::SetArtifactRetention), "Change the days the repository keeps artifacts"), |
| 212 | a("combined_status", Op::Checks(ChecksOp::GetCombinedStatus), "A commit's statuses and the state they add up to"), |
| 213 | a("list_statuses", Op::Checks(ChecksOp::ListCommitStatuses), "A commit's statuses, newest first"), |
| 214 | a("set_status", Op::Checks(ChecksOp::CreateCommitStatus), "Set a status on a commit"), |
| 215 | a("list_check_runs", Op::Checks(ChecksOp::ListCheckRunsForRef), "A commit's check runs, g1t Actions jobs included"), |
| 216 | a("get_check_run", Op::Checks(ChecksOp::GetCheckRun), "One check run with its report"), |
| 217 | a("check_run_annotations", Op::Checks(ChecksOp::ListCheckRunAnnotations), "What a check run says about lines of files"), |
| 218 | a("create_check_run", Op::Checks(ChecksOp::CreateCheckRun), "Report a check run on a commit"), |
| 219 | a("update_check_run", Op::Checks(ChecksOp::UpdateCheckRun), "Move a check run on, complete it, add annotations"), |
| 220 | a("rerequest_check_run", Op::Checks(ChecksOp::RerequestCheckRun), "Ask for a check run to run again"), |
| 221 | a("list_check_suites", Op::Checks(ChecksOp::ListCheckSuitesForRef), "A commit's check suites, one per reporter or workflow run"), |
| 222 | a("get_check_suite", Op::Checks(ChecksOp::GetCheckSuite), "One check suite"), |
| 223 | a("rerequest_check_suite", Op::Checks(ChecksOp::RerequestCheckSuite), "Ask for a check suite to run again"), |
| 224 | a("list_deployments", Op::Deployments(DeploymentsOp::ListDeployments), "Deployments wherever they run, newest first, filtered"), |
| 225 | a("get_deployment", Op::Deployments(DeploymentsOp::GetDeployment), "One deployment with every status it has had"), |
| 226 | a("create_deployment", Op::Deployments(DeploymentsOp::CreateDeployment), "Report a deployment of a ref to an environment"), |
| 227 | a("deployment_statuses", Op::Deployments(DeploymentsOp::ListDeploymentStatuses), "A deployment's statuses, newest first"), |
| 228 | a("create_deployment_status", Op::Deployments(DeploymentsOp::CreateDeploymentStatus), "Report where a deployment is: in_progress, success, failure"), |
| 229 | a("list_environments", Op::Deployments(DeploymentsOp::ListEnvironments), "Environments with their current and latest deployments"), |
| 230 | a("get_environment", Op::Deployments(DeploymentsOp::GetEnvironment), "One environment by name, with its protection rules"), |
| 231 | a("start_deployment_build", Op::Deployments(DeploymentsOp::StartDeploymentBuild), "From a workflow job: open a g1t.page build it runs itself"), |
| 232 | a("update_environment", Op::Protection(ProtectionOp::UpdateEnvironment), "Set an environment's reviewers, wait timer and branches"), |
| 233 | a("delete_environment", Op::Protection(ProtectionOp::DeleteEnvironment), "Remove an environment's protection rules"), |
| 234 | a("pending_deployments", Op::Protection(ProtectionOp::GetPendingDeployments), "The environments holding a run's jobs"), |
| 235 | a("review_deployments", Op::Protection(ProtectionOp::ReviewPendingDeployments), "Approve or reject a run's jobs for its environments"), |
| 236 | a("approve_run", Op::Protection(ProtectionOp::ApproveWorkflowRun), "Let a run of a pull request from outside start"), |
| 237 | a("get_permissions", Op::Protection(ProtectionOp::GetWorkflowPermissions), "What a job's token gets without `permissions:`"), |
| 238 | a("set_permissions", Op::Protection(ProtectionOp::SetWorkflowPermissions), "Set it: read or write"), |
| 239 | a("get_approval_policy", Op::Protection(ProtectionOp::GetForkPrApproval), "Which pull requests' runs wait for approval"), |
| 240 | a("set_approval_policy", Op::Protection(ProtectionOp::SetForkPrApproval), "Set which pull requests' runs wait for approval"), |
| 241 | a("get_access", Op::Protection(ProtectionOp::GetActionsAccess), "Which repositories may use this one's actions and workflows"), |
| 242 | a("set_access", Op::Protection(ProtectionOp::SetActionsAccess), "Let the workspace's private repositories use them, or not"), |
| 243 | a("repository_dispatch", Op::Protection(ProtectionOp::CreateRepositoryDispatch), "Start repository_dispatch workflows with an event"), |
| 244 | a("get_workspace_permissions", Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions), "A workspace's default and maximum token permissions"), |
| 245 | a("set_workspace_permissions", Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions), "Set them, and whether jobs may open pull requests"), |
| 246 | a("list_managed_workflows", Op::Protection(ProtectionOp::ListWorkspaceManagedWorkflows), "The workflows a workspace runs in its repositories"), |
| 247 | a("add_managed_workflow", Op::Protection(ProtectionOp::CreateWorkspaceManagedWorkflow), "Run a workflow in the workspace's repositories, required or default"), |
| 248 | a("update_managed_workflow", Op::Protection(ProtectionOp::UpdateWorkspaceManagedWorkflow), "Change one's repositories or mode, or copy its source again"), |
| 249 | a("remove_managed_workflow", Op::Protection(ProtectionOp::DeleteWorkspaceManagedWorkflow), "Take one out of the workspace's repositories"), |
| 250 | a("list_runners", Op::ListRunners, "Self-hosted runners, with status, labels and what each is doing"), |
| 251 | a("create_runner_token", Op::CreateRunnerRegistrationToken, "A one-hour token for g1t-runner register"), |
| 252 | a("remove_runner", Op::RemoveRunner, "Remove a self-hosted runner"), |
| 253 | a("list_runner_groups", Op::ListRunnerGroups, "A workspace's runner groups"), |
| 254 | a("create_runner_group", Op::CreateRunnerGroup, "Make a group, for some repositories"), |
| 255 | a("update_runner_group", Op::UpdateRunnerGroup, "Rename a group or change its repositories"), |
| 256 | a("delete_runner_group", Op::DeleteRunnerGroup, "Delete a group; its runners join the default"), |
| 257 | a("get_runner_settings", Op::GetRunnerSettings, "Where checks and the merge queue run; whether forks may use runners"), |
| 258 | a("update_runner_settings", Op::UpdateRunnerSettings, "Change them"), |
| 259 | ], |
| 260 | }, |
| 261 | Tool { |
| 262 | name: "observability", |
| 263 | title: "Observability", |
| 264 | description: "What a project's running software did in production, to debug it: its requests, logs, traces, grouped errors and metrics, from its apps on g1t.page and from OpenTelemetry sent from anywhere. Name the project by workspace and project slug. Start with overview (error rate, latency, the routes and the deployment a regression began with) or errors, then follow a request or trace_id to its logs and spans. Times are RFC 3339 or Unix milliseconds; the last 24 hours unless you say. Needs a role of your own on the project's repository; resolving errors, Triage.", |
| 265 | default_action: None, |
| 266 | actions: &[ |
| 267 | a("overview", Op::Telemetry(TelemetryOp::GetOverview), "Requests, errors, latency and CPU over a period, by route, deployment, service and region, against the period before"), |
| 268 | a("requests", Op::Telemetry(TelemetryOp::ListRequests), "Requests answered, newest first: q, status (5xx, 404), errors_only, route, min_duration_ms"), |
| 269 | a("request", Op::Telemetry(TelemetryOp::GetRequest), "One request with every log line it wrote"), |
| 270 | a("logs", Op::Telemetry(TelemetryOp::ListLogs), "Search a project's logs: words or a phrase in q, level (error,warn), trace_id, request_id"), |
| 271 | a("traces", Op::Telemetry(TelemetryOp::ListTraces), "Traces, newest first: q, errors_only, min_duration_ms"), |
| 272 | a("trace", Op::Telemetry(TelemetryOp::GetTrace), "One trace: every span, with its timing, status and attributes, and its logs"), |
| 273 | a("errors", Op::Telemetry(TelemetryOp::ListErrors), "Errors grouped by exception, most recent first, with the deployment that brought each in"), |
| 274 | a("update_error", Op::Telemetry(TelemetryOp::UpdateError), "Resolve, ignore or reopen an error group, or link the issue made for it"), |
| 275 | a("metrics", Op::Telemetry(TelemetryOp::ListMetrics), "The metrics the project's software sends"), |
| 276 | a("metric", Op::Telemetry(TelemetryOp::GetMetric), "One metric over time: aggregate (avg, sum, p95), group_by an attribute"), |
| 277 | ], |
| 278 | }, |
| 279 | Tool { |
| 280 | name: "package", |
| 281 | title: "Packages", |
| 282 | description: "A workspace's packages in every registry (container images, npm, Cargo, Maven, NuGet, RubyGems, Composer): their versions and downloads, deleting and restoring them within 30 days, their visibility and repository, who has a role on them, and which repositories' workflows may use them (Manage Actions access). Name one by workspace, package_type and package_name.", |
| 283 | default_action: None, |
| 284 | actions: &[ |
| 285 | a("list", Op::Packages(PackagesOp::ListPackages), "A workspace's packages; state deleted for restorable ones"), |
| 286 | a("get", Op::Packages(PackagesOp::GetPackage), "One package: address, visibility, repository, downloads"), |
| 287 | a("versions", Op::Packages(PackagesOp::ListVersions), "Its versions with tags and downloads; state deleted too"), |
| 288 | a("get_version", Op::Packages(PackagesOp::GetVersion), "One version by id, version, digest or tag"), |
| 289 | a("update", Op::Packages(PackagesOp::UpdatePackage), "Set visibility, or inherit_access for a linked one"), |
| 290 | a("link", Op::Packages(PackagesOp::LinkPackage), "Link it to a repository of its workspace"), |
| 291 | a("unlink", Op::Packages(PackagesOp::UnlinkPackage), "Unlink it: the workspace's, private"), |
| 292 | a("access", Op::Packages(PackagesOp::ListAccess), "People and teams with a role on it"), |
| 293 | a("set_access", Op::Packages(PackagesOp::SetAccess), "Give a person or team read, write or admin"), |
| 294 | a("remove_access", Op::Packages(PackagesOp::RemoveAccess), "Take a person's or team's role away"), |
| 295 | a("actions_access", Op::Packages(PackagesOp::ListActionsAccess), "Repositories whose workflows may use it"), |
| 296 | a("set_actions_access", Op::Packages(PackagesOp::SetActionsAccess), "Let a repository's workflows read or write it"), |
| 297 | a("remove_actions_access", Op::Packages(PackagesOp::RemoveActionsAccess), "Stop a repository's workflows using it"), |
| 298 | a("delete", Op::Packages(PackagesOp::DeletePackage), "Delete it; restorable for 30 days"), |
| 299 | a("restore", Op::Packages(PackagesOp::RestorePackage), "Restore a deleted package"), |
| 300 | a("delete_version", Op::Packages(PackagesOp::DeleteVersion), "Delete a version; restorable for 30 days"), |
| 301 | a("restore_version", Op::Packages(PackagesOp::RestoreVersion), "Restore a deleted version"), |
| 302 | ], |
| 303 | }, |
| 304 | Tool { |
| 305 | name: "secret", |
| 306 | title: "Secrets and variables", |
| 307 | description: "A repository's or workspace's secrets and variables, read by workflows and deployments. Secret values are never returned.", |
| 308 | default_action: None, |
| 309 | actions: &[ |
| 310 | a("list_secrets", Op::ListActionsSecrets, "Secrets, without values"), |
| 311 | a("set_secret", Op::SetActionsSecret, "Add or change a secret"), |
| 312 | a("delete_secret", Op::DeleteActionsSecret, "Remove a secret"), |
| 313 | a("list_variables", Op::ListActionsVariables, "Variables, with values"), |
| 314 | a("set_variable", Op::SetActionsVariable, "Add or change a variable"), |
| 315 | a("delete_variable", Op::DeleteActionsVariable, "Remove a variable"), |
| 316 | ], |
| 317 | }, |
| 318 | Tool { |
| 319 | name: "webhook", |
| 320 | title: "Webhooks", |
| 321 | description: "HTTPS addresses sent signed events as they happen, for a repository or a whole workspace.", |
| 322 | default_action: None, |
| 323 | actions: &[ |
| 324 | a("list", Op::ListWebhooks, "Webhooks, without secrets"), |
| 325 | a("create", Op::CreateWebhook, "Register one; a ping is sent"), |
| 326 | a("update", Op::UpdateWebhook, "Change address, events or active"), |
| 327 | a("delete", Op::DeleteWebhook, "Remove one"), |
| 328 | a("ping", Op::PingWebhook, "Send a ping"), |
| 329 | a("list_deliveries", Op::ListWebhookDeliveries, "Latest deliveries"), |
| 330 | a("redeliver", Op::RedeliverWebhook, "Send a delivery again"), |
| 331 | ], |
| 332 | }, |
| 333 | Tool { |
| 334 | name: "access", |
| 335 | title: "Who has access", |
| 336 | description: "Who has access to a repository and with which role (read, triage, write, maintain, admin), outside collaborators, a workspace's base permission, and a repository's deploy keys.", |
| 337 | default_action: None, |
| 338 | actions: &[ |
| 339 | a("list_collaborators", Op::ListCollaborators, "Everyone with a role, and pending invitations"), |
| 340 | a("get_permission", Op::GetCollaboratorPermission, "One person's role and capabilities"), |
| 341 | a("add_collaborator", Op::AddCollaborator, "Give someone a role, by username or email"), |
| 342 | a("update_collaborator", Op::UpdateCollaborator, "Change a direct role"), |
| 343 | a("remove_collaborator", Op::RemoveCollaborator, "Take away a direct role"), |
| 344 | a("list_invitations", Op::ListRepoInvitations, "Pending invitations to a repository"), |
| 345 | a("revoke_invitation", Op::RevokeRepoInvitation, "Withdraw one"), |
| 346 | a("set_base_permission", Op::SetBasePermission, "What every member gets on each repository"), |
| 347 | a("list_outside_collaborators", Op::ListOutsideCollaborators, "People with roles who are not members"), |
| 348 | a("list_deploy_keys", Op::DeployKeys(DeployKeysOp::ListDeployKeys), "SSH keys that reach this one repository"), |
| 349 | a("get_deploy_key", Op::DeployKeys(DeployKeysOp::GetDeployKey), "One deploy key, by id"), |
| 350 | a("add_deploy_key", Op::DeployKeys(DeployKeysOp::CreateDeployKey), "Add one; read-only unless read_only is false"), |
| 351 | a("remove_deploy_key", Op::DeployKeys(DeployKeysOp::DeleteDeployKey), "Delete one"), |
| 352 | ], |
| 353 | }, |
| 354 | Tool { |
| 355 | name: "team", |
| 356 | title: "Teams", |
| 357 | 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.", |
| 358 | default_action: None, |
| 359 | actions: &[ |
| 360 | a("list", Op::ListTeams, "A workspace's teams you can see"), |
| 361 | a("get", Op::GetTeam, "One team"), |
| 362 | a("create", Op::CreateTeam, "Create a team; you become its maintainer"), |
| 363 | a("update", Op::UpdateTeam, "Change its name, slug, description, visibility, parent or notifications"), |
| 364 | a("delete", Op::DeleteTeam, "Delete it; its child teams move up"), |
| 365 | a("list_members", Op::ListTeamMembers, "Its people and their roles, child teams' with include_child_teams"), |
| 366 | a("set_member", Op::SetTeamMember, "Add a member of the workspace, or change their role"), |
| 367 | a("remove_member", Op::RemoveTeamMember, "Take someone out of it"), |
| 368 | a("list_child_teams", Op::ListChildTeams, "The teams nested under it"), |
| 369 | a("list_repos", Op::ListTeamRepos, "The repositories it has a role on"), |
| 370 | a("set_repo", Op::SetTeamRepo, "Give it a role on a repository"), |
| 371 | a("remove_repo", Op::RemoveTeamRepo, "Take its role on a repository away"), |
| 372 | a("set_review_assignment", Op::SetTeamReviewAssignment, "Whom it picks when asked to review"), |
| 373 | a("list_user_teams", Op::ListUserTeams, "The teams someone is in"), |
| 374 | ], |
| 375 | }, |
| 376 | Tool { |
| 377 | name: "workspace", |
| 378 | title: "Workspaces", |
| 379 | description: "Workspaces own repositories (g1t.sh/{workspace}/{repo}): create, update or delete one, invite members, connect integrations, 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.", |
| 380 | default_action: None, |
| 381 | actions: &[ |
| 382 | a("get", Op::GetWorkspace, "A workspace's details and settings"), |
| 383 | a("create", Op::CreateWorkspace, "Create a workspace"), |
| 384 | a("delete", Op::DeleteWorkspace, "Delete a workspace and everything in it (support can restore it for 30 days)"), |
| 385 | a("update", Op::UpdateWorkspace, "Change its name, description, base permission, who may create teams, member privileges or the two-factor requirement"), |
| 386 | a("list_members", Op::ListMembers, "Its members, owners first, with their roles"), |
| 387 | a("update_member", Op::UpdateMember, "Make someone an owner or a member, billing manager or security manager"), |
| 388 | a("remove_member", Op::RemoveMember, "Remove someone from it"), |
| 389 | a("transfer_ownership", Op::TransferOwnership, "Hand it to another member: they become an owner, you a member"), |
| 390 | a("leave", Op::LeaveWorkspace, "Leave it yourself"), |
| 391 | a("list_invites", Op::ListWorkspaceInvites, "Its invites"), |
| 392 | a("invite_member", Op::InviteMember, "Invite someone by username or email address"), |
| 393 | a("revoke_invite", Op::RevokeWorkspaceInvite, "Revoke a pending invite"), |
| 394 | a("list_integrations", Op::ListIntegrations, "AI providers, alert sources and issue trackers"), |
| 395 | a("connect_integration", Op::ConnectIntegration, "Connect one"), |
| 396 | a("update_integration", Op::UpdateIntegration, "Change one: rotate its key or its settings"), |
| 397 | a("disconnect_integration", Op::DisconnectIntegration, "Remove one"), |
| 398 | a("test_integration", Op::TestIntegration, "Check its credentials"), |
| 399 | a("list_projects", Op::ListProjects, "Its projects you can see: what each is, where it runs, its links"), |
| 400 | a("get_project", Op::GetProject, "One project"), |
| 401 | a("update_project", Op::UpdateProject, "Change a project's name, description, kind, where it runs or its links"), |
| 402 | a("list_pinned_projects", Op::ListPinnedProjects, "Your pinned projects in it, in your order"), |
| 403 | a("pin_project", Op::PinProject, "Pin a project, at a position or the end"), |
| 404 | a("unpin_project", Op::UnpinProject, "Unpin a project"), |
| 405 | a("reorder_pinned_projects", Op::ReorderPinnedProjects, "Put your pins in a new order"), |
| 406 | a("list_rulesets", Op::Rules(RulesOp::ListWorkspaceRulesets), "Its rulesets, which hold across its repositories"), |
| 407 | a("get_ruleset", Op::Rules(RulesOp::GetWorkspaceRuleset), "One of its rulesets"), |
| 408 | a("create_ruleset", Op::Rules(RulesOp::CreateWorkspaceRuleset), "Create a ruleset for some or all of its repositories"), |
| 409 | a("update_ruleset", Op::Rules(RulesOp::UpdateWorkspaceRuleset), "Change one of its rulesets"), |
| 410 | a("delete_ruleset", Op::Rules(RulesOp::DeleteWorkspaceRuleset), "Delete one of its rulesets"), |
| 411 | a("rule_evaluations", Op::Rules(RulesOp::ListWorkspaceRuleEvaluations), "How rules judged changes across its repositories"), |
| 412 | a("get_token_policy", Op::Tokens(TokenOp::GetTokenPolicy), "Its rules for personal access tokens"), |
| 413 | a("set_token_policy", Op::Tokens(TokenOp::SetTokenPolicy), "Change them: which tokens reach it, approval, lifetime"), |
| 414 | a("list_member_tokens", Op::Tokens(TokenOp::ListMemberTokens), "Members' personal access tokens that reach it"), |
| 415 | a("list_token_requests", Op::Tokens(TokenOp::ListTokenRequests), "Tokens waiting for approval"), |
| 416 | a("review_token_request", Op::Tokens(TokenOp::ReviewTokenRequest), "Approve or deny one"), |
| 417 | a("revoke_member_token", Op::Tokens(TokenOp::RevokeMemberToken), "Revoke a member's token in it"), |
| 418 | ], |
| 419 | }, |
| 420 | Tool { |
| 421 | name: "billing", |
| 422 | title: "Billing", |
| 423 | 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) and its invoices. Amounts are whole millionths of a dollar (`_micros`), or cents (`_cents`) where named. Members read it; changing the budget is for owners, as people, and never for a run's token.", |
| 424 | default_action: Some("usage"), |
| 425 | actions: &[ |
| 426 | a("usage", Op::GetUsage, "Usage over a range of days, by product, meter, project and day, and what paid for it"), |
| 427 | a("budget", Op::GetBudget, "The monthly spend limit, what was spent, alerts and whether usage pauses at the limit"), |
| 428 | a("set_budget", Op::SetBudget, "Change the spend limit, alerts, pausing or the alert webhook"), |
| 429 | a("invoices", Op::ListInvoices, "Every invoice, the itemised usage invoices, and the next one so far"), |
| 430 | a("billing_details", Op::GetBillingDetails, "Who invoices are made out to and the payment method on file"), |
| 431 | ], |
| 432 | }, |
| 433 | Tool { |
| 434 | name: "security", |
| 435 | title: "Security", |
| 436 | 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, a workspace's overview, security advisories and private vulnerability reports. Findings are shown to those who can change the code only; published advisories to anyone who can see the repository. Give `repo` (owner/name), or `workspace` for lists across one.", |
| 437 | default_action: Some("secret_alerts"), |
| 438 | actions: &[ |
| 439 | a("secret_alerts", Op::Security(SecurityOp::ListSecretAlerts), "Secret scanning alerts; by state, secret_type, validity, bypassed"), |
| 440 | a("secret_alert", Op::Security(SecurityOp::GetSecretAlert), "One secret alert, with where it was found and its bypass requests"), |
| 441 | a("update_secret_alert", Op::Security(SecurityOp::UpdateSecretAlert), "Dismiss a secret alert with a reason, or reopen it"), |
| 442 | a("secret_locations", Op::Security(SecurityOp::ListSecretLocations), "Every file, line and commit a secret is in"), |
| 443 | a("bypass", Op::Security(SecurityOp::BypassPushProtection), "Push past push protection with a reason, or ask to"), |
| 444 | a("check_validity", Op::Security(SecurityOp::CheckSecretValidity), "Ask a secret's issuer whether it still works"), |
| 445 | a("bypass_requests", Op::Security(SecurityOp::ListBypassRequests), "A workspace's push protection bypass requests"), |
| 446 | a("review_bypass", Op::Security(SecurityOp::ReviewBypassRequest), "Approve, deny or cancel a bypass request"), |
| 447 | a("patterns", Op::Security(SecurityOp::ListCustomPatterns), "Custom secret patterns of a repository or workspace"), |
| 448 | a("create_pattern", Op::Security(SecurityOp::CreateCustomPattern), "Create a custom secret pattern, as a draft or published"), |
| 449 | a("update_pattern", Op::Security(SecurityOp::UpdateCustomPattern), "Change, publish or unpublish a custom pattern"), |
| 450 | a("delete_pattern", Op::Security(SecurityOp::DeleteCustomPattern), "Delete a custom pattern"), |
| 451 | a("dry_run_pattern", Op::Security(SecurityOp::DryRunCustomPattern), "Run a pattern over the default branch without saving it"), |
| 452 | a("code_alerts", Op::Security(SecurityOp::ListCodeAlerts), "Code scanning alerts; by state, severity, tool, rule_id"), |
| 453 | a("code_alert", Op::Security(SecurityOp::GetCodeAlert), "One code scanning alert by number"), |
| 454 | a("update_code_alert", Op::Security(SecurityOp::UpdateCodeAlert), "Dismiss a code scanning alert with a reason, or reopen it"), |
| 455 | a("analyses", Op::Security(SecurityOp::ListAnalyses), "Code scanning analyses, newest first"), |
| 456 | a("upload_sarif", Op::Security(SecurityOp::UploadSarif), "Upload a SARIF file, gzipped and base64-encoded"), |
| 457 | a("sarif_upload", Op::Security(SecurityOp::GetSarifUpload), "Whether a SARIF upload was read, and its analyses"), |
| 458 | a("vulnerability_alerts", Op::Security(SecurityOp::ListVulnerabilityAlerts), "Vulnerable dependencies; by state, severity, ecosystem, package"), |
| 459 | a("vulnerability_alert", Op::Security(SecurityOp::GetVulnerabilityAlert), "One vulnerability alert"), |
| 460 | a("update_vulnerability_alert", Op::Security(SecurityOp::UpdateVulnerabilityAlert), "Dismiss a vulnerability alert with a reason, or reopen it"), |
| 461 | a("dependency_graph", Op::Security(SecurityOp::GetDependencyGraph), "Every package the lockfiles resolve, direct or transitive"), |
| 462 | a("sbom", Op::Security(SecurityOp::GetSbom), "The dependency graph as an SPDX 2.3 document"), |
| 463 | a("compare_dependencies", Op::Security(SecurityOp::CompareDependencies), "What changes in dependencies between base...head"), |
| 464 | a("settings", Op::Security(SecurityOp::GetSettings), "A repository's security settings"), |
| 465 | a("update_settings", Op::Security(SecurityOp::UpdateSettings), "Change when checks fail and dependency review's policy"), |
| 466 | a("workspace_settings", Op::Security(SecurityOp::GetWorkspaceSettings), "A workspace's delegated bypass and validity checks"), |
| 467 | a("update_workspace_settings", Op::Security(SecurityOp::UpdateWorkspaceSettings), "Turn delegated bypass or validity checks on or off"), |
| 468 | a("overview", Op::Security(SecurityOp::GetOverview), "A workspace's alerts, trends and coverage"), |
| 469 | a("advisories", Op::Security(SecurityOp::ListAdvisories), "A repository's security advisories; by state"), |
| 470 | a("advisory", Op::Security(SecurityOp::GetAdvisory), "One advisory by adv_… or G1TSA-… id"), |
| 471 | a("create_advisory", Op::Security(SecurityOp::CreateAdvisory), "Draft a security advisory"), |
| 472 | a("update_advisory", Op::Security(SecurityOp::UpdateAdvisory), "Change an advisory's fields"), |
| 473 | a("set_advisory_state", Op::Security(SecurityOp::SetAdvisoryState), "Publish or withdraw an advisory"), |
| 474 | a("reports", Op::Security(SecurityOp::ListReports), "Vulnerability reports sent to the maintainers; by state"), |
| 475 | a("report_vulnerability", Op::Security(SecurityOp::ReportVulnerability), "Report a vulnerability privately to a repository's maintainers"), |
| 476 | a("review_report", Op::Security(SecurityOp::ReviewReport), "Accept a report as a draft advisory, or decline it"), |
| 477 | ], |
| 478 | }, |
| 479 | Tool { |
| 480 | name: "notifications", |
| 481 | title: "Notifications", |
| 482 | 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`): 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.", |
| 483 | default_action: Some("list"), |
| 484 | actions: &[ |
| 485 | a("list", Op::ListNotifications, "Unread threads, latest first; all, a view, a reason, a repository"), |
| 486 | a("get", Op::GetNotificationThread, "One thread with its recent activity and your subscription"), |
| 487 | a("mark_read", Op::MarkThreadRead, "Mark a thread read, or unread"), |
| 488 | a("mark_all_read", Op::MarkNotificationsRead, "Mark everything read up to a time, or one repository's"), |
| 489 | a("done", Op::MarkThreadDone, "Mark a thread done; new activity brings it back"), |
| 490 | a("save", Op::SaveThread, "Save a thread, or unsave it"), |
| 491 | a("snooze", Op::SnoozeThread, "Snooze a thread until a time, or bring it back"), |
| 492 | a("subscription", Op::GetThreadSubscription, "Your subscription to an issue or pull request"), |
| 493 | a("subscribe", Op::SetThreadSubscription, "Subscribe to an issue or pull request, or ignore it"), |
| 494 | a("unsubscribe", Op::DeleteThreadSubscription, "Unsubscribe until you comment or are mentioned"), |
| 495 | a("watching", Op::GetRepoSubscription, "How you watch a repository"), |
| 496 | a("watch", Op::SetRepoSubscription, "Watch a repository: participating, all, ignore or custom"), |
| 497 | a("unwatch", Op::DeleteRepoSubscription, "Stop watching a repository"), |
| 498 | a("watched", Op::ListWatchedRepos, "Repositories you watch other than the default way"), |
| 499 | ], |
| 500 | }, |
| 501 | Tool { |
| 502 | name: "account", |
| 503 | title: "Your account", |
| 504 | description: "Who this token acts as and its workspaces (`whoami`), your email addresses, and invitations to workspaces and repositories waiting for you.", |
| 505 | default_action: Some("whoami"), |
| 506 | actions: &[ |
| 507 | a("whoami", Op::Whoami, "Who the token acts as, and its workspaces"), |
| 508 | a("list_emails", Op::ListEmails, "Your addresses"), |
| 509 | a("add_email", Op::AddEmail, "Add an address"), |
| 510 | a("confirm_email", Op::ConfirmEmail, "Confirm an address with the code from its email"), |
| 511 | a("remove_email", Op::RemoveEmail, "Remove an address"), |
| 512 | a("update_email_settings", Op::UpdateEmailSettings, "Primary, backup and privacy"), |
| 513 | a("list_workspace_invitations", Op::ListInvitations, "Invitations to workspaces for you"), |
| 514 | a("accept_workspace_invitation", Op::AcceptInvitation, "Accept one and join"), |
| 515 | a("decline_workspace_invitation", Op::DeclineInvitation, "Decline one"), |
| 516 | a("list_repository_invitations", Op::ListMyRepoInvitations, "Invitations to repositories for you"), |
| 517 | a("accept_repository_invitation", Op::AcceptRepoInvitation, "Accept one"), |
| 518 | a("decline_repository_invitation", Op::DeclineRepoInvitation, "Decline one"), |
| 519 | ], |
| 520 | }, |
| 521 | Tool { |
| 522 | name: "artifact", |
| 523 | title: "Artifacts", |
| 524 | description: "A workspace's docs, slides, designs and dashboards (Artifacts mode), as you can open them: list, search and read them (a doc's content is Markdown, with block ids to target), make them, edit them (a change with the edit role, a suggestion with comment), move, trash and restore them, their versions, and who can open them. Name one by its id (fol_…) or its address. Not the `workflow` tool's run artifacts. Slides, designs and dashboards answer that they are not here yet.", |
| 525 | default_action: None, |
| 526 | actions: &[ |
| 527 | a("list", Op::Folios(FoliosOp::List), "Artifacts you can open; tab, kind, space, q; state trashed for the trash"), |
| 528 | a("search", Op::Folios(FoliosOp::Search), "Search them by words and meaning, with the passage that matched"), |
| 529 | a("get", Op::Folios(FoliosOp::Get), "One artifact: kind, title, space, owner, your role, who it is shared with"), |
| 530 | a("read", Op::Folios(FoliosOp::GetContent), "Its content: a doc's Markdown and block ids, and what you may do"), |
| 531 | a("versions", Op::Folios(FoliosOp::ListVersions), "Its saved versions, newest first"), |
| 532 | a("access", Op::Folios(FoliosOp::GetAccess), "Who can open it, and how"), |
| 533 | a("templates", Op::Folios(FoliosOp::ListTemplates), "Templates to start one from"), |
| 534 | a("spaces", Op::Folios(FoliosOp::ListSpaces), "The spaces in your sidebar"), |
| 535 | a("query_data", Op::Folios(FoliosOp::QueryDataset), "Run a dataset query as you, over what you can read"), |
| 536 | a("create", Op::Folios(FoliosOp::Create), "Make one: in a space, under a doc, or in your Private"), |
| 537 | a("update", Op::Folios(FoliosOp::Update), "Rename it, change its icon, or move it"), |
| 538 | a("edit", Op::Folios(FoliosOp::Edit), "Change its content: append, replace it all, a section or blocks"), |
| 539 | a("trash", Op::Folios(FoliosOp::Trash), "Move it to the trash; restorable for 30 days"), |
| 540 | a("restore", Op::Folios(FoliosOp::Restore), "Bring it back from the trash"), |
| 541 | a("restore_version", Op::Folios(FoliosOp::RestoreVersion), "Make an earlier version its content again"), |
| 542 | a("share", Op::Folios(FoliosOp::SetAccess), "Share it, change general access, or take access away"), |
| 543 | a("purge", Op::Folios(FoliosOp::Purge), "Delete one in the trash for good"), |
| 544 | ], |
| 545 | }, |
| 546 | ]; |
| 547 | |
| 548 | /// Operations offered over REST alone, not as an action of any tool: how |
| 549 | /// a project's telemetry is collected (settings, ingest tokens, exports, |
| 550 | /// usage) is for people setting it up, not for agents debugging. |
| 551 | pub const REST_ONLY: &[Op] = &[ |
| 552 | Op::Telemetry(TelemetryOp::GetSettings), |
| 553 | Op::Telemetry(TelemetryOp::UpdateSettings), |
| 554 | Op::Telemetry(TelemetryOp::ListTokens), |
| 555 | Op::Telemetry(TelemetryOp::CreateToken), |
| 556 | Op::Telemetry(TelemetryOp::DeleteToken), |
| 557 | Op::Telemetry(TelemetryOp::ListExports), |
| 558 | Op::Telemetry(TelemetryOp::CreateExport), |
| 559 | Op::Telemetry(TelemetryOp::UpdateExport), |
| 560 | Op::Telemetry(TelemetryOp::DeleteExport), |
| 561 | Op::Telemetry(TelemetryOp::GetUsage), |
| 562 | ]; |
| 563 | |
| 564 | /// Operations that cannot be undone, or reach beyond g1t's own records: |
| 565 | /// clients ask before running a tool that has any of them. |
| 566 | fn destructive(op: Op) -> bool { |
| 567 | matches!( |
| 568 | op, |
| 569 | Op::Security(SecurityOp::DeleteCustomPattern | SecurityOp::BypassPushProtection) |
| 570 | | Op::Rules(RulesOp::DeleteRepoRuleset | RulesOp::DeleteWorkspaceRuleset) |
| 571 | | Op::DeleteWorkspace |
| 572 | | Op::UpdateWorkspace |
| 573 | | Op::Tokens(TokenOp::RevokeMemberToken | TokenOp::SetTokenPolicy) |
| 574 | | Op::RemoveMember |
| 575 | | Op::TransferOwnership |
| 576 | | Op::LeaveWorkspace |
| 577 | | Op::DeleteRepo |
| 578 | | Op::PurgeRepo |
| 579 | | Op::TransferRepo |
| 580 | | Op::SetRepoVisibility |
| 581 | | Op::RemoveEmail |
| 582 | | Op::RemoveCollaborator |
| 583 | | Op::DisconnectIntegration |
| 584 | | Op::UpdateIntegration |
| 585 | | Op::DeleteWebhook |
| 586 | | Op::DeleteActionsSecret |
| 587 | | Op::DeleteActionsVariable |
| 588 | | Op::SetActionsSecret |
| 589 | | Op::SetActionsVariable |
| 590 | | Op::SetBasePermission |
| 591 | | Op::DeleteTeam |
| 592 | | Op::RemoveTeamRepo |
| 593 | | Op::MergePullRequest |
| 594 | | Op::RemoveRunner |
| 595 | | Op::DeleteRunnerGroup |
| 596 | | Op::UpdateRunnerSettings |
| 597 | | Op::Folios(FoliosOp::SetAccess | FoliosOp::Purge) |
| 598 | ) |
| 599 | } |
| 600 | |
| 601 | /// Whether an operation only reads. |
| 602 | pub fn reads_only(op: Op) -> bool { |
| 603 | NO_SCOPE.contains(&op.name()) |
| 604 | || scope_for(op.name()).is_some_and(|scope| scope.level() == Level::Read) |
| 605 | } |
| 606 | |
| 607 | /// What decides which actions a caller sees. |
| 608 | pub enum Gate<'a> { |
| 609 | /// No limit beyond the person's own role. |
| 610 | Everything, |
| 611 | /// A run's token (a checks, merge queue or deploy job): the |
| 612 | /// operations its run lists. |
| 613 | Agent(&'a AgentScope), |
| 614 | /// An access token with scopes. |
| 615 | Token(&'a TokenAccess), |
| 616 | } |
| 617 | |
| 618 | impl Gate<'_> { |
| 619 | pub fn allows(&self, op: Op) -> bool { |
| 620 | match self { |
| 621 | Gate::Everything => true, |
| 622 | Gate::Agent(scope) => op.allowed_by(scope) && !NEVER.contains(&op.name()), |
| 623 | Gate::Token(access) => { |
| 624 | if NO_SCOPE.contains(&op.name()) { |
| 625 | return true; |
| 626 | } |
| 627 | match scope_for(op.name()) { |
| 628 | Some(scope) => access.allows(scope), |
| 629 | None => access.scopes.is_none(), |
| 630 | } |
| 631 | } |
| 632 | } |
| 633 | } |
| 634 | } |
| 635 | |
| 636 | impl Tool { |
| 637 | pub fn by_name(name: &str) -> Option<&'static Tool> { |
| 638 | TOOLS.iter().find(|tool| tool.name == name) |
| 639 | } |
| 640 | |
| 641 | pub fn action(&self, name: &str) -> Option<&'static Action> { |
| 642 | // The tools are 'static; find through TOOLS to keep the lifetime. |
| 643 | TOOLS |
| 644 | .iter() |
| 645 | .find(|tool| tool.name == self.name) |
| 646 | .and_then(|tool| tool.actions.iter().find(|action| action.name == name)) |
| 647 | } |
| 648 | |
| 649 | pub fn visible(&self, gate: &Gate) -> Vec<&'static Action> { |
| 650 | TOOLS |
| 651 | .iter() |
| 652 | .find(|tool| tool.name == self.name) |
| 653 | .map(|tool| tool.actions.iter().filter(|action| gate.allows(action.op)).collect()) |
| 654 | .unwrap_or_default() |
| 655 | } |
| 656 | |
| 657 | /// The flat input schema of the actions given. |
| 658 | pub fn input_schema(&self, actions: &[&Action]) -> Value { |
| 659 | let mut properties = Map::new(); |
| 660 | let lines: Vec<String> = actions |
| 661 | .iter() |
| 662 | .map(|action| { |
| 663 | let required: Vec<String> = action.op.required(); |
| 664 | if required.is_empty() { |
| 665 | format!("{}: {}.", action.name, action.summary) |
| 666 | } else { |
| 667 | format!("{} ({}): {}.", action.name, required.join(", "), action.summary) |
| 668 | } |
| 669 | }) |
| 670 | .collect(); |
| 671 | let mut action_schema = json!({ |
| 672 | "type": "string", |
| 673 | "enum": actions.iter().map(|action| action.name).collect::<Vec<_>>(), |
| 674 | "description": lines.join("\n"), |
| 675 | }); |
| 676 | if let Some(default) = self.default_action.filter(|name| actions.iter().any(|action| action.name == *name)) { |
| 677 | action_schema["default"] = json!(default); |
| 678 | } |
| 679 | properties.insert("action".to_owned(), action_schema); |
| 680 | for action in actions { |
| 681 | for (name, schema) in action.op.properties() { |
| 682 | merge_property(&mut properties, name, schema); |
| 683 | } |
| 684 | } |
| 685 | let mut required = vec![]; |
| 686 | if self.default_action.is_none() { |
| 687 | required.push("action"); |
| 688 | } |
| 689 | let mut schema = json!({ "type": "object", "properties": properties }); |
| 690 | if !required.is_empty() { |
| 691 | schema["required"] = json!(required); |
| 692 | } |
| 693 | schema |
| 694 | } |
| 695 | |
| 696 | /// The input schema keyed by action: one `oneOf` branch per action, |
| 697 | /// each with its own fields and the ones it needs. |
| 698 | pub fn discriminated(&self, actions: &[&Action]) -> Value { |
| 699 | let branches: Vec<Value> = actions |
| 700 | .iter() |
| 701 | .map(|action| { |
| 702 | let mut properties = Map::new(); |
| 703 | properties.insert("action".to_owned(), json!({ "const": action.name })); |
| 704 | properties.extend(action.op.properties()); |
| 705 | let mut required = vec![Value::String("action".to_owned())]; |
| 706 | // The default action may leave `action` out. |
| 707 | if self.default_action == Some(action.name) { |
| 708 | required.clear(); |
| 709 | } |
| 710 | required.extend(action.op.required().into_iter().map(Value::String)); |
| 711 | json!({ |
| 712 | "title": action.name, |
| 713 | "description": action.summary, |
| 714 | "type": "object", |
| 715 | "properties": properties, |
| 716 | "required": required, |
| 717 | }) |
| 718 | }) |
| 719 | .collect(); |
| 720 | json!({ "type": "object", "oneOf": branches }) |
| 721 | } |
| 722 | |
| 723 | /// MCP's hints about the actions given: whether the tool only reads, |
| 724 | /// whether it can destroy something, and whether calling it twice is |
| 725 | /// the same as once. |
| 726 | pub fn annotations(&self, actions: &[&Action]) -> Value { |
| 727 | let read_only = actions.iter().all(|action| reads_only(action.op)); |
| 728 | json!({ |
| 729 | "title": self.title, |
| 730 | "readOnlyHint": read_only, |
| 731 | "destructiveHint": !read_only && actions.iter().any(|action| destructive(action.op)), |
| 732 | "idempotentHint": read_only, |
| 733 | "openWorldHint": false, |
| 734 | }) |
| 735 | } |
| 736 | |
| 737 | /// The tool as `tools/list` gives it, for a caller behind `gate`, or |
| 738 | /// `None` when it may use none of its actions. |
| 739 | pub fn listed(&self, gate: &Gate) -> Option<Value> { |
| 740 | let actions = self.visible(gate); |
| 741 | if actions.is_empty() { |
| 742 | return None; |
| 743 | } |
| 744 | Some(json!({ |
| 745 | "name": self.name, |
| 746 | "title": self.title, |
| 747 | "description": self.description, |
| 748 | "inputSchema": self.input_schema(&actions), |
| 749 | "annotations": self.annotations(&actions), |
| 750 | })) |
| 751 | } |
| 752 | } |
| 753 | |
| 754 | /// Adds a property to a tool's flat schema. The first action to use a name |
| 755 | /// describes it; a later one with other allowed values adds them. |
| 756 | fn merge_property(properties: &mut Map<String, Value>, name: String, schema: Value) { |
| 757 | match properties.get_mut(&name) { |
| 758 | None => { |
| 759 | properties.insert(name, schema); |
| 760 | } |
| 761 | Some(existing) => { |
| 762 | if let (Some(Value::Array(had)), Some(Value::Array(more))) = |
| 763 | (existing.get("enum").cloned(), schema.get("enum")) |
| 764 | { |
| 765 | let mut merged = had; |
| 766 | for value in more { |
| 767 | if !merged.contains(value) { |
| 768 | merged.push(value.clone()); |
| 769 | } |
| 770 | } |
| 771 | existing["enum"] = Value::Array(merged); |
| 772 | } |
| 773 | // Different kinds of value under one name: say less, accept both. |
| 774 | if existing.get("type") != schema.get("type") |
| 775 | && let Some(fields) = existing.as_object_mut() |
| 776 | { |
| 777 | fields.remove("type"); |
| 778 | fields.remove("items"); |
| 779 | } |
| 780 | } |
| 781 | } |
| 782 | } |
| 783 | |
| 784 | /// What a call to a tool runs: the operation its action names, or why not. |
| 785 | pub fn resolve(tool: &Tool, arguments: &Value) -> Result<Op, String> { |
| 786 | let names = || { |
| 787 | tool.actions |
| 788 | .iter() |
| 789 | .map(|action| action.name) |
| 790 | .collect::<Vec<_>>() |
| 791 | .join(", ") |
| 792 | }; |
| 793 | let Some(name) = arguments["action"].as_str().or(tool.default_action) else { |
| 794 | return Err(format!("Give an action: one of {}.", names())); |
| 795 | }; |
| 796 | let Some(action) = tool.action(name) else { |
| 797 | return Err(format!("{} has no action {name}. Its actions: {}.", tool.name, names())); |
| 798 | }; |
| 799 | let missing: Vec<String> = action |
| 800 | .op |
| 801 | .required() |
| 802 | .into_iter() |
| 803 | .filter(|field| arguments.get(field).is_none_or(Value::is_null)) |
| 804 | .collect(); |
| 805 | if !missing.is_empty() { |
| 806 | return Err(format!("{}.{name} needs {}.", tool.name, missing.join(", "))); |
| 807 | } |
| 808 | Ok(action.op) |
| 809 | } |
| 810 | |
| 811 | #[cfg(test)] |
| 812 | mod tests { |
| 813 | use super::*; |
| 814 | use g1t_contracts::scopes::{Preset, Scope}; |
| 815 | |
| 816 | fn listed(gate: &Gate) -> Vec<Value> { |
| 817 | TOOLS.iter().filter_map(|tool| tool.listed(gate)).collect() |
| 818 | } |
| 819 | |
| 820 | fn token(scopes: Option<Vec<Scope>>) -> TokenAccess { |
| 821 | TokenAccess { |
| 822 | token_id: "tok_1".to_owned(), |
| 823 | scopes: scopes.map(|scopes| scopes.iter().map(|scope| scope.as_str().to_owned()).collect()), |
| 824 | legacy: false, |
| 825 | name: None, |
| 826 | ..TokenAccess::default() |
| 827 | } |
| 828 | } |
| 829 | |
| 830 | #[test] |
| 831 | fn every_operation_is_exactly_one_action_of_one_tool() { |
| 832 | for op in Op::ALL { |
| 833 | let count = TOOLS |
| 834 | .iter() |
| 835 | .flat_map(|tool| tool.actions.iter()) |
| 836 | .filter(|action| action.op == op) |
| 837 | .count(); |
| 838 | let expected = usize::from(!REST_ONLY.contains(&op)); |
| 839 | assert_eq!(count, expected, "{} is {count} actions", op.name()); |
| 840 | } |
| 841 | for tool in TOOLS { |
| 842 | let mut names = std::collections::HashSet::new(); |
| 843 | for action in tool.actions { |
| 844 | assert!(names.insert(action.name), "{}.{} twice", tool.name, action.name); |
| 845 | } |
| 846 | if let Some(default) = tool.default_action { |
| 847 | assert!(tool.action(default).is_some(), "{}", tool.name); |
| 848 | } |
| 849 | } |
| 850 | assert!(TOOLS.len() <= 18, "{} tools", TOOLS.len()); |
| 851 | } |
| 852 | |
| 853 | #[test] |
| 854 | fn every_operation_needs_exactly_one_scope_or_none() { |
| 855 | use g1t_contracts::scopes::OPERATIONS; |
| 856 | for op in Op::ALL { |
| 857 | let mapped = OPERATIONS.iter().filter(|(name, _)| *name == op.name()).count(); |
| 858 | let free = NO_SCOPE.contains(&op.name()); |
| 859 | assert_eq!(mapped + usize::from(free), 1, "{}", op.name()); |
| 860 | } |
| 861 | for (name, _) in OPERATIONS { |
| 862 | assert!(Op::by_name(name).is_some(), "{name} is not an operation"); |
| 863 | } |
| 864 | } |
| 865 | |
| 866 | #[test] |
| 867 | fn each_tool_schema_is_valid_with_one_branch_per_action() { |
| 868 | for tool in TOOLS { |
| 869 | let actions: Vec<&Action> = tool.actions.iter().collect(); |
| 870 | let flat = tool.input_schema(&actions); |
| 871 | assert_eq!(flat["type"], "object"); |
| 872 | assert!(flat.get("oneOf").is_none(), "no oneOf at the top level"); |
| 873 | let listed: Vec<&str> = flat["properties"]["action"]["enum"] |
| 874 | .as_array() |
| 875 | .unwrap() |
| 876 | .iter() |
| 877 | .map(|name| name.as_str().unwrap()) |
| 878 | .collect(); |
| 879 | assert_eq!(listed, tool.actions.iter().map(|action| action.name).collect::<Vec<_>>()); |
| 880 | for action in tool.actions { |
| 881 | for field in action.op.required() { |
| 882 | assert!(flat["properties"].get(&field).is_some(), "{}.{}: {field}", tool.name, action.name); |
| 883 | } |
| 884 | } |
| 885 | let keyed = tool.discriminated(&actions); |
| 886 | let branches = keyed["oneOf"].as_array().unwrap(); |
| 887 | assert_eq!(branches.len(), tool.actions.len()); |
| 888 | for (branch, action) in branches.iter().zip(tool.actions) { |
| 889 | assert_eq!(branch["properties"]["action"]["const"], action.name); |
| 890 | for field in branch["required"].as_array().unwrap() { |
| 891 | assert!(branch["properties"].get(field.as_str().unwrap()).is_some(), "{}.{}: {field}", tool.name, action.name); |
| 892 | } |
| 893 | } |
| 894 | // A well-formed JSON Schema object throughout. |
| 895 | let text = serde_json::to_string(&flat).unwrap(); |
| 896 | assert!(serde_json::from_str::<Value>(&text).is_ok()); |
| 897 | } |
| 898 | } |
| 899 | |
| 900 | #[test] |
| 901 | fn a_read_only_token_sees_read_actions_only() { |
| 902 | let access = token(Preset::ReadOnly.scopes()); |
| 903 | let gate = Gate::Token(&access); |
| 904 | for tool in TOOLS { |
| 905 | for action in tool.visible(&gate) { |
| 906 | assert!(reads_only(action.op), "{}.{}", tool.name, action.name); |
| 907 | } |
| 908 | } |
| 909 | let tools = listed(&gate); |
| 910 | for tool in &tools { |
| 911 | assert_eq!(tool["annotations"]["readOnlyHint"], true, "{}", tool["name"]); |
| 912 | assert_eq!(tool["annotations"]["destructiveHint"], false); |
| 913 | } |
| 914 | let issue = tools.iter().find(|tool| tool["name"] == "issue").unwrap(); |
| 915 | assert_eq!(issue["inputSchema"]["properties"]["action"]["enum"], json!(["list", "get", "labels"])); |
| 916 | } |
| 917 | |
| 918 | #[test] |
| 919 | fn a_narrow_token_sees_only_its_tools() { |
| 920 | let access = token(Some(vec![Scope::IssuesWrite])); |
| 921 | let names: Vec<Value> = listed(&Gate::Token(&access)).into_iter().map(|tool| tool["name"].clone()).collect(); |
| 922 | // Labels and milestones are the repository's, managed with issues:write. |
| 923 | assert_eq!(names, vec![json!("repository"), json!("issue"), json!("account")]); |
| 924 | // Notifications are a resource of their own: reading them lists |
| 925 | // only what reads. |
| 926 | let reader = token(Some(vec![Scope::NotificationsRead])); |
| 927 | let tools = listed(&Gate::Token(&reader)); |
| 928 | let notifications = tools.iter().find(|tool| tool["name"] == "notifications").unwrap(); |
| 929 | assert_eq!( |
| 930 | notifications["inputSchema"]["properties"]["action"]["enum"], |
| 931 | json!(["list", "get", "subscription", "watching", "watched"]) |
| 932 | ); |
| 933 | assert_eq!(notifications["annotations"]["readOnlyHint"], true); |
| 934 | let full = token(None); |
| 935 | assert_eq!(listed(&Gate::Token(&full)).len(), TOOLS.len()); |
| 936 | assert_eq!(listed(&Gate::Everything).len(), TOOLS.len()); |
| 937 | } |
| 938 | |
| 939 | #[test] |
| 940 | fn a_tool_that_can_destroy_says_so() { |
| 941 | let tools = listed(&Gate::Everything); |
| 942 | let repository = tools.iter().find(|tool| tool["name"] == "repository").unwrap(); |
| 943 | assert_eq!(repository["annotations"]["destructiveHint"], true); |
| 944 | assert_eq!(repository["annotations"]["readOnlyHint"], false); |
| 945 | let memory = tools.iter().find(|tool| tool["name"] == "memory").unwrap(); |
| 946 | assert_eq!(memory["annotations"]["destructiveHint"], false); |
| 947 | } |
| 948 | |
| 949 | #[test] |
| 950 | fn calls_resolve_to_their_operation_or_say_what_is_missing() { |
| 951 | let issue = Tool::by_name("issue").unwrap(); |
| 952 | assert_eq!(resolve(issue, &json!({ "action": "get", "repo": "a/b", "number": 1 })), Ok(Op::GetIssue)); |
| 953 | assert_eq!(resolve(issue, &json!({ "action": "get", "repo": "a/b" })), Err("issue.get needs number.".to_owned())); |
| 954 | assert!(resolve(issue, &json!({})).unwrap_err().starts_with("Give an action")); |
| 955 | assert!(resolve(issue, &json!({ "action": "explode" })).unwrap_err().contains("no action explode")); |
| 956 | let search = Tool::by_name("search").unwrap(); |
| 957 | assert_eq!(resolve(search, &json!({ "query": "x" })), Ok(Op::Search)); |
| 958 | let account = Tool::by_name("account").unwrap(); |
| 959 | assert_eq!(resolve(account, &json!({})), Ok(Op::Whoami)); |
| 960 | } |
| 961 | |
| 962 | #[test] |
| 963 | fn teams_are_one_tool_and_a_workspace_reader_sees_only_its_reads() { |
| 964 | let team = Tool::by_name("team").unwrap(); |
| 965 | let names: Vec<&str> = team.actions.iter().map(|action| action.name).collect(); |
| 966 | assert_eq!( |
| 967 | names, |
| 968 | [ |
| 969 | "list", |
| 970 | "get", |
| 971 | "create", |
| 972 | "update", |
| 973 | "delete", |
| 974 | "list_members", |
| 975 | "set_member", |
| 976 | "remove_member", |
| 977 | "list_child_teams", |
| 978 | "list_repos", |
| 979 | "set_repo", |
| 980 | "remove_repo", |
| 981 | "set_review_assignment", |
| 982 | "list_user_teams", |
| 983 | ] |
| 984 | ); |
| 985 | let reader = token(Some(vec![Scope::WorkspaceRead])); |
| 986 | let tools = listed(&Gate::Token(&reader)); |
| 987 | let listed_team = tools.iter().find(|tool| tool["name"] == "team").unwrap(); |
| 988 | assert_eq!( |
| 989 | listed_team["inputSchema"]["properties"]["action"]["enum"], |
| 990 | json!(["list", "get", "list_members", "list_child_teams", "list_repos", "list_user_teams"]) |
| 991 | ); |
| 992 | assert_eq!(listed_team["annotations"]["readOnlyHint"], true); |
| 993 | // A team's role on a repository is who has access. |
| 994 | let admin = token(Some(vec![Scope::WorkspaceAdmin])); |
| 995 | let tools = listed(&Gate::Token(&admin)); |
| 996 | let listed_team = tools.iter().find(|tool| tool["name"] == "team").unwrap(); |
| 997 | let actions = listed_team["inputSchema"]["properties"]["action"]["enum"].as_array().unwrap(); |
| 998 | assert!(actions.contains(&json!("set_review_assignment")) && !actions.contains(&json!("set_repo"))); |
| 999 | let access = token(Some(vec![Scope::AccessAdmin])); |
| 1000 | let tools = listed(&Gate::Token(&access)); |
| 1001 | let listed_team = tools.iter().find(|tool| tool["name"] == "team").unwrap(); |
| 1002 | assert_eq!(listed_team["inputSchema"]["properties"]["action"]["enum"], json!(["set_repo", "remove_repo"])); |
| 1003 | // Both kinds of role a schema names are offered. |
| 1004 | let roles = &listed(&Gate::Everything).into_iter().find(|tool| tool["name"] == "team").unwrap()["inputSchema"] |
| 1005 | ["properties"]["role"]["enum"]; |
| 1006 | for role in ["member", "maintainer", "read", "admin"] { |
| 1007 | assert!(roles.as_array().unwrap().contains(&json!(role)), "{role}"); |
| 1008 | } |
| 1009 | assert_eq!( |
| 1010 | resolve(team, &json!({ "action": "set_repo", "workspace": "acme", "team": "backend", "repo": "rocket" })), |
| 1011 | Err("team.set_repo needs role.".to_owned()) |
| 1012 | ); |
| 1013 | } |
| 1014 | |
| 1015 | #[test] |
| 1016 | fn reviewers_and_code_owners_are_actions_of_their_tools() { |
| 1017 | let pull = Tool::by_name("pull_request").unwrap(); |
| 1018 | assert_eq!( |
| 1019 | resolve(pull, &json!({ "action": "request_reviewers", "repo": "a/b", "number": 1, "team_reviewers": ["backend"] })), |
| 1020 | Ok(Op::RequestReviewers) |
| 1021 | ); |
| 1022 | assert_eq!(pull.action("remove_requested_reviewers").map(|action| action.op), Some(Op::RemoveRequestedReviewers)); |
| 1023 | let repository = Tool::by_name("repository").unwrap(); |
| 1024 | assert_eq!(resolve(repository, &json!({ "action": "codeowners", "repo": "a/b" })), Ok(Op::GetCodeownersErrors)); |
| 1025 | assert!(reads_only(Op::GetCodeownersErrors)); |
| 1026 | assert!(!reads_only(Op::RequestReviewers)); |
| 1027 | } |
| 1028 | |
| 1029 | /// The `artifact` tool offers each token only what its artifacts scope |
| 1030 | /// allows: reading, then changing, then sharing and deleting for good. |
| 1031 | /// Workflow runs' artifacts are the `workflow` tool's, under their own |
| 1032 | /// scope, and neither scope reaches the other's. |
| 1033 | #[test] |
| 1034 | fn the_artifact_tool_offers_what_the_artifacts_scope_allows() { |
| 1035 | let actions = |scopes: Vec<Scope>| -> Option<Value> { |
| 1036 | let access = token(Some(scopes)); |
| 1037 | Tool::by_name("artifact").unwrap().listed(&Gate::Token(&access)).map(|tool| tool["inputSchema"]["properties"]["action"]["enum"].clone()) |
| 1038 | }; |
| 1039 | let reads = json!(["list", "search", "get", "read", "versions", "access", "templates", "spaces", "query_data"]); |
| 1040 | assert_eq!(actions(vec![Scope::ArtifactsRead]), Some(reads.clone())); |
| 1041 | let writes = actions(vec![Scope::ArtifactsWrite]).unwrap(); |
| 1042 | for action in ["create", "update", "edit", "trash", "restore", "restore_version"] { |
| 1043 | assert!(writes.as_array().unwrap().contains(&json!(action)), "{action}"); |
| 1044 | } |
| 1045 | assert!(!writes.as_array().unwrap().contains(&json!("share")) && !writes.as_array().unwrap().contains(&json!("purge"))); |
| 1046 | let admin = actions(vec![Scope::ArtifactsAdmin]).unwrap(); |
| 1047 | assert_eq!(admin.as_array().unwrap().len(), Tool::by_name("artifact").unwrap().actions.len()); |
| 1048 | // Without an artifacts scope there is no artifact tool at all. |
| 1049 | assert_eq!(actions(vec![Scope::WorkflowsWrite, Scope::IssuesWrite]), None); |
| 1050 | // And an artifacts scope shows nothing of workflow runs' artifacts. |
| 1051 | let access = token(Some(vec![Scope::ArtifactsAdmin])); |
| 1052 | assert!(Tool::by_name("workflow").unwrap().listed(&Gate::Token(&access)).is_none()); |
| 1053 | // The read-only and agent presets read artifacts and change none. |
| 1054 | for preset in [Preset::ReadOnly, Preset::Agent] { |
| 1055 | let access = token(preset.scopes()); |
| 1056 | let tool = Tool::by_name("artifact").unwrap().listed(&Gate::Token(&access)).unwrap(); |
| 1057 | assert_eq!(tool["inputSchema"]["properties"]["action"]["enum"], reads, "{}", preset.as_str()); |
| 1058 | assert_eq!(tool["annotations"]["readOnlyHint"], true); |
| 1059 | } |
| 1060 | // Sharing and deleting for good can't be undone the same way. |
| 1061 | let tools = listed(&Gate::Everything); |
| 1062 | let artifact = tools.iter().find(|tool| tool["name"] == "artifact").unwrap(); |
| 1063 | assert_eq!(artifact["annotations"]["destructiveHint"], true); |
| 1064 | assert!(artifact["description"].as_str().unwrap().contains("Not the `workflow` tool's run artifacts")); |
| 1065 | let tool = Tool::by_name("artifact").unwrap(); |
| 1066 | assert_eq!(resolve(tool, &json!({ "action": "read", "workspace": "acme" })), Err("artifact.read needs artifact_id.".to_owned())); |
| 1067 | assert_eq!( |
| 1068 | resolve(tool, &json!({ "action": "edit", "workspace": "acme", "artifact_id": "fol_1", "markdown": "x" })), |
| 1069 | Ok(Op::Folios(FoliosOp::Edit)) |
| 1070 | ); |
| 1071 | } |
| 1072 | |
| 1073 | /// How much smaller `tools/list` is than one tool per operation. Run |
| 1074 | /// with `--nocapture` to see the numbers. |
| 1075 | #[test] |
| 1076 | fn the_tool_list_is_much_smaller_than_one_tool_per_operation() { |
| 1077 | let before: Vec<Value> = Op::ALL |
| 1078 | .into_iter() |
| 1079 | .map(|op| json!({ "name": op.name(), "description": op.description(), "inputSchema": op.input() })) |
| 1080 | .collect(); |
| 1081 | let after = listed(&Gate::Everything); |
| 1082 | let before_bytes = serde_json::to_string(&json!({ "tools": before })).unwrap().len(); |
| 1083 | let after_bytes = serde_json::to_string(&json!({ "tools": after })).unwrap().len(); |
| 1084 | let agent = token(Preset::Agent.scopes()); |
| 1085 | let agent_bytes = serde_json::to_string(&json!({ "tools": listed(&Gate::Token(&agent)) })).unwrap().len(); |
| 1086 | let read = token(Preset::ReadOnly.scopes()); |
| 1087 | let read_bytes = serde_json::to_string(&json!({ "tools": listed(&Gate::Token(&read)) })).unwrap().len(); |
| 1088 | println!( |
| 1089 | "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)", |
| 1090 | before.len(), |
| 1091 | before_bytes / 4, |
| 1092 | after.len(), |
| 1093 | after_bytes / 4, |
| 1094 | agent_bytes / 4, |
| 1095 | read_bytes / 4, |
| 1096 | ); |
| 1097 | assert!(after_bytes * 2 < before_bytes, "{after_bytes} vs {before_bytes}"); |
| 1098 | } |
| 1099 | } |