Skip to content

Commit ae85be0

Browse files
committed
fix: restore README UTF-8 encoding and correct harness badge level
1 parent 9a0d07a commit ae85be0

1 file changed

Lines changed: 51 additions & 52 deletions

File tree

README.md

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
<p align="center">
2-
1+
<p align="center">
32
<img alt="Harness Score L1" src="https://paladini.github.io/harness-score/maturity/badge-l1.svg" height="20">
4-
<img src="docs/assets/og-image.svg" alt="mcp-me — Your Digital Identity Layer for AI" width="100%">
3+
<img src="docs/assets/og-image.svg" alt="mcp-me ÔÇö Your Digital Identity Layer for AI" width="100%">
54
</p>
65

76
# mcp-me
87

9-
**Your AI assistants don't know who you are.** Every time you start a conversation with Claude, Copilot, Cursor, or Windsurf, it's a blank slate — no context about your skills, your projects, your career, or what you care about.
8+
**Your AI assistants don't know who you are.** Every time you start a conversation with Claude, Copilot, Cursor, or Windsurf, it's a blank slate ÔÇö no context about your skills, your projects, your career, or what you care about.
109

11-
**mcp-me fixes that.** It creates a structured personal profile that any AI assistant can read via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/). Think of it as a **digital identity layer for AI** — your bio, career, skills, interests, projects, and more, always available to every AI tool you use.
10+
**mcp-me fixes that.** It creates a structured personal profile that any AI assistant can read via the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/). Think of it as a **digital identity layer for AI** ÔÇö your bio, career, skills, interests, projects, and more, always available to every AI tool you use.
1211

1312
```
1413
You: "Write me a cover letter for this job"
@@ -19,20 +18,20 @@ AI: (reads your me://career, me://skills, me://projects)
1918

2019
## Why mcp-me?
2120

22-
- **AI that knows you** — Your assistants remember your skills, career, projects, and personality across every conversation
23-
- **Auto-generated** — Pull data from 329 registered generators (implemented across 44 generator source files) with one command
24-
- **Privacy-first** — All data stays local in YAML files on your machine. Nothing is sent to any cloud.
25-
- **Real-time plugins** — 13 live integrations (Spotify now playing, GitHub repos, Last.fm scrobbles) that AI queries on demand
26-
- **Extensible** — Community-driven generators and plugins. Add a new data source in ~10 lines of code.
27-
- **Works everywhere** — Claude Desktop, Cursor, Windsurf, Copilot, and any MCP-compatible AI assistant
21+
- **AI that knows you** ÔÇö Your assistants remember your skills, career, projects, and personality across every conversation
22+
- **Auto-generated** ÔÇö Pull data from 329 registered generators (implemented across 44 generator source files) with one command
23+
- **Privacy-first** ÔÇö All data stays local in YAML files on your machine. Nothing is sent to any cloud.
24+
- **Real-time plugins** ÔÇö 13 live integrations (Spotify now playing, GitHub repos, Last.fm scrobbles) that AI queries on demand
25+
- **Extensible** ÔÇö Community-driven generators and plugins. Add a new data source in ~10 lines of code.
26+
- **Works everywhere** ÔÇö Claude Desktop, Cursor, Windsurf, Copilot, and any MCP-compatible AI assistant
2827

2928
## Installation
3029

3130
> **Prerequisite:** [Node.js](https://nodejs.org/) 20 or later. Verify with `node -v`.
3231
3332
### One-Click Install
3433

35-
Add mcp-me to your AI assistant in one click — no path configuration needed (profile defaults to `~/.mcp-me`):
34+
Add mcp-me to your AI assistant in one click ÔÇö no path configuration needed (profile defaults to `~/.mcp-me`):
3635

3736
<p align="center">
3837
<a href="https://cursor.com/install-mcp?name=me&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIm1jcC1tZSIsInNlcnZlIl19">
@@ -44,7 +43,7 @@ Add mcp-me to your AI assistant in one click — no path configuration need
4443
</a>
4544
</p>
4645

47-
**Claude Desktop:** Download the [latest `.mcpb` release](https://github.com/paladini/mcp-me/releases/latest) and double-click to install, or drag it into Claude Desktop → Settings → Extensions.
46+
**Claude Desktop:** Download the [latest `.mcpb` release](https://github.com/paladini/mcp-me/releases/latest) and double-click to install, or drag it into Claude Desktop  Settings  Extensions.
4847

4948
After installing, initialize your profile:
5049

@@ -59,7 +58,7 @@ mcp-me generate --github your-username
5958
npm install -g mcp-me
6059
```
6160

62-
This makes the `mcp-me` command available everywhere on your system. No need to clone any repository — npm downloads the package for you.
61+
This makes the `mcp-me` command available everywhere on your system. No need to clone any repository ÔÇö npm downloads the package for you.
6362

6463
```bash
6564
mcp-me --help
@@ -68,7 +67,7 @@ mcp-me generate --github your-username
6867
mcp-me serve
6968
```
7069

71-
**Alternative — run without installing** (via `npx`):
70+
**Alternative ÔÇö run without installing** (via `npx`):
7271

7372
```bash
7473
npx mcp-me --help
@@ -84,7 +83,7 @@ npx mcp-me --help
8483
# 1. Initialize your profile (creates YAML templates + .mcp-me.yaml in ~/.mcp-me)
8584
mcp-me init
8685

87-
# 2. Edit the config file — uncomment your sources
86+
# 2. Edit the config file ÔÇö uncomment your sources
8887
code ~/.mcp-me/.mcp-me.yaml
8988
```
9089

@@ -113,21 +112,21 @@ mcp-me serve
113112

114113
> **CLI flags also work:** `mcp-me generate --github octocat --devto myuser`
115114
116-
All commands work with `npx` (zero install) or with `mcp-me` directly if installed globally. The `generate` command pulls your data from public APIs and auto-populates profile YAML files — no API keys needed for most sources.
115+
All commands work with `npx` (zero install) or with `mcp-me` directly if installed globally. The `generate` command pulls your data from public APIs and auto-populates profile YAML files ÔÇö no API keys needed for most sources.
117116

118117
### Profile directory structure
119118

120119
```
121-
~/.mcp-me/ ← Default profile location
122-
.mcp-me.yaml ← Configuration (generators + plugins)
123-
identity.yaml ← Your data (name, bio, contact)
124-
skills.yaml ← Your data (languages, tools)
125-
projects.yaml ← Your data (portfolio)
126-
career.yaml ← Your data (experience)
127-
interests.yaml ← Your data (hobbies, topics)
128-
personality.yaml ← Your data (traits, values)
129-
goals.yaml ← Your data (short/long-term)
130-
faq.yaml ← Your data (Q&A pairs)
120+
~/.mcp-me/  Default profile location
121+
.mcp-me.yaml  Configuration (generators + plugins)
122+
identity.yaml  Your data (name, bio, contact)
123+
skills.yaml  Your data (languages, tools)
124+
projects.yaml  Your data (portfolio)
125+
career.yaml  Your data (experience)
126+
interests.yaml  Your data (hobbies, topics)
127+
personality.yaml  Your data (traits, values)
128+
goals.yaml  Your data (short/long-term)
129+
faq.yaml  Your data (Q&A pairs)
131130
```
132131

133132
## Configure Your AI Assistant
@@ -138,7 +137,7 @@ Use the [one-click install badges](#one-click-install) above. After installing,
138137

139138
### Cursor Plugin (Open Plugins)
140139

141-
mcp-me ships as a full [Open Plugins](https://open-plugins.com) plugin for Cursor. Install from [cursor.directory](https://cursor.directory) or clone the repo — the plugin auto-detects all components:
140+
mcp-me ships as a full [Open Plugins](https://open-plugins.com) plugin for Cursor. Install from [cursor.directory](https://cursor.directory) or clone the repo ÔÇö the plugin auto-detects all components:
142141

143142
| Component | Location | Purpose |
144143
|---|---|---|
@@ -197,18 +196,18 @@ Add to `.vscode/mcp.json` in your project root (or in your User Settings for glo
197196
}
198197
```
199198

200-
> **Tip:** To enable it globally (all workspaces), open VS Code Settings (`Ctrl+Shift+P` → "Preferences: Open User Settings (JSON)") and add the `mcp` key there instead.
199+
> **Tip:** To enable it globally (all workspaces), open VS Code Settings (`Ctrl+Shift+P`  "Preferences: Open User Settings (JSON)") and add the `mcp` key there instead.
201200
202201
### Claude Desktop
203202

204-
**Option A — Desktop Extension (.mcpb, recommended):**
203+
**Option A ÔÇö Desktop Extension (.mcpb, recommended):**
205204

206205
1. Download `mcp-me.mcpb` from [GitHub Releases](https://github.com/paladini/mcp-me/releases/latest)
207-
2. Double-click the file, or drag it into Claude Desktop → Settings → Extensions
206+
2. Double-click the file, or drag it into Claude Desktop  Settings  Extensions
208207
3. Set your profile directory when prompted (default: `~/.mcp-me`)
209208
4. Run `mcp-me init` if you haven't created a profile yet
210209

211-
**Option B — Manual config:**
210+
**Option B ÔÇö Manual config:**
212211

213212
Add to your Claude Desktop config:
214213

@@ -225,7 +224,7 @@ Add to your Claude Desktop config:
225224

226225
## Agent Instruction Files
227226

228-
AI agents read special Markdown files in your project to understand how they should behave. Pair them with mcp-me so that **every AI session automatically consults your profile** — no more repeating your stack, career, or preferences in every conversation.
227+
AI agents read special Markdown files in your project to understand how they should behave. Pair them with mcp-me so that **every AI session automatically consults your profile** ÔÇö no more repeating your stack, career, or preferences in every conversation.
229228

230229
| File | Works with |
231230
|------|------------|
@@ -235,7 +234,7 @@ AI agents read special Markdown files in your project to understand how they sho
235234
**Quick setup:**
236235

237236
```bash
238-
# AGENTS.md — for Windsurf, Cline, Codex, etc.
237+
# AGENTS.md ÔÇö for Windsurf, Cline, Codex, etc.
239238
cp "$(npm root -g)/mcp-me/templates/AGENTS.md" ./AGENTS.md
240239

241240
# GitHub Copilot
@@ -270,26 +269,26 @@ See [Schema Reference](docs/schema-reference.md) for full documentation.
270269

271270
Static profile data exposed as MCP resources:
272271

273-
- `me://identity` — Personal identity and contact
274-
- `me://career` — Professional history
275-
- `me://skills` — Skills and proficiencies
276-
- `me://interests` — Hobbies and preferences
277-
- `me://personality` — Personality traits and values
278-
- `me://goals` — Personal and professional goals
279-
- `me://projects` — Portfolio and projects
280-
- `me://faq` — Frequently asked questions
272+
- `me://identity` ÔÇö Personal identity and contact
273+
- `me://career` ÔÇö Professional history
274+
- `me://skills` ÔÇö Skills and proficiencies
275+
- `me://interests` ÔÇö Hobbies and preferences
276+
- `me://personality` ÔÇö Personality traits and values
277+
- `me://goals` ÔÇö Personal and professional goals
278+
- `me://projects` ÔÇö Portfolio and projects
279+
- `me://faq` ÔÇö Frequently asked questions
281280

282281
### Tools
283282

284-
- **`ask_about_me`** — Free-form question about the user
285-
- **`search_profile`** — Keyword search across all profile data
283+
- **`ask_about_me`** ÔÇö Free-form question about the user
284+
- **`search_profile`** ÔÇö Keyword search across all profile data
286285

287286
### Prompts
288287

289-
- **`introduce_me`** — Generate a 2-paragraph introduction
290-
- **`summarize_career`** — Summarize career trajectory
291-
- **`technical_profile`** — Describe technical skills and stack
292-
- **`collaboration_fit`** — Evaluate fit for a project
288+
- **`introduce_me`** ÔÇö Generate a 2-paragraph introduction
289+
- **`summarize_career`** ÔÇö Summarize career trajectory
290+
- **`technical_profile`** ÔÇö Describe technical skills and stack
291+
- **`collaboration_fit`** ÔÇö Evaluate fit for a project
293292

294293
## Generators (selected examples)
295294

@@ -470,26 +469,26 @@ npm run dev
470469
MCP is an open standard by Anthropic that connects AI assistants to external data sources. mcp-me uses MCP to let AI assistants read your personal profile data.
471470

472471
**Do I need API keys?**
473-
Most generators use public APIs with no auth needed. Some (Strava, Spotify) require tokens — see the `.mcp-me.yaml` comments for details.
472+
Most generators use public APIs with no auth needed. Some (Strava, Spotify) require tokens ÔÇö see the `.mcp-me.yaml` comments for details.
474473

475474
**Can I use this with Claude Desktop / VS Code / Cursor / Windsurf?**
476475
Yes! Any MCP-compatible AI assistant works. See the [Configure Your AI Assistant](#configure-your-ai-assistant) section.
477476

478477
**How do I make AI agents use my profile automatically?**
479-
Drop an `AGENTS.md` (for Windsurf, Cline, Codex) or `.github/copilot-instructions.md` (for GitHub Copilot) into your project. Templates are included — see the [Agent Instructions Guide](docs/ai-instructions.md).
478+
Drop an `AGENTS.md` (for Windsurf, Cline, Codex) or `.github/copilot-instructions.md` (for GitHub Copilot) into your project. Templates are included ÔÇö see the [Agent Instructions Guide](docs/ai-instructions.md).
480479

481480
**How do I add a new data source?**
482481
Run `mcp-me create generator myservice` to scaffold a new generator, or see the [Generator Creation Guide](docs/creating-generators.md).
483482

484483
**Is my data stored anywhere?**
485-
No. All data stays local in your YAML files. The MCP server reads from disk — nothing is sent to any cloud.
484+
No. All data stays local in your YAML files. The MCP server reads from disk ÔÇö nothing is sent to any cloud.
486485

487486
**How many generators are there?**
488487
Currently 329 registered generators, implemented across 44 generator source files plus 15 batch files.
489488

490489
## Contributing
491490

492-
We welcome contributions! Whether it's a new plugin, a bug fix, or documentation improvements — see [CONTRIBUTING.md](.github/CONTRIBUTING.md) for guidelines.
491+
We welcome contributions! Whether it's a new plugin, a bug fix, or documentation improvements ÔÇö see [CONTRIBUTING.md](.github/CONTRIBUTING.md) for guidelines.
493492

494493
Maintainers: see [Publishing Guide](docs/publishing.md) for release and distribution instructions.
495494

0 commit comments

Comments
 (0)