worklog-mcp 0.1.0__tar.gz
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.
- worklog_mcp-0.1.0/LICENSE +21 -0
- worklog_mcp-0.1.0/PKG-INFO +294 -0
- worklog_mcp-0.1.0/README.md +253 -0
- worklog_mcp-0.1.0/pyproject.toml +123 -0
- worklog_mcp-0.1.0/pyproject.toml.orig +116 -0
- worklog_mcp-0.1.0/src/worklog_mcp/__init__.py +10 -0
- worklog_mcp-0.1.0/src/worklog_mcp/cli.py +111 -0
- worklog_mcp-0.1.0/src/worklog_mcp/logfile.py +492 -0
- worklog_mcp-0.1.0/src/worklog_mcp/py.typed +0 -0
- worklog_mcp-0.1.0/src/worklog_mcp/server.py +162 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Fedor Ratschew
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: worklog-mcp
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: MCP server that appends what you did to the checklist of the newest log file in a directory
|
|
5
|
+
Keywords: mcp,model-context-protocol,worklog,markdown,checklist
|
|
6
|
+
Author: Fedor Ratschew
|
|
7
|
+
Author-email: Fedor Ratschew <feodor.ra@me.com>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
14
|
+
Classifier: Intended Audience :: Information Technology
|
|
15
|
+
Classifier: Natural Language :: English
|
|
16
|
+
Classifier: Natural Language :: Russian
|
|
17
|
+
Classifier: Operating System :: OS Independent
|
|
18
|
+
Classifier: Operating System :: MacOS
|
|
19
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
20
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
21
|
+
Classifier: Programming Language :: Python
|
|
22
|
+
Classifier: Programming Language :: Python :: 3
|
|
23
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
26
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
27
|
+
Classifier: Topic :: Office/Business
|
|
28
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
29
|
+
Classifier: Topic :: Text Editors :: Text Processing
|
|
30
|
+
Classifier: Topic :: Text Processing :: Markup :: Markdown
|
|
31
|
+
Classifier: Topic :: Utilities
|
|
32
|
+
Classifier: Typing :: Typed
|
|
33
|
+
Requires-Dist: mcp~=2.1
|
|
34
|
+
Requires-Dist: typer~=0.27
|
|
35
|
+
Requires-Python: >=3.13
|
|
36
|
+
Project-URL: Homepage, https://feodor-ra.github.io/worklog-mcp/
|
|
37
|
+
Project-URL: Documentation, https://feodor-ra.github.io/worklog-mcp/
|
|
38
|
+
Project-URL: Repository, https://github.com/feodor-ra/worklog-mcp
|
|
39
|
+
Project-URL: Issues, https://github.com/feodor-ra/worklog-mcp/issues
|
|
40
|
+
Description-Content-Type: text/markdown
|
|
41
|
+
|
|
42
|
+
# worklog-mcp
|
|
43
|
+
|
|
44
|
+
๐บ๐ธ **English** ยท ๐ท๐บ [ะ ัััะบะธะน](README.ru.md)
|
|
45
|
+
|
|
46
|
+
[](https://pypi.org/project/worklog-mcp/)
|
|
47
|
+
[](https://pypi.org/project/worklog-mcp/)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
[](https://modelcontextprotocol.io)
|
|
53
|
+
[](https://peps.python.org/pep-0561/)
|
|
54
|
+
|
|
55
|
+
[](https://github.com/feodor-ra/worklog-mcp/actions/workflows/ci.yml)
|
|
56
|
+
[](https://github.com/feodor-ra/worklog-mcp/actions/workflows/docs.yml)
|
|
57
|
+
[](https://coveralls.io/github/feodor-ra/worklog-mcp?branch=main)
|
|
58
|
+
[](https://feodor-ra.github.io/worklog-mcp/)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
[](https://github.com/feodor-ra/worklog-mcp/issues)
|
|
63
|
+
|
|
64
|
+
[](LICENSE)
|
|
65
|
+
|
|
66
|
+
**An MCP server that records finished work in your daily log.** Point it at a directory of log files; it appends one done item to the checklist of the newest one.
|
|
67
|
+
|
|
68
|
+
If you keep a note per day with a checklist of what got done, the assistant that did the work can write the line itself. The directory is configured once, when the server starts, so it never travels through the conversation โ the model sees the file's name and the line it wrote, and nothing else.
|
|
69
|
+
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"mcpServers": {
|
|
73
|
+
"worklog": {
|
|
74
|
+
"command": "worklog-mcp",
|
|
75
|
+
"args": ["serve", "--dir", "/path/to/your/notes"]
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
That is the whole setup. The assistant now has `append` and `check`.
|
|
82
|
+
|
|
83
|
+
## Install
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
uv tool install worklog-mcp
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Requires Python **3.13+**. No editor, vault format or note-taking app is assumed: a log file is any text file with a markdown checklist in it.
|
|
90
|
+
|
|
91
|
+
## Add it to your agent
|
|
92
|
+
|
|
93
|
+
<details open>
|
|
94
|
+
<summary><b>Claude Code</b></summary>
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
claude mcp add worklog -- worklog-mcp serve --dir /path/to/notes
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Add `--scope user` to make it available in every project.
|
|
101
|
+
</details>
|
|
102
|
+
|
|
103
|
+
<details>
|
|
104
|
+
<summary><b>Claude Desktop</b> ยท <code>claude_desktop_config.json</code></summary>
|
|
105
|
+
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"mcpServers": {
|
|
109
|
+
"worklog": {
|
|
110
|
+
"command": "worklog-mcp",
|
|
111
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
</details>
|
|
117
|
+
|
|
118
|
+
<details>
|
|
119
|
+
<summary><b>Cursor</b> ยท <code>~/.cursor/mcp.json</code></summary>
|
|
120
|
+
|
|
121
|
+
```json
|
|
122
|
+
{
|
|
123
|
+
"mcpServers": {
|
|
124
|
+
"worklog": {
|
|
125
|
+
"command": "worklog-mcp",
|
|
126
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
</details>
|
|
132
|
+
|
|
133
|
+
<details>
|
|
134
|
+
<summary><b>VS Code</b> ยท <code>.vscode/mcp.json</code> โ note the <code>servers</code> key</summary>
|
|
135
|
+
|
|
136
|
+
```json
|
|
137
|
+
{
|
|
138
|
+
"servers": {
|
|
139
|
+
"worklog": {
|
|
140
|
+
"type": "stdio",
|
|
141
|
+
"command": "worklog-mcp",
|
|
142
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
</details>
|
|
148
|
+
|
|
149
|
+
<details>
|
|
150
|
+
<summary><b>Windsurf</b> ยท <code>~/.codeium/windsurf/mcp_config.json</code></summary>
|
|
151
|
+
|
|
152
|
+
```json
|
|
153
|
+
{
|
|
154
|
+
"mcpServers": {
|
|
155
|
+
"worklog": {
|
|
156
|
+
"command": "worklog-mcp",
|
|
157
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
```
|
|
162
|
+
</details>
|
|
163
|
+
|
|
164
|
+
<details>
|
|
165
|
+
<summary><b>Zed</b> ยท <code>settings.json</code> โ <code>context_servers</code></summary>
|
|
166
|
+
|
|
167
|
+
```json
|
|
168
|
+
{
|
|
169
|
+
"context_servers": {
|
|
170
|
+
"worklog": {
|
|
171
|
+
"command": "worklog-mcp",
|
|
172
|
+
"args": ["serve", "--dir", "/path/to/notes"],
|
|
173
|
+
"env": {}
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
</details>
|
|
179
|
+
|
|
180
|
+
<details>
|
|
181
|
+
<summary><b>Cline</b> ยท <code>cline_mcp_settings.json</code></summary>
|
|
182
|
+
|
|
183
|
+
```json
|
|
184
|
+
{
|
|
185
|
+
"mcpServers": {
|
|
186
|
+
"worklog": {
|
|
187
|
+
"command": "worklog-mcp",
|
|
188
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
```
|
|
193
|
+
</details>
|
|
194
|
+
|
|
195
|
+
<details>
|
|
196
|
+
<summary><b>Codex CLI</b> ยท <code>~/.codex/config.toml</code></summary>
|
|
197
|
+
|
|
198
|
+
```toml
|
|
199
|
+
[mcp_servers.worklog]
|
|
200
|
+
command = "worklog-mcp"
|
|
201
|
+
args = ["serve", "--dir", "/path/to/notes"]
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Or: `codex mcp add worklog -- worklog-mcp serve --dir /path/to/notes`
|
|
205
|
+
</details>
|
|
206
|
+
|
|
207
|
+
<details>
|
|
208
|
+
<summary><b>Gemini CLI</b> ยท <code>~/.gemini/settings.json</code></summary>
|
|
209
|
+
|
|
210
|
+
```json
|
|
211
|
+
{
|
|
212
|
+
"mcpServers": {
|
|
213
|
+
"worklog": {
|
|
214
|
+
"command": "worklog-mcp",
|
|
215
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
```
|
|
220
|
+
</details>
|
|
221
|
+
|
|
222
|
+
<details>
|
|
223
|
+
<summary><b>OpenCode</b> ยท <code>opencode.json</code></summary>
|
|
224
|
+
|
|
225
|
+
```json
|
|
226
|
+
{
|
|
227
|
+
"mcp": {
|
|
228
|
+
"worklog": {
|
|
229
|
+
"type": "local",
|
|
230
|
+
"command": ["worklog-mcp", "serve", "--dir", "/path/to/notes"]
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
</details>
|
|
236
|
+
|
|
237
|
+
## How to use it
|
|
238
|
+
|
|
239
|
+
**1. Keep the path out of the config file, if you like.** Both options read an environment variable โ `WORKLOG_DIR` and `WORKLOG_FILE_PATTERN` โ so the snippet can carry no path at all:
|
|
240
|
+
|
|
241
|
+
```json
|
|
242
|
+
{
|
|
243
|
+
"mcpServers": {
|
|
244
|
+
"worklog": {
|
|
245
|
+
"command": "worklog-mcp",
|
|
246
|
+
"args": ["serve"],
|
|
247
|
+
"env": { "WORKLOG_DIR": "/path/to/notes" }
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
**2. Narrow down which files count, if the directory holds more than logs.** `--pattern` is a regular expression matched against the file name:
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
worklog-mcp serve --dir ~/notes --pattern '^\d{4}-\d{2}-\d{2}\.md$'
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
Without a pattern, every non-hidden file in the directory is a candidate, and the newest one wins.
|
|
260
|
+
|
|
261
|
+
**3. Check the setup from a terminal** whenever a call reports something missing:
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
worklog-mcp check --dir ~/notes
|
|
265
|
+
# ok: file="2026-09-06.md" items=3
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
Exit codes are `0` ok, `2` no directory, `3` no log file, `4` no checklist.
|
|
269
|
+
|
|
270
|
+
## Why it's cool
|
|
271
|
+
|
|
272
|
+
- **The path stays out of the conversation.** It is a launch argument, read by the local process. Results carry a file name, never a directory.
|
|
273
|
+
- **It never creates a log file.** A missing file or directory is reported and the call stops, so the assistant cannot reorganize your notes. The one thing it does add is a checklist, when today's file has none yet.
|
|
274
|
+
- **Repeating a call is safe.** An item whose text is already in the checklist is not written twice, so a retried workflow does not double a line.
|
|
275
|
+
- **Your formatting survives.** The new item reuses the indent and bullet marker of the checklist's first item, and the file keeps its line endings; the write is atomic, so an editor watching the file never sees it truncated.
|
|
276
|
+
|
|
277
|
+
## Documentation
|
|
278
|
+
|
|
279
|
+
๐ **[Full documentation](https://feodor-ra.github.io/worklog-mcp/)** โ configuration, ready-made client snippets, exactly how the file and the checklist are picked, the tool contracts and an API reference. Available in English and Russian.
|
|
280
|
+
|
|
281
|
+
## License
|
|
282
|
+
|
|
283
|
+
MIT โ see [LICENSE](LICENSE).
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
287
|
+
[](https://github.com/astral-sh/uv)
|
|
288
|
+
[](https://github.com/astral-sh/ruff)
|
|
289
|
+
[](https://github.com/astral-sh/ty)
|
|
290
|
+
[](https://docs.pytest.org)
|
|
291
|
+
[](https://squidfunk.github.io/mkdocs-material/)
|
|
292
|
+
[](https://conventionalcommits.org)
|
|
293
|
+
[](https://semver.org)
|
|
294
|
+
[](https://keepachangelog.com)
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
# worklog-mcp
|
|
2
|
+
|
|
3
|
+
๐บ๐ธ **English** ยท ๐ท๐บ [ะ ัััะบะธะน](README.ru.md)
|
|
4
|
+
|
|
5
|
+
[](https://pypi.org/project/worklog-mcp/)
|
|
6
|
+
[](https://pypi.org/project/worklog-mcp/)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
[](https://modelcontextprotocol.io)
|
|
12
|
+
[](https://peps.python.org/pep-0561/)
|
|
13
|
+
|
|
14
|
+
[](https://github.com/feodor-ra/worklog-mcp/actions/workflows/ci.yml)
|
|
15
|
+
[](https://github.com/feodor-ra/worklog-mcp/actions/workflows/docs.yml)
|
|
16
|
+
[](https://coveralls.io/github/feodor-ra/worklog-mcp?branch=main)
|
|
17
|
+
[](https://feodor-ra.github.io/worklog-mcp/)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
[](https://github.com/feodor-ra/worklog-mcp/issues)
|
|
22
|
+
|
|
23
|
+
[](LICENSE)
|
|
24
|
+
|
|
25
|
+
**An MCP server that records finished work in your daily log.** Point it at a directory of log files; it appends one done item to the checklist of the newest one.
|
|
26
|
+
|
|
27
|
+
If you keep a note per day with a checklist of what got done, the assistant that did the work can write the line itself. The directory is configured once, when the server starts, so it never travels through the conversation โ the model sees the file's name and the line it wrote, and nothing else.
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"mcpServers": {
|
|
32
|
+
"worklog": {
|
|
33
|
+
"command": "worklog-mcp",
|
|
34
|
+
"args": ["serve", "--dir", "/path/to/your/notes"]
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
That is the whole setup. The assistant now has `append` and `check`.
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
uv tool install worklog-mcp
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Requires Python **3.13+**. No editor, vault format or note-taking app is assumed: a log file is any text file with a markdown checklist in it.
|
|
49
|
+
|
|
50
|
+
## Add it to your agent
|
|
51
|
+
|
|
52
|
+
<details open>
|
|
53
|
+
<summary><b>Claude Code</b></summary>
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
claude mcp add worklog -- worklog-mcp serve --dir /path/to/notes
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Add `--scope user` to make it available in every project.
|
|
60
|
+
</details>
|
|
61
|
+
|
|
62
|
+
<details>
|
|
63
|
+
<summary><b>Claude Desktop</b> ยท <code>claude_desktop_config.json</code></summary>
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"mcpServers": {
|
|
68
|
+
"worklog": {
|
|
69
|
+
"command": "worklog-mcp",
|
|
70
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
</details>
|
|
76
|
+
|
|
77
|
+
<details>
|
|
78
|
+
<summary><b>Cursor</b> ยท <code>~/.cursor/mcp.json</code></summary>
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"mcpServers": {
|
|
83
|
+
"worklog": {
|
|
84
|
+
"command": "worklog-mcp",
|
|
85
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
</details>
|
|
91
|
+
|
|
92
|
+
<details>
|
|
93
|
+
<summary><b>VS Code</b> ยท <code>.vscode/mcp.json</code> โ note the <code>servers</code> key</summary>
|
|
94
|
+
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"servers": {
|
|
98
|
+
"worklog": {
|
|
99
|
+
"type": "stdio",
|
|
100
|
+
"command": "worklog-mcp",
|
|
101
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
</details>
|
|
107
|
+
|
|
108
|
+
<details>
|
|
109
|
+
<summary><b>Windsurf</b> ยท <code>~/.codeium/windsurf/mcp_config.json</code></summary>
|
|
110
|
+
|
|
111
|
+
```json
|
|
112
|
+
{
|
|
113
|
+
"mcpServers": {
|
|
114
|
+
"worklog": {
|
|
115
|
+
"command": "worklog-mcp",
|
|
116
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
</details>
|
|
122
|
+
|
|
123
|
+
<details>
|
|
124
|
+
<summary><b>Zed</b> ยท <code>settings.json</code> โ <code>context_servers</code></summary>
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"context_servers": {
|
|
129
|
+
"worklog": {
|
|
130
|
+
"command": "worklog-mcp",
|
|
131
|
+
"args": ["serve", "--dir", "/path/to/notes"],
|
|
132
|
+
"env": {}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
```
|
|
137
|
+
</details>
|
|
138
|
+
|
|
139
|
+
<details>
|
|
140
|
+
<summary><b>Cline</b> ยท <code>cline_mcp_settings.json</code></summary>
|
|
141
|
+
|
|
142
|
+
```json
|
|
143
|
+
{
|
|
144
|
+
"mcpServers": {
|
|
145
|
+
"worklog": {
|
|
146
|
+
"command": "worklog-mcp",
|
|
147
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
</details>
|
|
153
|
+
|
|
154
|
+
<details>
|
|
155
|
+
<summary><b>Codex CLI</b> ยท <code>~/.codex/config.toml</code></summary>
|
|
156
|
+
|
|
157
|
+
```toml
|
|
158
|
+
[mcp_servers.worklog]
|
|
159
|
+
command = "worklog-mcp"
|
|
160
|
+
args = ["serve", "--dir", "/path/to/notes"]
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Or: `codex mcp add worklog -- worklog-mcp serve --dir /path/to/notes`
|
|
164
|
+
</details>
|
|
165
|
+
|
|
166
|
+
<details>
|
|
167
|
+
<summary><b>Gemini CLI</b> ยท <code>~/.gemini/settings.json</code></summary>
|
|
168
|
+
|
|
169
|
+
```json
|
|
170
|
+
{
|
|
171
|
+
"mcpServers": {
|
|
172
|
+
"worklog": {
|
|
173
|
+
"command": "worklog-mcp",
|
|
174
|
+
"args": ["serve", "--dir", "/path/to/notes"]
|
|
175
|
+
}
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
</details>
|
|
180
|
+
|
|
181
|
+
<details>
|
|
182
|
+
<summary><b>OpenCode</b> ยท <code>opencode.json</code></summary>
|
|
183
|
+
|
|
184
|
+
```json
|
|
185
|
+
{
|
|
186
|
+
"mcp": {
|
|
187
|
+
"worklog": {
|
|
188
|
+
"type": "local",
|
|
189
|
+
"command": ["worklog-mcp", "serve", "--dir", "/path/to/notes"]
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
</details>
|
|
195
|
+
|
|
196
|
+
## How to use it
|
|
197
|
+
|
|
198
|
+
**1. Keep the path out of the config file, if you like.** Both options read an environment variable โ `WORKLOG_DIR` and `WORKLOG_FILE_PATTERN` โ so the snippet can carry no path at all:
|
|
199
|
+
|
|
200
|
+
```json
|
|
201
|
+
{
|
|
202
|
+
"mcpServers": {
|
|
203
|
+
"worklog": {
|
|
204
|
+
"command": "worklog-mcp",
|
|
205
|
+
"args": ["serve"],
|
|
206
|
+
"env": { "WORKLOG_DIR": "/path/to/notes" }
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
**2. Narrow down which files count, if the directory holds more than logs.** `--pattern` is a regular expression matched against the file name:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
worklog-mcp serve --dir ~/notes --pattern '^\d{4}-\d{2}-\d{2}\.md$'
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
Without a pattern, every non-hidden file in the directory is a candidate, and the newest one wins.
|
|
219
|
+
|
|
220
|
+
**3. Check the setup from a terminal** whenever a call reports something missing:
|
|
221
|
+
|
|
222
|
+
```bash
|
|
223
|
+
worklog-mcp check --dir ~/notes
|
|
224
|
+
# ok: file="2026-09-06.md" items=3
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
Exit codes are `0` ok, `2` no directory, `3` no log file, `4` no checklist.
|
|
228
|
+
|
|
229
|
+
## Why it's cool
|
|
230
|
+
|
|
231
|
+
- **The path stays out of the conversation.** It is a launch argument, read by the local process. Results carry a file name, never a directory.
|
|
232
|
+
- **It never creates a log file.** A missing file or directory is reported and the call stops, so the assistant cannot reorganize your notes. The one thing it does add is a checklist, when today's file has none yet.
|
|
233
|
+
- **Repeating a call is safe.** An item whose text is already in the checklist is not written twice, so a retried workflow does not double a line.
|
|
234
|
+
- **Your formatting survives.** The new item reuses the indent and bullet marker of the checklist's first item, and the file keeps its line endings; the write is atomic, so an editor watching the file never sees it truncated.
|
|
235
|
+
|
|
236
|
+
## Documentation
|
|
237
|
+
|
|
238
|
+
๐ **[Full documentation](https://feodor-ra.github.io/worklog-mcp/)** โ configuration, ready-made client snippets, exactly how the file and the checklist are picked, the tool contracts and an API reference. Available in English and Russian.
|
|
239
|
+
|
|
240
|
+
## License
|
|
241
|
+
|
|
242
|
+
MIT โ see [LICENSE](LICENSE).
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
[](https://github.com/astral-sh/uv)
|
|
247
|
+
[](https://github.com/astral-sh/ruff)
|
|
248
|
+
[](https://github.com/astral-sh/ty)
|
|
249
|
+
[](https://docs.pytest.org)
|
|
250
|
+
[](https://squidfunk.github.io/mkdocs-material/)
|
|
251
|
+
[](https://conventionalcommits.org)
|
|
252
|
+
[](https://semver.org)
|
|
253
|
+
[](https://keepachangelog.com)
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "worklog-mcp"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "MCP server that appends what you did to the checklist of the newest log file in a directory"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.13"
|
|
7
|
+
license = "MIT"
|
|
8
|
+
license-files = ["LICENSE"]
|
|
9
|
+
keywords = [
|
|
10
|
+
"mcp",
|
|
11
|
+
"model-context-protocol",
|
|
12
|
+
"worklog",
|
|
13
|
+
"markdown",
|
|
14
|
+
"checklist",
|
|
15
|
+
]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 4 - Beta",
|
|
18
|
+
"Environment :: Console",
|
|
19
|
+
"Intended Audience :: Developers",
|
|
20
|
+
"Intended Audience :: End Users/Desktop",
|
|
21
|
+
"Intended Audience :: Information Technology",
|
|
22
|
+
"Natural Language :: English",
|
|
23
|
+
"Natural Language :: Russian",
|
|
24
|
+
"Operating System :: OS Independent",
|
|
25
|
+
"Operating System :: MacOS",
|
|
26
|
+
"Operating System :: Microsoft :: Windows",
|
|
27
|
+
"Operating System :: POSIX :: Linux",
|
|
28
|
+
"Programming Language :: Python",
|
|
29
|
+
"Programming Language :: Python :: 3",
|
|
30
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
31
|
+
"Programming Language :: Python :: 3.13",
|
|
32
|
+
"Programming Language :: Python :: 3.14",
|
|
33
|
+
"Programming Language :: Python :: Implementation :: CPython",
|
|
34
|
+
"Topic :: Office/Business",
|
|
35
|
+
"Topic :: Software Development :: Documentation",
|
|
36
|
+
"Topic :: Text Editors :: Text Processing",
|
|
37
|
+
"Topic :: Text Processing :: Markup :: Markdown",
|
|
38
|
+
"Topic :: Utilities",
|
|
39
|
+
"Typing :: Typed",
|
|
40
|
+
]
|
|
41
|
+
dependencies = [
|
|
42
|
+
"mcp~=2.1",
|
|
43
|
+
"typer~=0.27",
|
|
44
|
+
]
|
|
45
|
+
|
|
46
|
+
[[project.authors]]
|
|
47
|
+
name = "Fedor Ratschew"
|
|
48
|
+
email = "feodor.ra@me.com"
|
|
49
|
+
|
|
50
|
+
[project.scripts]
|
|
51
|
+
worklog-mcp = "worklog_mcp.cli:app"
|
|
52
|
+
|
|
53
|
+
[project.urls]
|
|
54
|
+
Homepage = "https://feodor-ra.github.io/worklog-mcp/"
|
|
55
|
+
Documentation = "https://feodor-ra.github.io/worklog-mcp/"
|
|
56
|
+
Repository = "https://github.com/feodor-ra/worklog-mcp"
|
|
57
|
+
Issues = "https://github.com/feodor-ra/worklog-mcp/issues"
|
|
58
|
+
|
|
59
|
+
[build-system]
|
|
60
|
+
requires = ["uv_build>=0.12.10,<0.13.0"]
|
|
61
|
+
build-backend = "uv_build"
|
|
62
|
+
|
|
63
|
+
[tool.ruff]
|
|
64
|
+
line-length = 120
|
|
65
|
+
preview = true
|
|
66
|
+
|
|
67
|
+
[tool.ruff.format]
|
|
68
|
+
quote-style = "double"
|
|
69
|
+
|
|
70
|
+
[tool.ruff.lint]
|
|
71
|
+
select = ["ALL"]
|
|
72
|
+
ignore = [
|
|
73
|
+
"TC",
|
|
74
|
+
"CPY",
|
|
75
|
+
"missing-trailing-comma",
|
|
76
|
+
"relative-imports",
|
|
77
|
+
"docstring-extraneous-exception",
|
|
78
|
+
]
|
|
79
|
+
|
|
80
|
+
[tool.ruff.lint.pydocstyle]
|
|
81
|
+
convention = "google"
|
|
82
|
+
|
|
83
|
+
[tool.ruff.lint.per-file-ignores]
|
|
84
|
+
"tests/**" = [
|
|
85
|
+
"assert",
|
|
86
|
+
"implicit-namespace-package",
|
|
87
|
+
"magic-value-comparison",
|
|
88
|
+
"import-private-name",
|
|
89
|
+
"undocumented-public-function",
|
|
90
|
+
]
|
|
91
|
+
"scripts/**" = [
|
|
92
|
+
"assert",
|
|
93
|
+
"implicit-namespace-package",
|
|
94
|
+
]
|
|
95
|
+
|
|
96
|
+
[tool.ty.rules]
|
|
97
|
+
all = "error"
|
|
98
|
+
|
|
99
|
+
[tool.pytest.ini_options]
|
|
100
|
+
testpaths = ["tests"]
|
|
101
|
+
addopts = "--strict-config --strict-markers"
|
|
102
|
+
|
|
103
|
+
[tool.coverage.run]
|
|
104
|
+
source = ["worklog_mcp"]
|
|
105
|
+
branch = true
|
|
106
|
+
|
|
107
|
+
[tool.coverage.report]
|
|
108
|
+
show_missing = true
|
|
109
|
+
fail_under = 100
|
|
110
|
+
|
|
111
|
+
[dependency-groups]
|
|
112
|
+
dev = [
|
|
113
|
+
"anyio~=4.15.1",
|
|
114
|
+
"pytest~=9.1.1",
|
|
115
|
+
"pytest-cov~=7.1.0",
|
|
116
|
+
"ruff==0.16.6",
|
|
117
|
+
"ty==0.0.78",
|
|
118
|
+
]
|
|
119
|
+
docs = [
|
|
120
|
+
"mkdocs-material~=9.7.7",
|
|
121
|
+
"mkdocs-static-i18n~=1.3.1",
|
|
122
|
+
"mkdocstrings[python]~=1.0.6",
|
|
123
|
+
]
|