todoist-mcp

Instructions

Implementation Reference

• src/tools/comments.ts:29-39 (registration)

  Registration of the 'get_comments' tool. Configures it as a batch handler for GET requests to Todoist API endpoint '/comments/{id}', with input schema requiring 'id' field.

  createBatchApiHandler({
      name: 'get_comments',
      description: 'Get comments from Todoist by ID',
      itemSchema: {
          id: z.string(),
      },
      method: 'GET',
      path: '/comments/{id}',
      mode: 'read',
      idField: 'id',
  });

• src/tools/comments.ts:32-34 (schema)

  Zod schema definition for tool input: batch of items each requiring a string 'id' (comment ID).

  itemSchema: {
      id: z.string(),
  },

• src/utils/handlers.ts:201-353 (handler)

  Core handler logic for batch API tools like 'get_comments'. For read mode with idField, it validates ID, constructs path by replacing {id}, removes id from params, calls todoistApi.get(path, params), and returns structured result with success flag.

  const handler = async (args: z.infer<typeof batchSchema>): Promise<any> => {
      const { items } = args;
  
      // For modes other than create, check if name lookup is needed
      let allItems: any[] = [];
  
      const needsNameLookup =
          options.mode !== 'create' &&
          options.nameField &&
          options.findByName &&
          items.some(item => item[options.nameField!] && !item[options.idField!]);
  
      if (needsNameLookup) {
          // Determine the base path for fetching all items
          // Example: /tasks from /tasks/{id}
          const lookupPath =
              options.basePath || (options.path ? options.path.split('/{')[0] : '');
          allItems = await todoistApi.get(lookupPath, {});
      }
  
      const results = await Promise.all(
          items.map(async item => {
              if (options.validateItem) {
                  const validation = options.validateItem(item);
  
                  if (!validation.valid) {
                      return {
                          success: false,
                          error: validation.error || 'Validation failed',
                          item,
                      };
                  }
              }
  
              try {
                  let finalPath = '';
                  const apiParams = { ...item };
  
                  // For modes where need id
                  if (options.mode !== 'create' && options.idField) {
                      let itemId = item[options.idField];
                      let matchedName = null;
                      let matchedContent = null;
  
                      // If no ID but name is provided, search by name
                      if (!itemId && item[options.nameField!] && options.findByName) {
                          const searchName = item[options.nameField!];
                          const matchedItem = options.findByName(searchName, allItems);
  
                          if (!matchedItem) {
                              return {
                                  success: false,
                                  error: `Item not found with name: ${searchName}`,
                                  item,
                              };
                          }
  
                          itemId = matchedItem.id;
                          matchedName = searchName;
                          matchedContent = matchedItem.content;
                      }
  
                      if (!itemId) {
                          return {
                              success: false,
                              error: `Either ${options.idField} or ${options.nameField} must be provided`,
                              item,
                          };
                      }
  
                      // Apply security validation to itemId before using in path
                      const safeItemId = validatePathParameter(itemId, options.idField || 'id');
  
                      if (options.basePath && options.pathSuffix) {
                          finalPath = `${options.basePath}${options.pathSuffix.replace('{id}', safeItemId)}`;
                      } else if (options.path) {
                          finalPath = options.path.replace('{id}', safeItemId);
                      }
  
                      delete apiParams[options.idField];
                      if (options.nameField) {
                          delete apiParams[options.nameField];
                      }
  
                      let result;
                      switch (options.method) {
                          case 'GET':
                              result = await todoistApi.get(finalPath, apiParams);
                              break;
                          case 'POST':
                              result = await todoistApi.post(finalPath, apiParams);
                              break;
                          case 'DELETE':
                              result = await todoistApi.delete(finalPath);
                              break;
                      }
  
                      const response: any = {
                          success: true,
                          id: itemId,
                          result,
                      };
  
                      if (matchedName) {
                          response.found_by_name = matchedName;
                          response.matched_content = matchedContent;
                      }
  
                      return response;
                  }
                  // Create mode
                  else {
                      finalPath = options.path || options.basePath || '';
  
                      let result;
                      switch (options.method) {
                          case 'GET':
                              result = await todoistApi.get(finalPath, apiParams);
                              break;
                          case 'POST':
                              result = await todoistApi.post(finalPath, apiParams);
                              break;
                          case 'DELETE':
                              result = await todoistApi.delete(finalPath);
                              break;
                      }
  
                      return {
                          success: true,
                          created_item: result,
                      };
                  }
              } catch (error) {
                  return {
                      success: false,
                      error: error instanceof Error ? error.message : String(error),
                      item,
                  };
              }
          })
      );
  
      const successCount = results.filter(r => r.success).length;
      return {
          success: successCount === items.length,
          summary: {
              total: items.length,
              succeeded: successCount,
              failed: items.length - successCount,
          },
          results,
      };
  };

• src/utils/TodoistClient.ts:51-74 (helper)

  Implements the HTTP GET request to Todoist REST API v2. Called with endpoint '/comments/{id}' to fetch the specific comment.

  async get(endpoint: string, params: Record<string, string> = {}): Promise<any> {
      let url = `${API_BASE_URL}${endpoint}`;
  
      const queryParams = new URLSearchParams();
      for (const [key, value] of Object.entries(params)) {
          if (value) {
              queryParams.append(key, value);
          }
      }
  
      const queryString = queryParams.toString();
      if (queryString) {
          url += `?${queryString}`;
      }
  
      log(`Making GET request to: ${url}`);
  
      const response = await fetch(url, {
          method: 'GET',
          headers: this.getHeaders(),
      });
  
      return this.handleResponse(response);
  }