Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/update_sdk_methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,9 @@ def check_for_unused_methods(methods, type):
## deliberately NOT ignored here -- the whole OAuth-apps family needs a
## domain-owner decision on document-vs-ignore before we suppress the
## warning; see the #5188/#5276 discussion.)
if lang == "python" and method not in ["from_robot", "close", "get_resource_name", "get_geometries", "do_command", "proto", "transform", "updated_fields", "ListUUIDs", "GetTransform", "StreamTransformChanges", "DoCommand", "GetStatus", "upload_device_push_token", "get_device_push_tokens", "delete_device_push_token", "set_firebase_config", "get_firebase_config", "delete_firebase_config"] or \
## Favorite machines belong to a signed-in user, and the Python app client can only
## authenticate with an API key, so these methods can't work for typical callers.
if lang == "python" and method not in ["from_robot", "close", "get_resource_name", "get_geometries", "do_command", "proto", "transform", "updated_fields", "ListUUIDs", "GetTransform", "StreamTransformChanges", "DoCommand", "GetStatus", "upload_device_push_token", "get_device_push_tokens", "delete_device_push_token", "set_firebase_config", "get_firebase_config", "delete_firebase_config", "add_favorite_machine", "remove_favorite_machine", "list_favorite_machines"] or \
lang == "go" and method not in ["Reconfigure", "ListTunnels", "Close", "DoCommand", "CurrentPosition", "AddTagsToBinaryDataByFilter", "RemoveTagsFromBinaryDataByFilter", "CurrentInputs", "GoToInputs"] or \
lang == "flutter" and method not in ["getResources", "getStream", "getStreamOptions", "resetStreamOptions", "setStreamOptions", "Discovery.fromProto", "addCallbacks", "getResource", "RobotClient.withClient"] or \
lang == "typescript" and method not in ["connect", "disconnect", "dial", "isConnected", "discoverComponents", "createServiceClient", "getRoverRentalRobots", "doCommand"]:
Expand Down
14 changes: 14 additions & 0 deletions docs/monitor/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@ The machines table shows every machine in your organization with its current sta

To see how much binary and tabular data your fleet has synced in the last 48 hours, organization owners can open the **Data usage** tab of the billing page. See [Check data usage](/organization/billing/#check-data-usage).

### Favorite machines

Set the machines you check most often as favorites so you can find them quickly.
Use the star next to a machine in the table to favorite it.
By default, favorite machines appear at the top of the table.
To turn this on or off, click the star in the table header.
You can see your favorites from every organization on the **Machine Favorites** tab in your user settings.

Favorites belong to your user account, so other members of your organization can't see them.
A machine that is deleted, or that you can no longer access, is hidden from your favorites.
If you regain access, it reappears.

To manage favorites from an AI agent, use the `list_favorite_machines`, `add_favorite_machine`, and `remove_favorite_machine` tools in the [Viam MCP server](/reference/mcp/).

## Inspect a specific machine

Click a machine name to open its page.
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/mcp/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Tools fall into seven groups, reflected in the **Category** column below:

The fragment tools (`create_fragment`, `add_fragment_config_item`, `update_fragment_config_item`, and `delete_fragment_config_item`) change fragments. If a fragment is public or unlisted, users outside your organization can see and use its configuration, including your changes.

The favorite machine tools (`list_favorite_machines`, `add_favorite_machine`, and `remove_favorite_machine`) read and change your own [machine favorites](/monitor/monitor/#favorite-machines), which no one else in your organization sees. `remove_favorite_machine` is marked destructive because it deletes a favorite, but it never changes the machine itself.

## Tools

{{< readfile "/static/include/app/mcpserver/generated/mcp-tools-table.md" >}}
3 changes: 3 additions & 0 deletions static/include/app/mcpserver/generated/mcp-tools-table.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
| Tool | Category |
| ---- | -------- |
| `get_registry_item_information` | Read-only |
| `list_favorite_machines` | Read-only |
| `list_machines` | Read-only |
| `list_organization_locations` | Read-only |
| `list_organizations` | Read-only |
Expand All @@ -14,12 +15,14 @@
| `read_machine_logs` | Read (billable) |
| `get_world_state` | Live machine (read-only) |
| `read_machine_api` | Live machine (read-only) |
| `add_favorite_machine` | Write |
| `add_fragment_config_item` | Write |
| `add_machine_config_item` | Write |
| `create_fragment` | Write |
| `create_machine` | Write |
| `delete_fragment_config_item` | Write (destructive) |
| `delete_machine_config_item` | Write (destructive) |
| `remove_favorite_machine` | Write (destructive) |
| `update_fragment_config_item` | Write (destructive) |
| `update_machine_config_item` | Write (destructive) |
| `call_machine_api` | Live machine (destructive) |
Expand Down
Loading