get_workspaces_basic_info
Read-only
Retrieve essential workspace details from Carbon Voice to access conversations and voice memos.
Instructions
Get basic information about a workspace.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/server.ts:815-826 (handler)Handler function that executes the tool logic by calling the generated simplified API method getAllWorkspacesWithBasicInfo with authentication header and formats the result.
async (params: unknown, { authInfo }): Promise<McpToolResponse> => { try { return formatToMCPToolResponse( await simplifiedApi.getAllWorkspacesWithBasicInfo( setCarbonVoiceAuthHeader(authInfo?.token), ), ); } catch (error) { logger.error('Error getting workspaces basic info:', { error }); return formatToMCPToolResponse(error); } }, - src/server.ts:805-827 (registration)Registration of the MCP tool 'get_workspaces_basic_info' with empty input schema and read-only annotation, including the inline handler.
server.registerTool( 'get_workspaces_basic_info', { description: 'Get basic information about a workspace.', inputSchema: z.object({}).shape, annotations: { readOnlyHint: true, destructiveHint: false, }, }, async (params: unknown, { authInfo }): Promise<McpToolResponse> => { try { return formatToMCPToolResponse( await simplifiedApi.getAllWorkspacesWithBasicInfo( setCarbonVoiceAuthHeader(authInfo?.token), ), ); } catch (error) { logger.error('Error getting workspaces basic info:', { error }); return formatToMCPToolResponse(error); } }, ); - Generated helper function in the simplified API client that performs the HTTP GET request to retrieve basic workspace information.
const getAllWorkspacesWithBasicInfo = ( options?: SecondParameter<typeof mutator>, ) => { return mutator<WorkspaceBasicInfo[]>( { url: `/simplified/workspaces/basic-info`, method: 'GET' }, options, ); }; - TypeScript type definition for the output of the getAllWorkspacesWithBasicInfo API call, used for type safety.
export type GetAllWorkspacesWithBasicInfoResult = NonNullable< Awaited< ReturnType< ReturnType< typeof getCarbonVoiceSimplifiedAPI >['getAllWorkspacesWithBasicInfo'] > > >;