@themkn/clockify-mcp 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +41 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -7,6 +7,24 @@ An [MCP server](https://modelcontextprotocol.io) for
7
7
  time entries, projects, tasks, tags, and clients — directly from
8
8
  [Claude Code](https://docs.anthropic.com/en/docs/claude-code) or any MCP-compatible client.
9
9
 
10
+ ## What is Clockify?
11
+
12
+ [Clockify](https://clockify.me) is a free time tracking tool used by
13
+ freelancers and teams to log work hours, generate reports, and manage projects.
14
+ It works across web, desktop, and mobile — and its generous free tier covers
15
+ unlimited users and tracking. This MCP server lets you control Clockify with
16
+ natural language through Claude, so you never have to leave your terminal.
17
+
18
+ ## Prerequisites
19
+
20
+ - **A Clockify account** — [sign up for free](https://app.clockify.me/signup)
21
+ (the free plan is all you need)
22
+ - **A personal API key** — once logged in, go to
23
+ *Profile settings → API → Generate*
24
+ - **Your workspace ID** — visible in the Clockify URL after selecting a
25
+ workspace (e.g. `app.clockify.me/workspaces/<id>/...`)
26
+ - **Node.js 24+**
27
+
10
28
  ## Install
11
29
 
12
30
  ```sh
@@ -34,10 +52,9 @@ EOF
34
52
  chmod 600 ~/.clockify-mcp/config.json
35
53
  ```
36
54
 
37
- - **Get an API key:** in Clockify, open *Profile settings → API → Generate*.
38
- - **Workspace id:** visible in the Clockify URL once you select a workspace.
39
-
40
- The server will refuse to start if the config file is group- or world-readable.
55
+ Paste the API key and workspace ID from the [prerequisites](#prerequisites)
56
+ above. The server will refuse to start if the config file is group- or
57
+ world-readable.
41
58
 
42
59
  ## Hook into Claude Code
43
60
 
@@ -93,6 +110,26 @@ Notes:
93
110
  project has time entries, the server archives it instead. The response
94
111
  reports `{ "action": "deleted" }` or `{ "action": "archived" }`.
95
112
 
113
+ ## Example prompts
114
+
115
+ Once the server is running, try asking Claude things like:
116
+
117
+ | Prompt | What happens |
118
+ | ------ | ------------ |
119
+ | "Start a timer for the standup meeting" | Starts a running timer with that description |
120
+ | "Stop my timer" | Stops the currently running timer |
121
+ | "How many hours did I log this week?" | Lists recent time entries and totals them |
122
+ | "Log 2 hours yesterday for the Website Redesign project" | Creates a time entry on the right project |
123
+ | "Create a project called 'Brand Refresh' for client Acme" | Creates a new project linked to an existing client |
124
+ | "Show me all time entries from last Monday" | Fetches entries filtered by date |
125
+ | "Tag my last time entry with 'billable'" | Updates the most recent entry with a tag |
126
+ | "Delete the 'test-cleanup' tag" | Removes a tag by name |
127
+ | "What projects do we have?" | Lists all projects in the workspace |
128
+ | "Am I tracking time right now?" | Checks for a running timer |
129
+
130
+ Claude handles the translation from natural language to API calls — you just
131
+ describe what you want in plain English.
132
+
96
133
  ## Security
97
134
 
98
135
  - The API key in `~/.clockify-mcp/config.json` grants **full access** to your
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@themkn/clockify-mcp",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "MCP server for managing Clockify time tracking — start/stop timers, CRUD time entries, projects, tasks, tags, and clients via Claude Code or any MCP client.",
5
5
  "keywords": [
6
6
  "mcp",
@@ -17,7 +17,7 @@
17
17
  "license": "MIT",
18
18
  "type": "module",
19
19
  "bin": {
20
- "clockify-mcp": "./dist/index.js"
20
+ "clockify-mcp": "dist/index.js"
21
21
  },
22
22
  "main": "./dist/index.js",
23
23
  "files": [