Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| PORT | No | The port on which the server will run | 3000 |
| NODE_ENV | No | The environment (development, production, test) | |
| LOG_LEVEL | No | Logging level (info, error, debug) | |
| TEAMWORK_DOMAIN | No | Your Teamwork domain name (e.g., 'your-company' for https://your-company.teamwork.com) | |
| TEAMWORK_PASSWORD | No | Your Teamwork password | |
| TEAMWORK_USERNAME | No | Your Teamwork username (email) |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| getProjects | Get all projects from Teamwork |
| getCurrentProject | Get the current solution's Teamwork project, check the |
| createProject | Create a new project in Teamwork |
| getTasks | Get all tasks from Teamwork |
| getTasksByProjectId | Get all tasks from a specific project in Teamwork |
| getTaskListsByProjectId | Get all task lists by project ID |
| getTaskById | Get a specific task by ID from Teamwork |
| createTask | Creates a task. Create a new task in the provided task list. |
| createSubTask | Creates a subtask. Create a new subtask under the provided parent task. |
| updateTask | Update an existing task. Modify the properties of an existing task. |
| deleteTask | Delete a task from Teamwork |
| getTasksMetricsComplete | Get the total count of completed tasks in Teamwork |
| getTasksMetricsLate | Get the total count of late tasks in Teamwork |
| getTaskSubtasks | Get all subtasks for a specific task in Teamwork |
| getTaskComments | Get comments for a specific task from Teamwork |
| createComment | Creates a new comment for a specific resource (tasks, milestones, notebooks, links, fileversions) in Teamwork |
| getPeople | Get all people from Teamwork |
| getPersonById | Get a specific person by ID from Teamwork |
| getProjectPeople | Get all people assigned to a specific project from Teamwork |
| addPeopleToProject | Add people to a specific project in Teamwork |
| deletePerson | Delete a person from Teamwork |
| updatePerson | Update a person in Teamwork. This endpoint allows you to modify user information like timezone, name, email, etc. |
| createCompany | Create a new company. AI INSTRUCTIONS: This endpoint allows you to create_projects_api_v3_companies.json resources. The request requires a companyRequest object with various properties like addressOne, emailOne, name, and tags. |
| updateCompany | Update an existing company. AI INSTRUCTIONS: This endpoint allows you to update_projects_api_v3_companies_{companyid}.json resources. It requires parameters: companyId and companyRequest. |
| deleteCompany | Delete an existing company. AI INSTRUCTIONS: This endpoint allows you to delete_projects_api_v3_companies_{companyid}.json resources. It requires the following parameters: companyId. |
| getCompanies | Get all companies. Retrieve all companies for the provided filters. This endpoint allows you to filter companies by various parameters including custom fields, tags, search terms, and more. |
| getCompanyById | Get a specific company by ID. Retrieves detailed information about a company identified by its ID. |
| getProjectsPeopleMetricsPerformance | Performance of users completing the most tasks. Count the number of completed tasks by user for the provided period. By default the user with the most completed tasks is shown first. |
| getProjectsPeopleUtilization | Return the user utilization data. This endpoint provides detailed information about user utilization, including billable and non-billable time, availability, and various utilization metrics. |
| getProjectsAllocationsTime | Get time entries for a specific allocation. Return logged time entries for a specific allocation. Only the time entries that the logged-in user can access will be returned. |
| getTime | 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. |
| getProjectPerson | Returns a person on a project. Retrieve a person record. |
| getProjectsReportingUserTaskCompletion | Returns task completions for a given user. Retrieve a person record and its task completion stats. |
| getProjectsReportingUtilization | Generate utilization report in various formats (CSV, HTML, PDF, XLSX). Generates a utilization report containing all people for the provided filters. Only the people that the logged-in user can access will be returned. |
| getTimezones | Get all timezones available in Teamwork. This is useful when you need to update a user's timezone and need to know the available options. |