Teamwork MCP

Instructions

Implementation Reference

• src/tools/time/getTime.ts:7-133 (schema)

  MCP tool schema definition for 'getTime' including detailed inputSchema with all parameters and annotations.
  export const getTimeDefinition = { name: "getTime", description: "Get all time entries. Return all logged time entries for all projects. Only the time entries that the logged-in user can access will be returned.", inputSchema: { type: 'object', properties: { updatedAfter: { type: 'string', description: 'filter by updated after date' }, startDate: { type: 'string', description: 'filter by a starting date' }, reportFormat: { type: 'string', description: 'define the format of the report' }, projectStatus: { type: 'string', description: 'filter by project status', enum: [ 'active', 'current', 'late', 'upcoming', 'completed', 'deleted' ] }, orderMode: { type: 'string', description: 'order mode', enum: [ 'asc', 'desc' ] }, orderBy: { type: 'string', description: 'sort order', enum: [ 'company', 'date', 'dateupdated', 'project', 'task', 'tasklist', 'user', 'description', 'billed', 'billable', 'timespent' ] }, invoicedType: { type: 'string', description: 'filter by invoiced type', enum: [ 'all', 'invoiced', 'noninvoiced' ] }, endDate: { type: 'string', description: 'filter by an ending date' }, billableType: { type: 'string', description: 'filter by billable type', enum: [ 'all', 'billable', 'non-billable' ] }, updatedBy: { type: 'integer', description: 'filter by the user who updated the timelog' }, ticketId: { type: 'integer', description: 'filter by ticket id' }, tasklistId: { type: 'integer', description: 'filter by tasklist id' }, taskId: { type: 'integer', description: 'filter by task id (deprecated, use taskIds)' }, projectId: { type: 'integer', description: 'filter by project id (deprecated, use projectIds)' }, pageSize: { type: 'integer', description: 'number of items in a page' }, page: { type: 'integer', description: 'page number' }, invoiceId: { type: 'integer', description: 'filter by invoice id' }, budgetId: { type: 'integer', description: 'filter by budget id' }, allocationId: { type: 'integer', description: 'filter by allocation id' } }, required: [] }, annotations: { title: "Get Time Entries", readOnlyHint: false, destructiveHint: false, openWorldHint: false } };
• src/tools/time/getTime.ts:135-159 (handler)

  The handler function that executes the getTime tool logic, calling the service and returning formatted response or error.
  /** * Handler for getting all time entries */ export async function handleGetTime(input: any) { try { logger.info('Handling getTime tool request'); const response = await getTimeService(input); logger.info('Successfully handled getTime request'); return { content: [{ type: "text", text: JSON.stringify(response, null, 2) }] }; } catch (error: any) { logger.error(`Error in getTime handler: ${error.message}`); return { content: [{ type: "text", text: `Error: ${error.message}` }] }; } }
• src/tools/index.ts:97-97 (registration)

  Registration of the getTime tool in the toolPairs array, pairing definition and handler.
  { definition: getTime, handler: handleGetTime },
• src/services/time/getTime.ts:73-88 (helper)

  Core service implementation that performs the actual API call to fetch time entries.
  export const getTime = async (params: GetTimeParams = {}) => { try { logger.info('Fetching time entries from Teamwork'); const api = getApiClientForVersion('v3'); logger.info('Making API request to get time entries'); const response = await api.get('/time.json', { params }); logger.info('Successfully retrieved time entries'); return response.data; } catch (error: any) { logger.error(`Failed to get time entries: ${error.message}`); throw new Error(`Failed to get time entries: ${error.message}`); } };
• src/services/time/getTime.ts:4-66 (schema)

  TypeScript interface defining parameters for getTime service, matching the tool's input schema.
  export interface GetTimeParams { updatedAfter?: string; startDate?: string; reportFormat?: string; projectStatus?: 'active' | 'current' | 'late' | 'upcoming' | 'completed' | 'deleted'; orderMode?: 'asc' | 'desc'; orderBy?: 'company' | 'date' | 'dateupdated' | 'project' | 'task' | 'tasklist' | 'user' | 'description' | 'billed' | 'billable' | 'timespent'; invoicedType?: 'all' | 'invoiced' | 'noninvoiced'; endDate?: string; billableType?: 'all' | 'billable' | 'non-billable'; updatedBy?: number; ticketId?: number; tasklistId?: number; taskId?: number; projectId?: number; pageSize?: number; page?: number; invoiceId?: number; budgetId?: number; allocationId?: number; useFallbackMethod?: boolean; unattachedTimelogs?: boolean; skipCounts?: boolean; showDeleted?: boolean; returnCostInfo?: boolean; returnBillableInfo?: boolean; onlyStarredProjects?: boolean; matchAllTaskTags?: boolean; matchAllTags?: boolean; matchAllProjectTags?: boolean; isReportDownload?: boolean; includeTotals?: boolean; includePermissions?: boolean; includeDescendants?: boolean; includeArchivedProjects?: boolean; taskTagIds?: number[]; taskStatuses?: string[]; taskIds?: number[]; tagIds?: number[]; selectedColumns?: string[]; projectsFromCompanyId?: number[]; projectTagIds?: number[]; projectStatuses?: string[]; projectOwnerIds?: number[]; projectIds?: number[]; projectHealths?: number[]; projectCompanyIds?: number[]; projectCategoryIds?: number[]; include?: string[]; ids?: number[]; 'fields[users]'?: string[]; 'fields[timelogs]'?: string[]; 'fields[tasks]'?: string[]; 'fields[tasklists]'?: string[]; 'fields[tags]'?: string[]; 'fields[projects]'?: string[]; 'fields[projectcategories]'?: string[]; 'fields[companies]'?: string[]; assignedToUserIds?: number[]; assignedToTeamIds?: number[]; assignedToCompanyIds?: number[]; assignedTeamIds?: number[]; }