waypoint-mcp 0.2.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.
- waypoint_mcp-0.2.0/LICENSE +202 -0
- waypoint_mcp-0.2.0/PKG-INFO +134 -0
- waypoint_mcp-0.2.0/README.md +111 -0
- waypoint_mcp-0.2.0/pyproject.toml +40 -0
- waypoint_mcp-0.2.0/setup.cfg +4 -0
- waypoint_mcp-0.2.0/tests/test_install.py +349 -0
- waypoint_mcp-0.2.0/tests/test_mcp.py +336 -0
- waypoint_mcp-0.2.0/tests/test_release_check.py +25 -0
- waypoint_mcp-0.2.0/tests/test_waypoint.py +812 -0
- waypoint_mcp-0.2.0/waypoint/__init__.py +3 -0
- waypoint_mcp-0.2.0/waypoint/__main__.py +3 -0
- waypoint_mcp-0.2.0/waypoint/chart.py +234 -0
- waypoint_mcp-0.2.0/waypoint/cli.py +486 -0
- waypoint_mcp-0.2.0/waypoint/clis.py +152 -0
- waypoint_mcp-0.2.0/waypoint/config.py +98 -0
- waypoint_mcp-0.2.0/waypoint/logbook.py +124 -0
- waypoint_mcp-0.2.0/waypoint/mcp.py +274 -0
- waypoint_mcp-0.2.0/waypoint/paths.py +83 -0
- waypoint_mcp-0.2.0/waypoint/rules.py +359 -0
- waypoint_mcp-0.2.0/waypoint/sources/__init__.py +41 -0
- waypoint_mcp-0.2.0/waypoint/sources/claude.py +78 -0
- waypoint_mcp-0.2.0/waypoint/sources/codex.py +54 -0
- waypoint_mcp-0.2.0/waypoint/sources/git.py +59 -0
- waypoint_mcp-0.2.0/waypoint/templates/GLOBAL-RULES.md +38 -0
- waypoint_mcp-0.2.0/waypoint/templates/logbook/AGENTS.md +21 -0
- waypoint_mcp-0.2.0/waypoint/templates/logbook/CLAUDE.md +5 -0
- waypoint_mcp-0.2.0/waypoint/templates/logbook/README.md +10 -0
- waypoint_mcp-0.2.0/waypoint/templates/logbook/_ignore.txt +1 -0
- waypoint_mcp-0.2.0/waypoint/templates/logbook/_template.md +11 -0
- waypoint_mcp-0.2.0/waypoint/templates/logbook/waypoint.toml +6 -0
- waypoint_mcp-0.2.0/waypoint/watch.py +159 -0
- waypoint_mcp-0.2.0/waypoint_mcp.egg-info/PKG-INFO +134 -0
- waypoint_mcp-0.2.0/waypoint_mcp.egg-info/SOURCES.txt +34 -0
- waypoint_mcp-0.2.0/waypoint_mcp.egg-info/dependency_links.txt +1 -0
- waypoint_mcp-0.2.0/waypoint_mcp.egg-info/entry_points.txt +3 -0
- waypoint_mcp-0.2.0/waypoint_mcp.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: waypoint-mcp
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Every voyage, every navigator, one chart: track your projects across Claude Code, Codex, Gemini CLI, Copilot CLI and ChatGPT.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://github.com/STiFLeR7/waypoint-mcp
|
|
7
|
+
Project-URL: Issues, https://github.com/STiFLeR7/waypoint-mcp/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/STiFLeR7/waypoint-mcp/blob/main/CHANGELOG.md
|
|
9
|
+
Keywords: mcp,model-context-protocol,claude-code,codex,ai-agents,project-tracking,logbook
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Software Development
|
|
19
|
+
Requires-Python: >=3.11
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# Waypoint
|
|
25
|
+
|
|
26
|
+
**Every voyage (project), every navigator (AI tool), one chart.**
|
|
27
|
+
|
|
28
|
+
## Dead reckoning
|
|
29
|
+
|
|
30
|
+
A dozen projects at once, and three or four AI tools taking turns at the helm: Claude Code in the morning, Codex in the afternoon, ChatGPT for the hard question at night. None of them remembers the previous watch (session). So every session starts with *dead reckoning*: where was this, what changed, who touched it last? Projects drift. Side work goes uncharted. Finished work never makes it into port.
|
|
31
|
+
|
|
32
|
+
Waypoint is the **ship's log** (one Markdown file per project) that every navigator writes to, and the **chart** (dashboard) that shows all of it at once.
|
|
33
|
+
|
|
34
|
+
It deals with two kinds of truth:
|
|
35
|
+
|
|
36
|
+
- **Facts** (where and when): which project, which tool, when, the last commit. Waypoint **harvests these automatically** from the tools' own local history and from git.
|
|
37
|
+
- **Meaning** (what and why): what got done, what's next, what's in the way. The AI tool **writes this down** as a short log entry, following one shared rule.
|
|
38
|
+
|
|
39
|
+
Where the two disagree, the chart says so. A tool that worked on a project but logged nothing leaves an **unlogged watch** (session). That's how the chart keeps itself honest, even when a tool forgets the rule.
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
$ waypoint fix
|
|
43
|
+
Fix taken (sync): 3 voyages (projects), 1 underway (active) this week, 1 hazard (attention item), 1 with unlogged watches (sessions), 1 adrift (stale), 1 uncharted (untracked folders).
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
That's the fictional logbook in [`examples/logbook/`](examples/logbook/): its [chart](examples/logbook/DASHBOARD.md) shows each case.
|
|
47
|
+
|
|
48
|
+
## Take a fix
|
|
49
|
+
|
|
50
|
+
Requires Python 3.11 or newer; no other dependencies.
|
|
51
|
+
|
|
52
|
+
**macOS / Linux**
|
|
53
|
+
```bash
|
|
54
|
+
pipx install waypoint-mcp # or: python -m pip install waypoint-mcp
|
|
55
|
+
waypoint setup # fitting out: logbook, roots, the rule and MCP server for each AI CLI it finds
|
|
56
|
+
waypoint add ~/code/my-project # chart a voyage (project); once per project
|
|
57
|
+
waypoint fix # take a fix (sync): redraws DASHBOARD.md and dashboard.json
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**Windows (PowerShell)**
|
|
61
|
+
```powershell
|
|
62
|
+
py -m pip install waypoint-mcp
|
|
63
|
+
waypoint setup
|
|
64
|
+
waypoint add $HOME\code\my-project
|
|
65
|
+
waypoint fix
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
- **`waypoint` not found?** Its install folder isn't on PATH, and AI tools need it there too (they start `waypoint mcp`). Installed with pipx: run `pipx ensurepath`, then open a new terminal. Installed with pip: add the scripts folder pip warned about to PATH; until then `python -m waypoint …` (Windows: `py -m waypoint …`) runs it with that same Python.
|
|
69
|
+
- `setup` shows every file it would change and asks once. It remembers the logbook, so later commands need no `--logbook`. It never edits your own `CLAUDE.md` or `AGENTS.md` text: it adds Waypoint's own file or a marked block, and `waypoint rules --uninstall` removes exactly those.
|
|
70
|
+
- Make the logbook a **private** git repo, then `waypoint fix --push` pulls, redraws, commits only logbook data, and pushes.
|
|
71
|
+
- From a clone of this repo: `python -m pip install -e .`
|
|
72
|
+
|
|
73
|
+
## Who's aboard
|
|
74
|
+
|
|
75
|
+
| Navigator (AI CLI) | Tier | What Waypoint wires |
|
|
76
|
+
|---|---|---|
|
|
77
|
+
| **Claude Code** | Supported | the rule, the local MCP server, session facts |
|
|
78
|
+
| **Codex** (CLI and desktop) | Supported | the rule, the local MCP server, session facts |
|
|
79
|
+
| Gemini CLI | Preview | the rule, the local MCP server |
|
|
80
|
+
| GitHub Copilot CLI | Preview | the rule, the local MCP server |
|
|
81
|
+
| Cursor, Windsurf, Kiro, Cline, Claude Desktop, Goose, opencode, Amp | Snippet | `waypoint connect <cli>` prints the config to paste; writes nothing |
|
|
82
|
+
| ChatGPT | Beacon | remote MCP server you host ([Raise the beacon](#raise-the-beacon)) |
|
|
83
|
+
|
|
84
|
+
- **The rule** tells the tool to add a log entry after meaningful work. **The local MCP server** (`waypoint mcp`, stdio) gives it three tools: `take_fix` (the overview), `read_chart` (one project), `log_watch` (append one log entry, with the tool's own id, under a lock).
|
|
85
|
+
- `waypoint connect <cli>` wires one CLI at any time. MCP servers are registered through each CLI's own `mcp add` command. An existing server already named `waypoint` is never replaced; `--no-mcp` installs only the rule.
|
|
86
|
+
- `waypoint rules` reports each tool's rule: in sync, drifted, missing, or shadowed (Codex reads an `AGENTS.override.md` instead).
|
|
87
|
+
- **Known limits:** Claude Code deletes transcripts after 30 days by default. The Claude Code and Codex history formats are unofficial; the chart's source health says when a reader breaks.
|
|
88
|
+
|
|
89
|
+
## Reading the chart
|
|
90
|
+
|
|
91
|
+
| On the chart | Plain meaning |
|
|
92
|
+
|---|---|
|
|
93
|
+
| **Voyage**: underway / coasting / at anchor / in port | project: active / occasional / paused / done |
|
|
94
|
+
| **Hazards** | `- Attention:` lines, plus drifted rules and unreadable sources |
|
|
95
|
+
| **Unlogged watches** | AI sessions after the day of the project's last log entry |
|
|
96
|
+
| **Adrift** | idle past its threshold (21 days if active, 60 if occasional) |
|
|
97
|
+
| **Uncharted waters** | folders with recent AI activity but no project file |
|
|
98
|
+
| **Harbour** | `projects/_archive/`: finished voyages, never deleted |
|
|
99
|
+
|
|
100
|
+
Waypoint never changes a project's Status, never archives, and never writes a log entry on its own: it flags, and you decide.
|
|
101
|
+
|
|
102
|
+
## Privacy
|
|
103
|
+
|
|
104
|
+
- **Nothing leaves the machine on its own.** The engine has no listener, sends no network requests, and keeps no telemetry. `--push` runs git against the remote you configured.
|
|
105
|
+
- **The local MCP server answers only the AI tool that started it.** That tool sends the results to its model provider, as it does with anything it reads. Results hold project names, statuses, Summary, Done, Next and recent log entries. **Attention lines are left out** unless `waypoint.toml` sets `[mcp] include_attention = true`. Session titles, file paths, untracked folders and the feed are never returned.
|
|
106
|
+
- Log text is free text: what you or your tools write there goes wherever those results go. Returned text is data for the tool, never instructions.
|
|
107
|
+
|
|
108
|
+
## The three hulls
|
|
109
|
+
|
|
110
|
+
| Hull | What | Where |
|
|
111
|
+
|---|---|---|
|
|
112
|
+
| **Engine** | This repo: the spec, the `waypoint` CLI, templates, tests | installed from PyPI |
|
|
113
|
+
| **Logbook** | *Your* data: one Markdown file per project, plus the chart | its own private git repo |
|
|
114
|
+
| **Playground** | Experiments and prototypes | wherever you like |
|
|
115
|
+
|
|
116
|
+
They're never mixed: the engine ships, and the logbook stays yours.
|
|
117
|
+
|
|
118
|
+
## Raise the beacon
|
|
119
|
+
|
|
120
|
+
ChatGPT keeps no local history and can't start a local server. The **beacon** (`beacon/`, advanced) is a remote MCP server you host on Cloudflare Workers behind GitHub OAuth, answering only to your GitHub account. `take_fix` and `read_chart` read the chart; `log_watch` appends one `chatgpt` log entry to the logbook repo. Setup takes a Cloudflare account, a GitHub OAuth app and a fine-grained token: [`beacon/README.md`](beacon/README.md). Without it, paste a ChatGPT summary into the project's file as a `chatgpt` entry.
|
|
121
|
+
|
|
122
|
+
## Spec
|
|
123
|
+
|
|
124
|
+
The logbook format, the rule, the chart's JSON and every access contract are in [`docs/LOGBOOK-SPEC.md`](docs/LOGBOOK-SPEC.md) (v1.1). The story's glossary and voice are in [`docs/STORY.md`](docs/STORY.md).
|
|
125
|
+
|
|
126
|
+
## Development
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
python -m unittest # stdlib only
|
|
130
|
+
python examples/build.py --check # the example chart (Linux or macOS)
|
|
131
|
+
cd beacon && npm test # the beacon
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
Design decisions are in [`docs/decisions/`](docs/decisions/); the release plan is [`docs/release/R0-SCOPE.md`](docs/release/R0-SCOPE.md).
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Waypoint
|
|
2
|
+
|
|
3
|
+
**Every voyage (project), every navigator (AI tool), one chart.**
|
|
4
|
+
|
|
5
|
+
## Dead reckoning
|
|
6
|
+
|
|
7
|
+
A dozen projects at once, and three or four AI tools taking turns at the helm: Claude Code in the morning, Codex in the afternoon, ChatGPT for the hard question at night. None of them remembers the previous watch (session). So every session starts with *dead reckoning*: where was this, what changed, who touched it last? Projects drift. Side work goes uncharted. Finished work never makes it into port.
|
|
8
|
+
|
|
9
|
+
Waypoint is the **ship's log** (one Markdown file per project) that every navigator writes to, and the **chart** (dashboard) that shows all of it at once.
|
|
10
|
+
|
|
11
|
+
It deals with two kinds of truth:
|
|
12
|
+
|
|
13
|
+
- **Facts** (where and when): which project, which tool, when, the last commit. Waypoint **harvests these automatically** from the tools' own local history and from git.
|
|
14
|
+
- **Meaning** (what and why): what got done, what's next, what's in the way. The AI tool **writes this down** as a short log entry, following one shared rule.
|
|
15
|
+
|
|
16
|
+
Where the two disagree, the chart says so. A tool that worked on a project but logged nothing leaves an **unlogged watch** (session). That's how the chart keeps itself honest, even when a tool forgets the rule.
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
$ waypoint fix
|
|
20
|
+
Fix taken (sync): 3 voyages (projects), 1 underway (active) this week, 1 hazard (attention item), 1 with unlogged watches (sessions), 1 adrift (stale), 1 uncharted (untracked folders).
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
That's the fictional logbook in [`examples/logbook/`](examples/logbook/): its [chart](examples/logbook/DASHBOARD.md) shows each case.
|
|
24
|
+
|
|
25
|
+
## Take a fix
|
|
26
|
+
|
|
27
|
+
Requires Python 3.11 or newer; no other dependencies.
|
|
28
|
+
|
|
29
|
+
**macOS / Linux**
|
|
30
|
+
```bash
|
|
31
|
+
pipx install waypoint-mcp # or: python -m pip install waypoint-mcp
|
|
32
|
+
waypoint setup # fitting out: logbook, roots, the rule and MCP server for each AI CLI it finds
|
|
33
|
+
waypoint add ~/code/my-project # chart a voyage (project); once per project
|
|
34
|
+
waypoint fix # take a fix (sync): redraws DASHBOARD.md and dashboard.json
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**Windows (PowerShell)**
|
|
38
|
+
```powershell
|
|
39
|
+
py -m pip install waypoint-mcp
|
|
40
|
+
waypoint setup
|
|
41
|
+
waypoint add $HOME\code\my-project
|
|
42
|
+
waypoint fix
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
- **`waypoint` not found?** Its install folder isn't on PATH, and AI tools need it there too (they start `waypoint mcp`). Installed with pipx: run `pipx ensurepath`, then open a new terminal. Installed with pip: add the scripts folder pip warned about to PATH; until then `python -m waypoint …` (Windows: `py -m waypoint …`) runs it with that same Python.
|
|
46
|
+
- `setup` shows every file it would change and asks once. It remembers the logbook, so later commands need no `--logbook`. It never edits your own `CLAUDE.md` or `AGENTS.md` text: it adds Waypoint's own file or a marked block, and `waypoint rules --uninstall` removes exactly those.
|
|
47
|
+
- Make the logbook a **private** git repo, then `waypoint fix --push` pulls, redraws, commits only logbook data, and pushes.
|
|
48
|
+
- From a clone of this repo: `python -m pip install -e .`
|
|
49
|
+
|
|
50
|
+
## Who's aboard
|
|
51
|
+
|
|
52
|
+
| Navigator (AI CLI) | Tier | What Waypoint wires |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| **Claude Code** | Supported | the rule, the local MCP server, session facts |
|
|
55
|
+
| **Codex** (CLI and desktop) | Supported | the rule, the local MCP server, session facts |
|
|
56
|
+
| Gemini CLI | Preview | the rule, the local MCP server |
|
|
57
|
+
| GitHub Copilot CLI | Preview | the rule, the local MCP server |
|
|
58
|
+
| Cursor, Windsurf, Kiro, Cline, Claude Desktop, Goose, opencode, Amp | Snippet | `waypoint connect <cli>` prints the config to paste; writes nothing |
|
|
59
|
+
| ChatGPT | Beacon | remote MCP server you host ([Raise the beacon](#raise-the-beacon)) |
|
|
60
|
+
|
|
61
|
+
- **The rule** tells the tool to add a log entry after meaningful work. **The local MCP server** (`waypoint mcp`, stdio) gives it three tools: `take_fix` (the overview), `read_chart` (one project), `log_watch` (append one log entry, with the tool's own id, under a lock).
|
|
62
|
+
- `waypoint connect <cli>` wires one CLI at any time. MCP servers are registered through each CLI's own `mcp add` command. An existing server already named `waypoint` is never replaced; `--no-mcp` installs only the rule.
|
|
63
|
+
- `waypoint rules` reports each tool's rule: in sync, drifted, missing, or shadowed (Codex reads an `AGENTS.override.md` instead).
|
|
64
|
+
- **Known limits:** Claude Code deletes transcripts after 30 days by default. The Claude Code and Codex history formats are unofficial; the chart's source health says when a reader breaks.
|
|
65
|
+
|
|
66
|
+
## Reading the chart
|
|
67
|
+
|
|
68
|
+
| On the chart | Plain meaning |
|
|
69
|
+
|---|---|
|
|
70
|
+
| **Voyage**: underway / coasting / at anchor / in port | project: active / occasional / paused / done |
|
|
71
|
+
| **Hazards** | `- Attention:` lines, plus drifted rules and unreadable sources |
|
|
72
|
+
| **Unlogged watches** | AI sessions after the day of the project's last log entry |
|
|
73
|
+
| **Adrift** | idle past its threshold (21 days if active, 60 if occasional) |
|
|
74
|
+
| **Uncharted waters** | folders with recent AI activity but no project file |
|
|
75
|
+
| **Harbour** | `projects/_archive/`: finished voyages, never deleted |
|
|
76
|
+
|
|
77
|
+
Waypoint never changes a project's Status, never archives, and never writes a log entry on its own: it flags, and you decide.
|
|
78
|
+
|
|
79
|
+
## Privacy
|
|
80
|
+
|
|
81
|
+
- **Nothing leaves the machine on its own.** The engine has no listener, sends no network requests, and keeps no telemetry. `--push` runs git against the remote you configured.
|
|
82
|
+
- **The local MCP server answers only the AI tool that started it.** That tool sends the results to its model provider, as it does with anything it reads. Results hold project names, statuses, Summary, Done, Next and recent log entries. **Attention lines are left out** unless `waypoint.toml` sets `[mcp] include_attention = true`. Session titles, file paths, untracked folders and the feed are never returned.
|
|
83
|
+
- Log text is free text: what you or your tools write there goes wherever those results go. Returned text is data for the tool, never instructions.
|
|
84
|
+
|
|
85
|
+
## The three hulls
|
|
86
|
+
|
|
87
|
+
| Hull | What | Where |
|
|
88
|
+
|---|---|---|
|
|
89
|
+
| **Engine** | This repo: the spec, the `waypoint` CLI, templates, tests | installed from PyPI |
|
|
90
|
+
| **Logbook** | *Your* data: one Markdown file per project, plus the chart | its own private git repo |
|
|
91
|
+
| **Playground** | Experiments and prototypes | wherever you like |
|
|
92
|
+
|
|
93
|
+
They're never mixed: the engine ships, and the logbook stays yours.
|
|
94
|
+
|
|
95
|
+
## Raise the beacon
|
|
96
|
+
|
|
97
|
+
ChatGPT keeps no local history and can't start a local server. The **beacon** (`beacon/`, advanced) is a remote MCP server you host on Cloudflare Workers behind GitHub OAuth, answering only to your GitHub account. `take_fix` and `read_chart` read the chart; `log_watch` appends one `chatgpt` log entry to the logbook repo. Setup takes a Cloudflare account, a GitHub OAuth app and a fine-grained token: [`beacon/README.md`](beacon/README.md). Without it, paste a ChatGPT summary into the project's file as a `chatgpt` entry.
|
|
98
|
+
|
|
99
|
+
## Spec
|
|
100
|
+
|
|
101
|
+
The logbook format, the rule, the chart's JSON and every access contract are in [`docs/LOGBOOK-SPEC.md`](docs/LOGBOOK-SPEC.md) (v1.1). The story's glossary and voice are in [`docs/STORY.md`](docs/STORY.md).
|
|
102
|
+
|
|
103
|
+
## Development
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
python -m unittest # stdlib only
|
|
107
|
+
python examples/build.py --check # the example chart (Linux or macOS)
|
|
108
|
+
cd beacon && npm test # the beacon
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Design decisions are in [`docs/decisions/`](docs/decisions/); the release plan is [`docs/release/R0-SCOPE.md`](docs/release/R0-SCOPE.md).
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "waypoint-mcp"
|
|
7
|
+
version = "0.2.0"
|
|
8
|
+
description = "Every voyage, every navigator, one chart: track your projects across Claude Code, Codex, Gemini CLI, Copilot CLI and ChatGPT."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
requires-python = ">=3.11"
|
|
13
|
+
dependencies = []
|
|
14
|
+
keywords = ["mcp", "model-context-protocol", "claude-code", "codex", "ai-agents", "project-tracking", "logbook"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 4 - Beta",
|
|
17
|
+
"Environment :: Console",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Topic :: Software Development",
|
|
25
|
+
]
|
|
26
|
+
|
|
27
|
+
[project.urls]
|
|
28
|
+
Homepage = "https://github.com/STiFLeR7/waypoint-mcp"
|
|
29
|
+
Issues = "https://github.com/STiFLeR7/waypoint-mcp/issues"
|
|
30
|
+
Changelog = "https://github.com/STiFLeR7/waypoint-mcp/blob/main/CHANGELOG.md"
|
|
31
|
+
|
|
32
|
+
[project.scripts]
|
|
33
|
+
waypoint = "waypoint.cli:main"
|
|
34
|
+
waypoint-mcp = "waypoint.mcp:main"
|
|
35
|
+
|
|
36
|
+
[tool.setuptools]
|
|
37
|
+
packages = ["waypoint", "waypoint.sources"]
|
|
38
|
+
|
|
39
|
+
[tool.setuptools.package-data]
|
|
40
|
+
waypoint = ["templates/*.md", "templates/logbook/*"]
|