get_team_details
Retrieve detailed information for a specific team using its unique identifier within the Webex MCP Server, enabling access to team descriptions and essential data.
Instructions
Get details for a team by ID.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| description | No | The team's description. | |
| teamId | Yes | The unique identifier for the team. |
Implementation Reference
- The handler function `executeFunction` that fetches team details from the Webex API using the provided teamId and optional description parameter.const executeFunction = async ({ teamId, description }) => { try { // Construct the URL with the team ID and query parameters const url = new URL(getWebexUrl(`/teams/${encodeURIComponent(teamId)}`)); if (description) { url.searchParams.append('description', description); } // 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 errorData = await response.json(); throw new Error(JSON.stringify(errorData)); } // Parse and return the response data const data = await response.json(); return data; } catch (error) { console.error('Error getting team details:', error); return { error: 'An error occurred while getting team details.' }; } };
- JSON schema defining the input parameters for the get_team_details tool: required 'teamId' (string) and optional 'description' (string).function: { name: 'get_team_details', description: 'Get details for a team by ID.', parameters: { type: 'object', properties: { teamId: { type: 'string', description: 'The unique identifier for the team.' }, description: { type: 'string', description: 'The team\'s description.' } }, required: ['teamId'] } } }
- The `apiTool` object that bundles the handler function and schema definition, exported for registration in the MCP tools system.const apiTool = { function: executeFunction, definition: { type: 'function', function: { name: 'get_team_details', description: 'Get details for a team by ID.', parameters: { type: 'object', properties: { teamId: { type: 'string', description: 'The unique identifier for the team.' }, description: { type: 'string', description: 'The team\'s description.' } }, required: ['teamId'] } } } };
- tools/paths.js:32-32 (registration)Lists the relative path to the get-team-details tool file in the central toolPaths array, likely used to dynamically load and register tools.'webex-public-workspace/webex-messaging/get-team-details.js',