Orbit

Create a label that can be applied to issues. Pass a team to keep the label on that team only, otherwise it is available across the workspace.

Add a milestone to a project so work can be grouped towards a date.

Create a project and optionally attach it to one or more teams. Requires a role that can manage projects.

Add a status to a team board. The category drives what the product infers from it, so pick the one that matches the meaning. The new status lands at the end; use reorder_states to place it.

Create up to 50 sub-issues under a parent issue in one transaction. Returns the created identifiers in order.

Create a team with its own issue prefix, default workflow states and first sprint.

Save a filtered issue view. Call list_views first and copy the filter of a view that already works. The saved view state. Conditions live under filter.filter.children, each one {"kind":"condition","property":"priority","operator":"in","values":["1"]}. Other keys are teamId, projectId, groupBy, subGroupBy, orderBy, layout, display, visibility, locked and position. A key this list does not name is rejected rather than dropped. The reply says how many conditions were stored, so check it matches what you sent.

Return scope, started, completed and cancelled counts for a sprint, the same totals in points, what was added or removed while it ran, and a day by day burn up series carrying both the scope and the completed work.

Remove a comment from an issue.

Delete a document permanently. Pages nested under it are lifted to its own place rather than deleted. Use archive_doc to hide a document instead of destroying it.

Delete a folder. The documents inside stay in the workspace but lose their collection link unless you reassign them to another collection.

Remove a comment from a document.

Permanently delete an issue and everything attached to it. This cannot be undone; prefer archive_issue.

Remove a label from the workspace and from every issue carrying it.

Remove a milestone. Its issues survive but lose the milestone link.

Permanently delete a project. Its issues survive but lose their project link. Prefer archive_project.

Remove a sprint. Its issues survive and fall back to no sprint, which is what descoping a cancelled sprint needs.

Remove a status from a team board. A status that still holds issues is refused unless moveTo names another status on the same team to carry them.

Remove a saved view.

Rewrite the body of a comment this user wrote on an issue.

Rewrite the body of a comment this user wrote on a document.

Retrieve a high-level analytics overview of the workspace. Use this to answer questions about throughput, median cycle time, blocked work, and current WIP. You can filter the time range and choose to measure by issues or points.

Return a document with its full body. A markdown document returns Markdown, an html document returns the whole HTML page. The kind field says which.

Fetch one issue by identifier such as "ENG-42" or by id, including its description, labels and relations.

Return the Orbit user, workspace, role and teams authorized by the OAuth grant. Call this first to learn which teams you may write to.

Return the current workspace guidance for connected agents. This is advisory context, not a permission boundary.

Create a pending workspace invitation for an email address. This tool does not send an invitation email. Requires a role that can invite members. Only admins can invite admins.

Associate a connected repository with a project, or with the whole workspace when no project is given. A project may have many repositories and a repository may serve many projects. Associating also starts watching the repository, which is what lets its pull request and check events reach Orbit.

Files attached to one issue, comment, doc or project. Use list_issue_attachments for an issue, since that one also covers files attached to its comments. This is for docs and projects.

List the sprints of this workspace in number order.

Return the folders documents can be filed under, with how many documents each holds.

Return the comment thread on a document, oldest first.

List the documents this user can read, in the order they sit in the sidebar, or by relevance when you pass a query. Filter by a project, by a collection, or to the documents in no collection at all.

Every repository the GitHub App is installed on for this workspace, with the projects each one is associated with. A repository associated with no project is watched at workspace level. Pull requests are matched to issues by the issue identifier in the branch name, title or description, not by which project a repository belongs to, so associations here are for organising the workspace rather than for routing.

Read immutable notification events newest first for one of your currently accessible conversations. Use the returned cursor for older updates.

Your inbox grouped into one conversation per pull request, document, or issue activity family. Filters run before pagination. Cursors describe a live feed: fetch a fresh first page to reconcile conversations moved by new activity. Counts are unread conversations, not events.

Every file attached to an issue or to a comment on it, oldest first. Call this before you answer a thread that refers to a document, a screenshot or an export, so you work from what was actually attached rather than guessing from the filename.

Return the comment thread on an issue, oldest first. Read this before replying, so you answer what was actually asked and do not repeat a reply you already posted.

The pull requests Orbit has linked to an issue, with the branch each one is on. A link is created when a pull request names the issue identifier in its branch name, title or description, so copy_branch_name produces a branch that links itself. Requires only the permission to read the issue, matching what the issue page itself shows.

List the labels available in the workspace, optionally narrowed to the ones a team can use.

List workspace membership with each person role, which is what decides what they may do.

List the milestones on a project in order.

List issues assigned to the caller or awaiting their review, most recently updated first. Narrow with a state category such as "started" to see only work in flight.

Your inbox: mentions, assignments, replies and state changes addressed to you. This is how you find work someone has handed you by name. Orbit never notifies you about your own actions, so nothing here was written by you.

Return the milestones on a project with their target dates.

List the projects in the workspace with their status and health.

List the workflow states of one team, in board order. Use a state name from this list when creating or moving an issue.

List the teams in the workspace that the caller can see. Each team has a key such as "ENG" that prefixes its issue identifiers.

List the people in the workspace. Use a name, handle or email from this list wherever a tool asks for a user.

Return the saved issue views this user can open, each with the filter state it stores. Copy that shape when creating or updating a view.

Mark your own conversations read or manually unread. This updates every active event compatibly and returns authoritative conversation counters. Do not mark work read until acted on or handed on.

Mark an issue as a duplicate of another issue. Moves the duplicate issue to the team canceled state, records the duplicate_of relation, and transfers subscribers to the survivor issue.

Mark your own notifications read once you have acted on them, so they leave your unread queue. Mark a notification read only after the work it describes is done or handed on, never on first sight.

File a document under a collection, nest it under a parent, attach it to a project, or order it against its siblings. One call for what dragging it in the sidebar does.

Move an issue to another workflow state or team, and optionally place it between two issues in the column. This is the tool to use to change status.

Put an issue into a sprint, or pass null to take it out of the sprint it is in. The sprint must belong to the issue team.

Return the issue counts for a project, in total and per milestone, so you can report how far along it is.

Return the contents of a file attached to an issue, a comment, a doc or a project. Text-like files come back as text; anything else comes back base64 encoded. Large files are truncated, and the response says so.

Remove a member from the workspace entirely. Their issues can be reassigned to somebody else in the same call.

Remove a link between two issues. The inverse link on the other issue goes with it, so removing "blocks" also removes "blocked by".

Take a person off a team. They stay in the workspace.

Put the milestones of a project into the order given. The list has to name every milestone on the project exactly once, so read them with list_milestones first.

Set the board order of a team. Name every status on the team exactly once, first column first. Call list_states to see the current order.

Search issues by free text and by team, project, cycle, assignee, participant, state, state category, label or parent. A participant is an assignee or reviewer. Returns a page of issues plus a cursor for the next page.

Link two issues. The inverse link is written on the other issue automatically, so "blocks" also records "blocked by".

Start a sprint that has not begun yet, by pulling its start date to now. A sprint has no separate started flag: it runs whenever the clock sits inside its dates and it has not been completed. The sprint keeps its planned end date, and the team has to have no sprint running.

Bring an archived document back into the sidebar and the default listings.

Bring an archived issue back onto the board.

Remove the association between a repository and a project, or the workspace level association when no project is given. Removing the last association stops Orbit watching the repository, so its events are no longer processed.

Rename a sprint or move its dates.

Change a document title, body, collection, parent, project or visibility. Only the fields you pass are touched. Filing a document under a collection detaches it from any project, and attaching it to a project unfiles it.

Change the name or the icon of a folder.

Change fields on an existing issue. Only the fields you pass are touched. Pass null to assignee, project or cycle to clear it, or an empty reviewers array to clear the reviewer list.

Rename a label, change its colour, or move it between a team and the whole workspace.

Rename a milestone or move its target date.

Change a project name, summary, status, health, lead or target dates. Only the fields you pass are touched.

Rename a status, recolour it, or move it to another category. Changing the category re-derives the started, completed and canceled timestamps of every issue sitting in it.

Rename a team or change its description. The issue prefix cannot change.

Rename a saved view, change its layout or grouping, share it, or replace the filter it stores. Read the view first with list_views and send the whole filter state back, because a filter replaces the stored one rather than merging into it.