list_rooms
Retrieve and filter rooms or spaces in Webex by team, type, public status, or time range. Use this tool to organize and manage access to collaborative spaces.
Instructions
List rooms for the authenticated user in Webex.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | Filters rooms made public after this time. | |
| max | No | The maximum number of rooms to return. | |
| orgPublicSpaces | No | Whether to show the org's public spaces. Cannot be used with type parameter. | |
| sortBy | No | The field to sort the results by. | |
| teamId | No | The ID of the team to list rooms for (optional - if not provided, lists all accessible rooms). | |
| to | No | Filters rooms made public before this time. | |
| type | No | The type of rooms to list. Cannot be used with orgPublicSpaces parameter. |
Implementation Reference
- The main handler function that executes the list_rooms tool by making a GET request to the Webex /rooms API endpoint with optional query parameters for filtering and pagination.const executeFunction = async ({ teamId, type, orgPublicSpaces, from, to, sortBy = 'id', max = 100 }) => { try { // Construct the URL with query parameters const url = new URL(getWebexUrl('/rooms')); if (teamId) url.searchParams.append('teamId', teamId); // Note: 'type' and 'orgPublicSpaces' cannot be used together according to Webex API if (type) { url.searchParams.append('type', type); } else if (orgPublicSpaces !== undefined) { url.searchParams.append('orgPublicSpaces', orgPublicSpaces.toString()); } if (from) url.searchParams.append('from', from); if (to) url.searchParams.append('to', to); url.searchParams.append('sortBy', sortBy); url.searchParams.append('max', max.toString()); // Set up headers for the request const headers = getWebexHeaders(); // Perform the fetch request const response = await fetch(url.toString(), { method: 'GET', headers }); // Check if the response was successful if (!response.ok) { const errorText = await response.text(); let errorMessage = `HTTP ${response.status}: ${response.statusText}`; try { const errorData = JSON.parse(errorText); errorMessage = errorData.message || errorData.error || JSON.stringify(errorData); } catch (e) { errorMessage = errorText || errorMessage; } throw new Error(errorMessage); } // Parse and return the response data const data = await response.json(); return data; } catch (error) { console.error('Error listing rooms:', error); return { error: 'An error occurred while listing rooms.' }; } };
- The MCP tool schema definition including name, description, and input parameters schema for the list_rooms tool.definition: { type: 'function', function: { name: 'list_rooms', description: 'List rooms for the authenticated user in Webex.', parameters: { type: 'object', properties: { teamId: { type: 'string', description: 'The ID of the team to list rooms for (optional - if not provided, lists all accessible rooms).' }, type: { type: 'string', enum: ['group', 'direct'], description: 'The type of rooms to list. Cannot be used with orgPublicSpaces parameter.' }, orgPublicSpaces: { type: 'boolean', description: 'Whether to show the org\'s public spaces. Cannot be used with type parameter.' }, from: { type: 'string', description: 'Filters rooms made public after this time.' }, to: { type: 'string', description: 'Filters rooms made public before this time.' }, sortBy: { type: 'string', description: 'The field to sort the results by.' }, max: { type: 'integer', description: 'The maximum number of rooms to return.' } }, required: [] } } }
- tools/paths.js:49-49 (registration)The file path for the list_rooms tool is listed in the toolPaths array, which is used for dynamic tool discovery and registration in the MCP server.'webex-public-workspace/webex-messaging/list-rooms.js',