career-compass-mcp 2.6.0 → 2.7.0
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.
- package/README.md +540 -486
- package/build/bin/cli.js +9 -12
- package/build/bin/cli.js.map +1 -1
- package/build/src/dashboard-lite/render.d.ts +1 -1
- package/build/src/dashboard-lite/render.d.ts.map +1 -1
- package/build/src/dashboard-lite/render.js +272 -150
- package/build/src/dashboard-lite/render.js.map +1 -1
- package/build/src/dashboard-lite/server.d.ts.map +1 -1
- package/build/src/dashboard-lite/server.js +5 -3
- package/build/src/dashboard-lite/server.js.map +1 -1
- package/build/src/index.js +2 -1
- package/build/src/index.js.map +1 -1
- package/build/src/prompts/index.d.ts.map +1 -1
- package/build/src/prompts/index.js +39 -2
- package/build/src/prompts/index.js.map +1 -1
- package/build/src/resources/live.d.ts.map +1 -1
- package/build/src/resources/live.js +7 -0
- package/build/src/resources/live.js.map +1 -1
- package/build/src/stdio-banner.d.ts +13 -0
- package/build/src/stdio-banner.d.ts.map +1 -0
- package/build/src/stdio-banner.js +24 -0
- package/build/src/stdio-banner.js.map +1 -0
- package/build/src/storage/file-store.d.ts +7 -1
- package/build/src/storage/file-store.d.ts.map +1 -1
- package/build/src/storage/file-store.js +19 -3
- package/build/src/storage/file-store.js.map +1 -1
- package/build/src/tools/doctor.d.ts.map +1 -1
- package/build/src/tools/doctor.js +50 -1
- package/build/src/tools/doctor.js.map +1 -1
- package/build/src/tools/opportunity.d.ts.map +1 -1
- package/build/src/tools/opportunity.js +9 -2
- package/build/src/tools/opportunity.js.map +1 -1
- package/build/src/tools/pipeline.d.ts.map +1 -1
- package/build/src/tools/pipeline.js +54 -14
- package/build/src/tools/pipeline.js.map +1 -1
- package/build/src/tools/resume.d.ts.map +1 -1
- package/build/src/tools/resume.js +18 -2
- package/build/src/tools/resume.js.map +1 -1
- package/build/src/types/tool-args.d.ts +1 -0
- package/build/src/types/tool-args.d.ts.map +1 -1
- package/package.json +77 -77
package/README.md
CHANGED
|
@@ -1,486 +1,540 @@
|
|
|
1
|
-
# Career Compass
|
|
2
|
-
|
|
3
|
-
[](https://www.npmjs.com/package/career-compass-mcp)
|
|
4
|
+
[](https://www.npmjs.com/package/career-compass-mcp)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
[](https://nodejs.org)
|
|
7
|
+
[](https://modelcontextprotocol.io)
|
|
8
|
+
|
|
9
|
+
**An AI-native career co-pilot for Claude.**
|
|
10
|
+
|
|
11
|
+
Career Compass gives Claude your entire career history as a working corpus — then uses it
|
|
12
|
+
to tailor every résumé, track every application, prep every interview, and pressure-test
|
|
13
|
+
every offer. One conversation that never forgets what you have done.
|
|
14
|
+
|
|
15
|
+
Your data is plain YAML on your own disk. No account, no cloud sync, no telemetry.
|
|
16
|
+
|
|
17
|
+

|
|
18
|
+
|
|
19
|
+
**See it in 10 seconds.** No install, no config, no data of your own required:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx -y career-compass-mcp dashboard --sample
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
That opens the screenshot above in your browser, running against a fictional job search
|
|
26
|
+
bundled with the package. It is read-only — nothing is written, and nothing leaves your
|
|
27
|
+
machine.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## What it feels like
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
You: I have a panel interview at Veridian Health on Friday — Director of Operations role.
|
|
35
|
+
Can you prep me?
|
|
36
|
+
|
|
37
|
+
Claude: On it. Reading your career history now...
|
|
38
|
+
|
|
39
|
+
[Generates 90-second pitch, 8 STAR stories matched to likely panel questions,
|
|
40
|
+
company research brief, 10 questions to ask them, and a list of watch-outs
|
|
41
|
+
based on gaps in your background — all in one response]
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
You: Here's a job posting I just found. [pastes posting]
|
|
46
|
+
How well do I fit?
|
|
47
|
+
|
|
48
|
+
Claude: Fit score: 8.1/10. Here's why — and here's what they'll probe you on...
|
|
49
|
+
|
|
50
|
+
[Returns matched strengths, honest gap analysis, talking points in their language,
|
|
51
|
+
and a "day in the life" of what the role actually looks like]
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
You: Show me what needs attention in my pipeline today.
|
|
56
|
+
|
|
57
|
+
Claude: 3 things:
|
|
58
|
+
- Meridian Logistics follow-up is overdue (8 days since you applied, referral from Marcus Chen)
|
|
59
|
+
- Veridian panel is Friday — prep above
|
|
60
|
+
- Novare rejection arrived — want me to draft a keep-the-door-open response?
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Install
|
|
66
|
+
|
|
67
|
+
Pick your client. Every route runs the same server, and none of them needs a clone or a
|
|
68
|
+
build.
|
|
69
|
+
|
|
70
|
+
### Claude Code
|
|
71
|
+
|
|
72
|
+
One command:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
claude mcp add career-compass -s user -- npx -y career-compass-mcp
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
`-s user` installs it for every project rather than just this one. Confirm it landed with
|
|
79
|
+
`claude mcp list`.
|
|
80
|
+
|
|
81
|
+
To keep your career files somewhere other than the default `~/.career-compass`:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
claude mcp add career-compass -s user -e CAREER_DATA_PATH=/path/to/career-data -- npx -y career-compass-mcp
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Claude Desktop
|
|
88
|
+
|
|
89
|
+
**The extension bundle is the short way.** Download the `.mcpb` file from the
|
|
90
|
+
[Releases page](https://github.com/benskamps/career-compass-mcp/releases/latest), then in
|
|
91
|
+
Claude Desktop go to **Settings → Extensions** and install it. There is no JSON to edit and
|
|
92
|
+
nothing to install first. Set `CAREER_DATA_PATH` in the extension's own settings if you
|
|
93
|
+
want your files somewhere other than `~/.career-compass`.
|
|
94
|
+
|
|
95
|
+
The bundle does not self-update: to upgrade, download the newer `.mcpb`, remove the
|
|
96
|
+
installed extension, and install the new file. Note your data path before removing it —
|
|
97
|
+
settings are re-entered on install, and `check_setup` prints the path.
|
|
98
|
+
|
|
99
|
+
**Or point Claude Desktop at npx.** Open **Settings → Developer → Edit Config**, or edit
|
|
100
|
+
the file directly:
|
|
101
|
+
|
|
102
|
+
| OS | Config file |
|
|
103
|
+
|----|-------------|
|
|
104
|
+
| macOS | `~/Library/Application Support/Claude/claude_desktop_config.json` |
|
|
105
|
+
| Windows | `%APPDATA%\Claude\claude_desktop_config.json` |
|
|
106
|
+
| Linux | `~/.config/Claude/claude_desktop_config.json` |
|
|
107
|
+
|
|
108
|
+
Add the server:
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"mcpServers": {
|
|
113
|
+
"career-compass": {
|
|
114
|
+
"command": "npx",
|
|
115
|
+
"args": ["-y", "career-compass-mcp"]
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Restart Claude Desktop. To choose your own data directory, add an `env` block alongside
|
|
122
|
+
`args`:
|
|
123
|
+
|
|
124
|
+
```json
|
|
125
|
+
"env": { "CAREER_DATA_PATH": "/Users/you/career-data" }
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Any other MCP client
|
|
129
|
+
|
|
130
|
+
Cursor, Windsurf, Cline, Continue and friends all take the same shape — a stdio server
|
|
131
|
+
with `command: "npx"` and `args: ["-y", "career-compass-mcp"]`. Drop that into whatever the
|
|
132
|
+
client calls its MCP config.
|
|
133
|
+
|
|
134
|
+
**Zed** — add to your `settings.json`:
|
|
135
|
+
|
|
136
|
+
```json
|
|
137
|
+
{
|
|
138
|
+
"context_servers": {
|
|
139
|
+
"career-compass": {
|
|
140
|
+
"command": {
|
|
141
|
+
"path": "npx",
|
|
142
|
+
"args": ["-y", "career-compass-mcp"]
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Prefer a global install
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
npm install -g career-compass-mcp
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Then use `"command": "career-compass-mcp"` with no `args`, or
|
|
156
|
+
`claude mcp add career-compass -s user -- career-compass-mcp`.
|
|
157
|
+
|
|
158
|
+
### Confirm it worked
|
|
159
|
+
|
|
160
|
+
Ask Claude:
|
|
161
|
+
|
|
162
|
+
> **"Run the Career Compass setup check."**
|
|
163
|
+
|
|
164
|
+
That calls `check_setup`, which reports your version against the current npm release, where
|
|
165
|
+
your data directory is, which Career KB sections are filled in, whether your pipeline
|
|
166
|
+
parses, and whether the dashboard is running — each finding with the one command that fixes
|
|
167
|
+
it. It is read-only, so it runs without a permission prompt.
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## Your first conversation
|
|
172
|
+
|
|
173
|
+
Open Claude and say:
|
|
174
|
+
|
|
175
|
+
> **"Set up my Career KB. Here's my résumé:"** [paste your résumé]
|
|
176
|
+
|
|
177
|
+
Claude will extract your work history, achievements, and skills into structured YAML, ask
|
|
178
|
+
clarifying questions about gaps or vague metrics, and call `save_career_section` once per
|
|
179
|
+
section to write it to disk.
|
|
180
|
+
|
|
181
|
+
`save_career_section` is where your data actually lands — it is the only tool that writes
|
|
182
|
+
the Career KB. It saves one section at a time (`profile`, `experience`, `skills`,
|
|
183
|
+
`education`, `projects`, `testimonials`), validates against the schema before touching the
|
|
184
|
+
file, and keeps the previous version as a timestamped `.bak`. Because it replaces a section
|
|
185
|
+
wholesale, your client will ask you to confirm each write; approving them is what fills the
|
|
186
|
+
KB.
|
|
187
|
+
|
|
188
|
+
That is the whole setup. From there every tool has full context on who you are, and the KB
|
|
189
|
+
compounds — each posting you explore, interview you debrief, and offer you weigh can add a
|
|
190
|
+
dated signal back to it.
|
|
191
|
+
|
|
192
|
+
**Already have material lying around?** Performance reviews, award emails, recommendations,
|
|
193
|
+
old project write-ups — paste any of them and ask Claude to pull the achievements out. That
|
|
194
|
+
is `ingest_document`. It reads and extracts but never writes; `save_career_section` is still
|
|
195
|
+
what puts the results on disk.
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## Your data stays on your machine
|
|
200
|
+
|
|
201
|
+
Career Compass is local-first by design. Your real career data — résumé history, the
|
|
202
|
+
companies you are talking to, salary numbers, interview notes — lives in **plain YAML files
|
|
203
|
+
on your own disk**.
|
|
204
|
+
|
|
205
|
+
- **Where it lives:** `~/.career-compass/` by default, or wherever you point
|
|
206
|
+
`CAREER_DATA_PATH`. The directory is created on first run, on *your* machine, and is not
|
|
207
|
+
part of the npm package.
|
|
208
|
+
- **Who sees it:** only the MCP client you connect it to, and through that client your model
|
|
209
|
+
provider, under *their* policy — and only for the requests you make. Career Compass sends
|
|
210
|
+
it nowhere on its own.
|
|
211
|
+
- **The one network call:** `check_setup` asks the public **npm registry** whether a newer
|
|
212
|
+
version has been released. It is an unauthenticated GET for the package name, carrying
|
|
213
|
+
nothing about you or your data, and calling `check_setup` with `checkForUpdates: false`
|
|
214
|
+
never constructs the request at all. There is no analytics or phone-home path anywhere
|
|
215
|
+
else in the package.
|
|
216
|
+
- **What ships in the package:** the server code and a small set of **fictional** example
|
|
217
|
+
files (`data/example/` — the Alex Rivera persona). A publish-time leak guard enforces that
|
|
218
|
+
no real career data can ride along.
|
|
219
|
+
- **The dashboard reads at request time, locally.** Your YAML is read when you open a page,
|
|
220
|
+
by a server on your own `localhost`. It is never baked into a build, never prerendered,
|
|
221
|
+
and never sent over the network. A regression test (`standalone-dynamic.test.ts`) guards
|
|
222
|
+
exactly that.
|
|
223
|
+
- **What else is in that folder:** timestamped `.bak` copies of previous versions (the five
|
|
224
|
+
most recent per file; older ones are pruned on the next write, and backups you make by
|
|
225
|
+
hand are never touched), plus — only while a write is actually happening — a
|
|
226
|
+
`.write-claim` file that stops a second Career Compass process from writing at the same
|
|
227
|
+
time.
|
|
228
|
+
- **Retention is yours:** files stay until you delete them. Remove the `CAREER_DATA_PATH`
|
|
229
|
+
directory and everything is gone.
|
|
230
|
+
|
|
231
|
+
Treat `~/.career-compass/` like any private notebook — back it up, and do not commit it to a
|
|
232
|
+
public repo. (This repo's `.gitignore` already excludes `data/career/` and `data/pipeline/`.)
|
|
233
|
+
|
|
234
|
+
Full policy: **[PRIVACY.md](PRIVACY.md)** ·
|
|
235
|
+
published at <https://benskamps.github.io/career-compass-mcp/privacy> ·
|
|
236
|
+
questions or concerns: [open an issue](https://github.com/benskamps/career-compass-mcp/issues)
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Tools
|
|
241
|
+
|
|
242
|
+
Eighteen tools, grouped by where they land in a search. **Read** tools take no permission
|
|
243
|
+
prompt in most clients; **Write** tools ask before touching your files.
|
|
244
|
+
|
|
245
|
+
### Find and assess a role
|
|
246
|
+
|
|
247
|
+
| Tool | Access | What it does |
|
|
248
|
+
|------|--------|-------------|
|
|
249
|
+
| `explore_opportunity` | Read | Scores a posting against your KB **and your stated preferences** — salary band, remote, relocation, notice period. Returns a fit score, an explicit comp and location check, matched strengths, honest gaps, talking points, day-in-the-life, red flags. Pass `sourceFitLabel` ("LinkedIn: strong match") and it will agree or disagree with the job board, in both directions |
|
|
250
|
+
| `research_company` | Read | Builds an intelligence brief: product, culture, funding, interview process, strategic fit |
|
|
251
|
+
|
|
252
|
+
### Apply
|
|
253
|
+
|
|
254
|
+
| Tool | Access | What it does |
|
|
255
|
+
|------|--------|-------------|
|
|
256
|
+
| `tailor_resume` | Read | Generates an ATS-optimized résumé from your KB — standard, federal, academic, or functional |
|
|
257
|
+
| `generate_cover_letter` | Read | Writes a cover letter with your actual achievements woven in, in a tone you pick — professional, conversational, enthusiastic, or concise |
|
|
258
|
+
| `format_for_ats` | Read | Reformats résumé content for a specific ATS: Workday, Greenhouse, Lever, LinkedIn, iCIMS, Taleo, SmartRecruiters, or generic |
|
|
259
|
+
|
|
260
|
+
### Track the pipeline
|
|
261
|
+
|
|
262
|
+
| Tool | Access | What it does |
|
|
263
|
+
|------|--------|-------------|
|
|
264
|
+
| `pipeline_view` | Read | Lists applications, funnel stats, what needs attention, or one application by id |
|
|
265
|
+
| `pipeline_add` | Write | Adds one application. Optional starting `status` (defaults to `applied`); unknown statuses are rejected with a did-you-mean suggestion |
|
|
266
|
+
| `pipeline_update` | Write | Updates one application — status, notes, follow-up date, a contact, or an interview round |
|
|
267
|
+
| `classify_email` | Read | Classifies a job-search email and extracts contacts, dates, and suggested pipeline updates |
|
|
268
|
+
|
|
269
|
+
### Interview and decide
|
|
270
|
+
|
|
271
|
+
| Tool | Access | What it does |
|
|
272
|
+
|------|--------|-------------|
|
|
273
|
+
| `prepare_interview` | Read | Full prep: opening pitch, STAR stories, likely questions, company alignment, questions to ask |
|
|
274
|
+
| `interview_arc` | Read | Mid-process projection. Reconstructs the arc so far from your recorded rounds and journal signals, then projects what the **next** round will probe — ground already covered, threads the last interview left open, gaps nobody has tested yet, ranked likely questions |
|
|
275
|
+
| `evaluate_offer` | Read | Breaks down total comp, compares to market, builds negotiation strategy, drafts counter scripts |
|
|
276
|
+
| `generate_rejection_response` | Write | Drafts a graceful keep-the-door-open reply. Pass `applicationId` and it also marks that application rejected |
|
|
277
|
+
|
|
278
|
+
### Feed the knowledge base
|
|
279
|
+
|
|
280
|
+
| Tool | Access | What it does |
|
|
281
|
+
|------|--------|-------------|
|
|
282
|
+
| `save_career_section` | Write | Writes one section of your Career KB as plain YAML — this is how the KB gets populated. Replaces the whole section; the previous version is kept as a `.bak` |
|
|
283
|
+
| `ingest_document` | Read | Extracts achievements from any document: performance review, award email, recommendation, project summary |
|
|
284
|
+
| `capture_insight` | Write | Appends a dated signal to your career journal — fit signals, interview insights, offer reflections, rejection patterns, skill evidence, wins — which later résumé, interview, and fit prompts read back |
|
|
285
|
+
| `harvest_evidence` | Read | Reads a local project's git history and reports what you measurably did there — months active, files and file types touched, your share of commits, test ratio — each with the exact command that produced it. Only your own commits count, and it names the identity it used. It writes nothing, anywhere |
|
|
286
|
+
|
|
287
|
+
### Keep the install healthy
|
|
288
|
+
|
|
289
|
+
| Tool | Access | What it does |
|
|
290
|
+
|------|--------|-------------|
|
|
291
|
+
| `check_setup` | Read | Health-checks the install in one pass — version vs. the current npm release, data directory, filled KB sections, pipeline parse, leftover temp files, dashboard status — each with the one command that fixes it. Run it first when anything seems off |
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## Resources
|
|
296
|
+
|
|
297
|
+
Claude can read these directly ("read my career profile"):
|
|
298
|
+
|
|
299
|
+
| Resource | URI | Contents |
|
|
300
|
+
|----------|-----|----------|
|
|
301
|
+
| Career Profile | `career://profile` | Name, contact, summary, targets, preferences |
|
|
302
|
+
| Work Experience | `career://experience` | Full history with achievements |
|
|
303
|
+
| Skills Inventory | `career://skills` | Skills with proficiency and recency |
|
|
304
|
+
| Projects | `career://projects` | Portfolio with outcomes |
|
|
305
|
+
| Education | `career://education` | Degrees, certifications, coursework |
|
|
306
|
+
| Testimonials | `career://testimonials` | Quotes, recommendations |
|
|
307
|
+
| Career Journal | `career://journal` | Dated signals captured over time |
|
|
308
|
+
| Full KB | `career://full` | Everything above in one read |
|
|
309
|
+
| Pipeline | `career://pipeline` | All applications with status |
|
|
310
|
+
|
|
311
|
+
**They are live.** Career Compass implements MCP resource subscriptions: subscribe to a
|
|
312
|
+
resource and the server tells you when the file behind it changes on disk — whoever changed
|
|
313
|
+
it, whether that was a tool call, the dashboard, or you in an editor. Three peers share one
|
|
314
|
+
directory of plain files and none of them owns it. Nothing is watched until a client
|
|
315
|
+
subscribes, so a client that never does pays nothing for the feature.
|
|
316
|
+
|
|
317
|
+
---
|
|
318
|
+
|
|
319
|
+
## Prompts
|
|
320
|
+
|
|
321
|
+
Power-user shortcuts. Most clients surface these as slash commands.
|
|
322
|
+
|
|
323
|
+
| Prompt | What it does |
|
|
324
|
+
|--------|-------------|
|
|
325
|
+
| `resume-tailor` | Drop in a posting → get a tailored résumé |
|
|
326
|
+
| `interview-coach` | Company + role + interview type → full prep package |
|
|
327
|
+
| `negotiation-coach` | Paste an offer → analysis, strategy, and counter scripts |
|
|
328
|
+
| `setup-career-kb` | Walk through building your Career KB from scratch — profile, experience, skills, first pipeline entry |
|
|
329
|
+
| `daily-review` | Triage the pipeline → today's highest-leverage moves, overdue items, upcoming interviews |
|
|
330
|
+
| `post-interview-debrief` | Capture what an interview surfaced → record the durable signal, set up the next step |
|
|
331
|
+
| `weekly-retro` | Review the week's movement and journal signals → one takeaway that compounds |
|
|
332
|
+
|
|
333
|
+
---
|
|
334
|
+
|
|
335
|
+
## The dashboard
|
|
336
|
+
|
|
337
|
+
A local web view of the same YAML the tools read. It ships inside the npm package as a
|
|
338
|
+
single self-contained HTML page with no build step, no dependencies, and no external
|
|
339
|
+
assets — pipeline KPIs, a kanban board by stage, a next-actions panel (overdue follow-ups,
|
|
340
|
+
upcoming interviews, expiring offers), and a stage-distribution chart.
|
|
341
|
+
|
|
342
|
+
```bash
|
|
343
|
+
# The bundled demo — no clone, no build, no data of your own:
|
|
344
|
+
npx -y career-compass-mcp dashboard --sample
|
|
345
|
+
|
|
346
|
+
# Your own data (CAREER_DATA_PATH, or ~/.career-compass if unset):
|
|
347
|
+
npx -y career-compass-mcp dashboard
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
It re-reads your YAML on **every request**, so a browser refresh always shows the current
|
|
351
|
+
state of your files. Stages change through Claude — ask it to move an application and it
|
|
352
|
+
calls `pipeline_update`; the board reflects that on the next load. Click a card to open its
|
|
353
|
+
detail drawer (days in stage, follow-up, posting link, contacts, interview rounds, latest
|
|
354
|
+
note); the drawer's button and every next-action row copy a ready-to-paste prompt for
|
|
355
|
+
Claude, which is where the work actually happens. Type in the filter box (or press `/`) to
|
|
356
|
+
narrow the board by company or role; the column counts follow.
|
|
357
|
+
|
|
358
|
+

|
|
359
|
+
|
|
360
|
+
`--sample` (alias `--demo`) resolves the demo *inside the installed package*, wherever npx
|
|
361
|
+
put it, so it works from any directory and any shell. The sample's dates are shifted to sit
|
|
362
|
+
around today each time it is read — so the pipeline always looks like a live search — and
|
|
363
|
+
Career Compass refuses to write into it.
|
|
364
|
+
|
|
365
|
+
Other flags: `--port <n>` (default 3141, falling back to the next free port), `--no-open` to
|
|
366
|
+
skip launching a browser, `--lite` to force this dashboard explicitly. Full list:
|
|
367
|
+
`career-compass-mcp --help`.
|
|
368
|
+
|
|
369
|
+
> **A second, frozen dashboard exists.** The repo also contains a full Next.js app — kanban
|
|
370
|
+
> with a detail view, an onboarding wizard, analytics. It is **not** in the npm package and
|
|
371
|
+
> is frozen as a design reference rather than a product; GUI investment goes to the
|
|
372
|
+
> dashboard above. See [`dashboard/FROZEN.md`](dashboard/FROZEN.md) for the reasoning. An
|
|
373
|
+
> in-Claude MCP App board is deferred too: Claude renders MCP Apps only for remote HTTP
|
|
374
|
+
> connectors, not the local stdio transport this ships as.
|
|
375
|
+
|
|
376
|
+
---
|
|
377
|
+
|
|
378
|
+
## The files on disk
|
|
379
|
+
|
|
380
|
+
```
|
|
381
|
+
~/.career-compass/ # or wherever CAREER_DATA_PATH points
|
|
382
|
+
├── career/
|
|
383
|
+
│ ├── profile.yaml # who you are, what you're targeting
|
|
384
|
+
│ ├── experience.yaml # roles, achievements (metrics + context + impact)
|
|
385
|
+
│ ├── skills.yaml # skills with proficiency and recency
|
|
386
|
+
│ ├── education.yaml # degrees, certifications, coursework
|
|
387
|
+
│ ├── projects.yaml # portfolio projects
|
|
388
|
+
│ ├── testimonials.yaml # quotes and recommendations
|
|
389
|
+
│ └── journal.yaml # dated signals, appended over time
|
|
390
|
+
└── pipeline/
|
|
391
|
+
└── applications.yaml # all job applications
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
This is your single source of truth — built once, enriched over time, read by every tool.
|
|
395
|
+
You never need to edit these files by hand: paste a document and ask Claude to save it. But
|
|
396
|
+
they are plain YAML, so you can.
|
|
397
|
+
|
|
398
|
+
[`data/example/`](data/example/) in this repo is a fully populated sample (the fictional
|
|
399
|
+
Alex Rivera) if you want to see the shape before writing your own.
|
|
400
|
+
|
|
401
|
+
---
|
|
402
|
+
|
|
403
|
+
## Configuration
|
|
404
|
+
|
|
405
|
+
| Env var | Default | Description |
|
|
406
|
+
|---------|---------|-------------|
|
|
407
|
+
| `CAREER_DATA_PATH` | `~/.career-compass` | Directory holding your career and pipeline YAML |
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
411
|
+
## Troubleshooting and upgrading
|
|
412
|
+
|
|
413
|
+
**If anything seems off, start here:**
|
|
414
|
+
|
|
415
|
+
> **"Run the Career Compass setup check."**
|
|
416
|
+
|
|
417
|
+
`check_setup` is read-only and usually answers the question before you have to debug
|
|
418
|
+
anything. It is also the fastest way to find out you are simply on an old version, which is
|
|
419
|
+
the most common cause of "this feels rough around the edges."
|
|
420
|
+
|
|
421
|
+
Your career data is never touched by an upgrade. It lives in `CAREER_DATA_PATH`, not in the
|
|
422
|
+
package, and older data directories keep working — sections added by later releases are
|
|
423
|
+
created when you first write them.
|
|
424
|
+
|
|
425
|
+
**On npx.** `npx -y career-compass-mcp` resolves the latest published version, but npx
|
|
426
|
+
caches, so a stale copy can persist. Force the current one, then restart your client:
|
|
427
|
+
|
|
428
|
+
```bash
|
|
429
|
+
npx -y career-compass-mcp@latest --version
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
If the version still lags, run `npm cache clean --force` and try again.
|
|
433
|
+
|
|
434
|
+
**On a global install.** `npm install -g career-compass-mcp@latest`, then
|
|
435
|
+
`career-compass-mcp --version`. Restart your client afterward — it keeps the old server
|
|
436
|
+
process alive until it does.
|
|
437
|
+
|
|
438
|
+
**From source.** `git pull && npm install && npm run build:mcp`, then restart your client. A
|
|
439
|
+
source checkout normally reports itself as *ahead* of npm in `check_setup`; that is
|
|
440
|
+
expected, not drift.
|
|
441
|
+
|
|
442
|
+
---
|
|
443
|
+
|
|
444
|
+
## How it works
|
|
445
|
+
|
|
446
|
+
```
|
|
447
|
+
┌─────────────┐ ┌────────────────────────────────────────┐
|
|
448
|
+
│ │ MCP │ MCP server (Node.js) │
|
|
449
|
+
│ Claude │◄────────►│ │
|
|
450
|
+
│ │ stdio │ Tools ······ résumé, pipeline, prep │
|
|
451
|
+
└─────────────┘ │ Resources ·· Career KB, pipeline │
|
|
452
|
+
│ Prompts ···· slash-command shortcuts │
|
|
453
|
+
└───────────────────┬────────────────────┘
|
|
454
|
+
│ reads + writes
|
|
455
|
+
┌──────────────▼───────────────┐
|
|
456
|
+
│ Plain YAML on your disk │
|
|
457
|
+
│ CAREER_DATA_PATH │
|
|
458
|
+
└──────────────▲───────────────┘
|
|
459
|
+
│ re-reads per request
|
|
460
|
+
┌──────────────┴───────────────┐
|
|
461
|
+
│ Local dashboard (localhost) │
|
|
462
|
+
└──────────────────────────────┘
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
No database, no server to host, no state the model has to carry between sessions. The files
|
|
466
|
+
are the interface.
|
|
467
|
+
|
|
468
|
+
**Diagrams:** [`docs/architecture.md`](docs/architecture.md) has the detailed version —
|
|
469
|
+
the path a posting takes from paste to offer, the application state machine, what happens
|
|
470
|
+
during your first conversation, how three peers share one directory without stepping on
|
|
471
|
+
each other, and why a write cannot be left half-done.
|
|
472
|
+
|
|
473
|
+
---
|
|
474
|
+
|
|
475
|
+
## Building from source
|
|
476
|
+
|
|
477
|
+
```bash
|
|
478
|
+
git clone https://github.com/benskamps/career-compass-mcp.git
|
|
479
|
+
cd career-compass-mcp
|
|
480
|
+
npm install # MCP server deps
|
|
481
|
+
cd dashboard && npm install && cd .. # only if you want the frozen Next.js app
|
|
482
|
+
npm run build:mcp # or `npm run build` to include that app
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
Point your MCP config at `node /path/to/career-compass-mcp/build/src/index.js`.
|
|
486
|
+
|
|
487
|
+
The Next.js dashboard is a separate package with its own `package.json` and lockfile, so it
|
|
488
|
+
needs its own `npm install` — the root install deliberately carries neither Next.js nor
|
|
489
|
+
React, which keeps 166 MB out of every `npm i career-compass-mcp`.
|
|
490
|
+
|
|
491
|
+
Common tasks:
|
|
492
|
+
|
|
493
|
+
```bash
|
|
494
|
+
npm run dev # TypeScript watch mode
|
|
495
|
+
npm run inspect # MCP Inspector — exercise tools interactively
|
|
496
|
+
npm run test:mcp # MCP server test suite
|
|
497
|
+
npm test # server + dashboard suites
|
|
498
|
+
npm run visuals # regenerate the screenshots in this README
|
|
499
|
+
npm run pack:mcpb # build the Claude Desktop .mcpb extension bundle
|
|
500
|
+
npm run dev:dashboard # frozen Next.js app, hot reload
|
|
501
|
+
|
|
502
|
+
# Develop against the fictional sample rather than your real data
|
|
503
|
+
CAREER_DATA_PATH=data/example npm run dev:dashboard
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
---
|
|
507
|
+
|
|
508
|
+
## Why Career Compass
|
|
509
|
+
|
|
510
|
+
Job searching is one of the highest-stakes, most document-intensive things most people ever
|
|
511
|
+
do — and most tools treat it as a data-entry problem. Spreadsheets for tracking. Templates
|
|
512
|
+
for résumés. Generic advice for interviews.
|
|
513
|
+
|
|
514
|
+
Career Compass treats it as a knowledge problem. Your career history is a corpus. Every
|
|
515
|
+
application is a retrieval and synthesis task. Every interview is a pattern-match against a
|
|
516
|
+
known dataset (the posting) and a known corpus (you).
|
|
517
|
+
|
|
518
|
+
The Career KB is the single source of truth — built once, enriched over time, read by every
|
|
519
|
+
tool. A tailored résumé draws from it. Interview prep draws from it. Cover letters draw from
|
|
520
|
+
it. The pipeline tracks against it. Nothing gets lost, because nothing lives in a tab you
|
|
521
|
+
will close.
|
|
522
|
+
|
|
523
|
+
---
|
|
524
|
+
|
|
525
|
+
## Contributing
|
|
526
|
+
|
|
527
|
+
[Issues](https://github.com/benskamps/career-compass-mcp/issues) and PRs welcome — bug
|
|
528
|
+
reports with a reproduction are especially useful, and they do get fixed. If you add a tool,
|
|
529
|
+
register it in `src/server.ts` and follow the
|
|
530
|
+
pattern in any existing tool file — each tool returns a structured prompt that Claude acts
|
|
531
|
+
on with the full KB in context. The test suite includes docs-truth guards, so a new tool or
|
|
532
|
+
prompt that is not documented here fails CI rather than surprising a stranger.
|
|
533
|
+
|
|
534
|
+
## License
|
|
535
|
+
|
|
536
|
+
MIT
|
|
537
|
+
|
|
538
|
+
---
|
|
539
|
+
|
|
540
|
+
*Part of the [Brokenbranch Lab](https://www.brokenbranch.dev/lab/) — Ben Schippers' workshop of AI-native tools and research.*
|