Module: ThingsMcp::Tools

Defined in:
lib/things_mcp/tools.rb

Overview

MCP tool definitions for Things 3 integration

This module defines all available MCP tools with their schemas, descriptions, and parameter definitions for interaction with Things 3.

Class Method Summary collapse

Class Method Details

.allArray<Hash>

Returns all available MCP tool definitions

Returns:

  • (Array<Hash>)

    Array of tool definition hashes



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/things_mcp/tools.rb', line 13

def all
  [
    # Basic operations
    {
      name: "get-todos",
      description: "Get todos from Things, optionally filtered by project",
      inputSchema: {
        type: "object",
        properties: {
          project_uuid: {
            type: "string",
            description: "Optional UUID of a specific project to get todos from",
          },
          include_items: {
            type: "boolean",
            description: "Include checklist items",
            default: true,
          },
        },
        required: [],
      },
    },
    {
      name: "get-projects",
      description: "Get all projects from Things",
      inputSchema: {
        type: "object",
        properties: {
          include_items: {
            type: "boolean",
            description: "Include tasks within projects",
            default: false,
          },
        },
        required: [],
      },
    },
    {
      name: "get-areas",
      description: "Get all areas from Things",
      inputSchema: {
        type: "object",
        properties: {
          include_items: {
            type: "boolean",
            description: "Include projects and tasks within areas",
            default: false,
          },
        },
        required: [],
      },
    },

    # List views
    {
      name: "get-inbox",
      description: "Get todos from Inbox",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
    {
      name: "get-today",
      description: "Get todos due today",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
    {
      name: "get-upcoming",
      description: "Get upcoming todos",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
    {
      name: "get-anytime",
      description: "Get todos from Anytime list",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
    {
      name: "get-someday",
      description: "Get todos from Someday list",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
    {
      name: "get-logbook",
      description: "Get completed todos from Logbook, defaults to last 7 days",
      inputSchema: {
        type: "object",
        properties: {
          period: {
            type: "string",
            description: "Time period to look back (e.g., '3d', '1w', '2m', '1y'). Defaults to '7d'",
            pattern: '^\\d+[dwmy]$',
          },
          limit: {
            type: "integer",
            description: "Maximum number of entries to return. Defaults to 50",
            minimum: 1,
            maximum: 100,
          },
        },
        required: [],
      },
    },
    {
      name: "get-trash",
      description: "Get trashed todos",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },

    # Tag operations
    {
      name: "get-tags",
      description: "Get all tags",
      inputSchema: {
        type: "object",
        properties: {
          include_items: {
            type: "boolean",
            description: "Include items tagged with each tag",
            default: false,
          },
        },
        required: [],
      },
    },
    {
      name: "get-tagged-items",
      description: "Get items with a specific tag",
      inputSchema: {
        type: "object",
        properties: {
          tag: {
            type: "string",
            description: "Tag title to filter by",
          },
        },
        required: ["tag"],
      },
    },

    # Search operations
    {
      name: "search-todos",
      description: "Search todos by title or notes",
      inputSchema: {
        type: "object",
        properties: {
          query: {
            type: "string",
            description: "Search term to look for in todo titles and notes",
          },
        },
        required: ["query"],
      },
    },
    {
      name: "search-advanced",
      description: "Advanced todo search with multiple filters",
      inputSchema: {
        type: "object",
        properties: {
          status: {
            type: "string",
            enum: ["incomplete", "completed", "canceled"],
            description: "Filter by todo status",
          },
          start_date: {
            type: "string",
            description: "Filter by start date (YYYY-MM-DD)",
          },
          deadline: {
            type: "string",
            description: "Filter by deadline (YYYY-MM-DD)",
          },
          tag: {
            type: "string",
            description: "Filter by tag",
          },
          area: {
            type: "string",
            description: "Filter by area UUID",
          },
          type: {
            type: "string",
            enum: ["to-do", "project", "heading"],
            description: "Filter by item type",
          },
        },
        required: [],
      },
    },

    # Recent items
    {
      name: "get-recent",
      description: "Get recently created items",
      inputSchema: {
        type: "object",
        properties: {
          period: {
            type: "string",
            description: "Time period (e.g., '3d', '1w', '2m', '1y')",
            pattern: '^\\d+[dwmy]$',
          },
        },
        required: ["period"],
      },
    },

    # Things URL Scheme tools
    {
      name: "add-todo",
      description: "Create a new todo in Things",
      inputSchema: {
        type: "object",
        properties: {
          title: {
            type: "string",
            description: "Title of the todo",
          },
          notes: {
            type: "string",
            description: "Notes for the todo",
          },
          when: {
            type: "string",
            description: "When to schedule the todo (today, tomorrow, evening, anytime, someday, or YYYY-MM-DD)",
          },
          deadline: {
            type: "string",
            description: "Deadline for the todo (YYYY-MM-DD)",
          },
          tags: {
            type: "array",
            items: { type: "string" },
            description: "Tags to apply to the todo",
          },
          checklist_items: {
            type: "array",
            items: { type: "string" },
            description: "Checklist items to add",
          },
          list_id: {
            type: "string",
            description: "ID of project/area to add to",
          },
          list_title: {
            type: "string",
            description: "Title of project/area to add to",
          },
          heading: {
            type: "string",
            description: "Heading to add under",
          },
        },
        required: ["title"],
      },
    },
    {
      name: "add-project",
      description: "Create a new project in Things",
      inputSchema: {
        type: "object",
        properties: {
          title: {
            type: "string",
            description: "Title of the project",
          },
          notes: {
            type: "string",
            description: "Notes for the project",
          },
          when: {
            type: "string",
            description: "When to schedule the project",
          },
          deadline: {
            type: "string",
            description: "Deadline for the project",
          },
          tags: {
            type: "array",
            items: { type: "string" },
            description: "Tags to apply to the project",
          },
          area_id: {
            type: "string",
            description: "ID of area to add to",
          },
          area_title: {
            type: "string",
            description: "Title of area to add to",
          },
          todos: {
            type: "array",
            items: { type: "string" },
            description: "Initial todos to create in the project",
          },
        },
        required: ["title"],
      },
    },
    {
      name: "update-todo",
      description: "Update an existing todo in Things",
      inputSchema: {
        type: "object",
        properties: {
          id: {
            type: "string",
            description: "ID of the todo to update",
          },
          title: {
            type: "string",
            description: "New title",
          },
          notes: {
            type: "string",
            description: "New notes",
          },
          when: {
            type: "string",
            description: "New schedule",
          },
          deadline: {
            type: "string",
            description: "New deadline",
          },
          tags: {
            type: "array",
            items: { type: "string" },
            description: "New tags",
          },
          completed: {
            type: "boolean",
            description: "Mark as completed",
          },
          canceled: {
            type: "boolean",
            description: "Mark as canceled",
          },
        },
        required: ["id"],
      },
    },
    {
      name: "update-project",
      description: "Update an existing project in Things",
      inputSchema: {
        type: "object",
        properties: {
          id: {
            type: "string",
            description: "ID of the project to update",
          },
          title: {
            type: "string",
            description: "New title",
          },
          notes: {
            type: "string",
            description: "New notes",
          },
          when: {
            type: "string",
            description: "New schedule",
          },
          deadline: {
            type: "string",
            description: "New deadline",
          },
          tags: {
            type: "array",
            items: { type: "string" },
            description: "New tags",
          },
          completed: {
            type: "boolean",
            description: "Mark as completed",
          },
          canceled: {
            type: "boolean",
            description: "Mark as canceled",
          },
        },
        required: ["id"],
      },
    },
    {
      name: "search-items",
      description: "Search for items in Things",
      inputSchema: {
        type: "object",
        properties: {
          query: {
            type: "string",
            description: "Search query",
          },
        },
        required: ["query"],
      },
    },
    {
      name: "show-item",
      description: "Show a specific item or list in Things",
      inputSchema: {
        type: "object",
        properties: {
          id: {
            type: "string",
            description: "ID of item to show, or one of: inbox, today, upcoming, anytime, someday, logbook",
          },
          query: {
            type: "string",
            description: "Optional query to filter by",
          },
          filter_tags: {
            type: "array",
            items: { type: "string" },
            description: "Optional tags to filter by",
          },
        },
        required: ["id"],
      },
    },
  ]
end