Teamwork MCP

Instructions

Implementation Reference

• src/tools/people/getPeople.ts:92-135 (handler)

  Handler function that executes the getPeople tool logic: logs input, calls teamworkService.getPeople, handles response by JSON stringifying it or error handling.
  export async function handleGetPeople(input: any) { logger.info('=== getPeople tool called ==='); logger.info(`Query parameters: ${JSON.stringify(input || {})}`); try { logger.info('Calling teamworkService.getPeople()'); const people = await teamworkService.getPeople(input); // Debug the response logger.info(`People response type: ${typeof people}`); if (people === null || people === undefined) { logger.warn('People response is null or undefined'); return { content: [{ type: "text", text: "No people found or API returned empty response." }] }; } try { const jsonString = JSON.stringify(people, null, 2); logger.info(`Successfully stringified people response`); logger.info('=== getPeople tool completed successfully ==='); return { content: [{ type: "text", text: jsonString }] }; } catch (jsonError: any) { logger.error(`JSON stringify error: ${jsonError.message}`); return { content: [{ type: "text", text: `Error formatting response: ${jsonError.message}` }] }; } } catch (error: any) { return createErrorResponse(error, 'Retrieving people'); } }
• src/tools/people/getPeople.ts:11-89 (schema)

  Tool definition including name, description, inputSchema with parameters for filtering people, and annotations.
  export const getPeopleDefinition = { name: "getPeople", description: "Get all people from Teamwork", inputSchema: { type: "object", properties: { userType: { type: "string", enum: ["account", "collaborator", "contact"], description: "Filter by user type" }, updatedAfter: { type: "string", description: "Filter by users updated after this date-time (format: ISO 8601)" }, searchTerm: { type: "string", description: "Filter by name or email" }, orderMode: { type: "string", enum: ["asc", "desc"], description: "Order mode" }, orderBy: { type: "string", enum: ["name", "namecaseinsensitive", "company"], description: "Order by field" }, lastLoginAfter: { type: "string", description: "Filter by users who logged in after this date-time" }, pageSize: { type: "integer", description: "Number of items per page" }, page: { type: "integer", description: "Page number" }, includeCollaborators: { type: "boolean", description: "Include collaborator users" }, includeClients: { type: "boolean", description: "Include client users" }, teamIds: { type: "array", items: { type: "integer" }, description: "Filter by team IDs" }, projectIds: { type: "array", items: { type: "integer" }, description: "Filter by project IDs" }, companyIds: { type: "array", items: { type: "integer" }, description: "Filter by company IDs" } } }, annotations: { title: "Get People", readOnlyHint: false, destructiveHint: false, openWorldHint: false } };
• src/tools/index.ts:83-83 (registration)

  Registration of the getPeople tool in the toolPairs array, associating definition and handler.
  { definition: getPeople, handler: handleGetPeople },
• src/tools/index.ts:30-30 (registration)

  Import of getPeopleDefinition (as getPeople) and handleGetPeople from the people tool file.
  import { getPeopleDefinition as getPeople, handleGetPeople } from './people/getPeople.js';
• src/services/people/getPeople.ts:48-60 (helper)

  Business logic helper function that makes the API call to Teamwork /people.json endpoint, used by the tool handler via teamworkService.
  export const getPeople = async (params?: PeopleQueryParams) => { try { logger.info('Fetching people from Teamwork API'); const api = ensureApiClient(); const response = await api.get('/people.json', { params }); logger.info('Successfully fetched people'); return response.data; } catch (error: any) { logger.error(`Teamwork API error: ${error.message}`); throw new Error('Failed to fetch people from Teamwork API'); } };