@txtscape/mcp 0.0.1
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 +96 -0
- package/bin/txtscape-mcp-darwin-arm64 +0 -0
- package/bin/txtscape-mcp-darwin-x64 +0 -0
- package/bin/txtscape-mcp-linux-arm64 +0 -0
- package/bin/txtscape-mcp-linux-x64 +0 -0
- package/bin/txtscape-mcp-win32-x64.exe +0 -0
- package/bin/txtscape-mcp.js +34 -0
- package/package.json +29 -0
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# @txtscape/mcp
|
|
2
|
+
|
|
3
|
+
Persistent project memory for AI agents — committable, structured, and zero-dependency.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
**Option A: use with npx (no install needed)**
|
|
8
|
+
|
|
9
|
+
Configure your MCP host to run txtscape-mcp directly via npx:
|
|
10
|
+
|
|
11
|
+
**VS Code** (`.vscode/mcp.json`):
|
|
12
|
+
```json
|
|
13
|
+
{
|
|
14
|
+
"servers": {
|
|
15
|
+
"txtscape": {
|
|
16
|
+
"type": "stdio",
|
|
17
|
+
"command": "npx",
|
|
18
|
+
"args": ["-y", "@txtscape/mcp"],
|
|
19
|
+
"cwd": "${workspaceFolder}"
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
**Option B: install globally**
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
npm install -g @txtscape/mcp
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Then configure your MCP host:
|
|
32
|
+
|
|
33
|
+
**VS Code** (`.vscode/mcp.json`):
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"servers": {
|
|
37
|
+
"txtscape": {
|
|
38
|
+
"type": "stdio",
|
|
39
|
+
"command": "txtscape-mcp",
|
|
40
|
+
"cwd": "${workspaceFolder}"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
**Cursor / Windsurf** (`.cursor/mcp.json` or `.windsurf/mcp.json`):
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"mcpServers": {
|
|
50
|
+
"txtscape": {
|
|
51
|
+
"command": "txtscape-mcp",
|
|
52
|
+
"args": []
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Claude Desktop** (`claude_desktop_config.json`):
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"mcpServers": {
|
|
62
|
+
"txtscape": {
|
|
63
|
+
"command": "txtscape-mcp",
|
|
64
|
+
"args": []
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## What it does
|
|
71
|
+
|
|
72
|
+
txtscape-mcp gives AI agents 11 tools to manage a persistent knowledge base stored as plain `.txt` files in `.txtscape/pages/`. Files are committed to git alongside your code.
|
|
73
|
+
|
|
74
|
+
| Tool | Description |
|
|
75
|
+
|---|---|
|
|
76
|
+
| `put_page` | Create or replace a page |
|
|
77
|
+
| `get_page` | Read a page |
|
|
78
|
+
| `str_replace_page` | Edit a page surgically |
|
|
79
|
+
| `list_pages` | Browse directory with previews |
|
|
80
|
+
| `search_pages` | Full-text search |
|
|
81
|
+
| `delete_page` | Delete a page |
|
|
82
|
+
| `rename_page` | Move or rename a page |
|
|
83
|
+
| `snapshot` | Load all pages in one call |
|
|
84
|
+
| `related_pages` | Find cross-referenced pages |
|
|
85
|
+
| `page_history` | Inspect git commit history |
|
|
86
|
+
| `mcp_append_page` | Append content to a page |
|
|
87
|
+
|
|
88
|
+
## Supported platforms
|
|
89
|
+
|
|
90
|
+
- macOS ARM64 (Apple Silicon)
|
|
91
|
+
- macOS x64
|
|
92
|
+
- Linux x64
|
|
93
|
+
- Linux ARM64
|
|
94
|
+
- Windows x64
|
|
95
|
+
|
|
96
|
+
All platform binaries are bundled in this package. The correct one is selected automatically at runtime.
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
'use strict';
|
|
3
|
+
|
|
4
|
+
const { spawn } = require('child_process');
|
|
5
|
+
const path = require('path');
|
|
6
|
+
const os = require('os');
|
|
7
|
+
|
|
8
|
+
const BINARIES = {
|
|
9
|
+
'darwin-arm64': 'txtscape-mcp-darwin-arm64',
|
|
10
|
+
'darwin-x64': 'txtscape-mcp-darwin-x64',
|
|
11
|
+
'linux-x64': 'txtscape-mcp-linux-x64',
|
|
12
|
+
'linux-arm64': 'txtscape-mcp-linux-arm64',
|
|
13
|
+
'win32-x64': 'txtscape-mcp-win32-x64.exe',
|
|
14
|
+
};
|
|
15
|
+
|
|
16
|
+
const key = `${os.platform()}-${os.arch()}`;
|
|
17
|
+
const name = BINARIES[key];
|
|
18
|
+
|
|
19
|
+
if (!name) {
|
|
20
|
+
process.stderr.write(`txtscape-mcp: unsupported platform: ${key}\n`);
|
|
21
|
+
process.exit(1);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const binary = path.join(__dirname, name);
|
|
25
|
+
|
|
26
|
+
const child = spawn(binary, process.argv.slice(2), { stdio: 'inherit' });
|
|
27
|
+
|
|
28
|
+
child.on('exit', (code, signal) => {
|
|
29
|
+
if (signal) {
|
|
30
|
+
process.kill(process.pid, signal);
|
|
31
|
+
} else {
|
|
32
|
+
process.exit(code ?? 1);
|
|
33
|
+
}
|
|
34
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@txtscape/mcp",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Persistent project memory for AI agents — committable, local, zero-dependency.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"mcp",
|
|
7
|
+
"ai",
|
|
8
|
+
"agents",
|
|
9
|
+
"memory",
|
|
10
|
+
"context",
|
|
11
|
+
"llm"
|
|
12
|
+
],
|
|
13
|
+
"homepage": "https://txtscape.com",
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "https://github.com/txtscape/txtscape.com.git",
|
|
17
|
+
"directory": "txtscape-mcp/npm/txtscape-mcp"
|
|
18
|
+
},
|
|
19
|
+
"license": "MIT",
|
|
20
|
+
"bin": {
|
|
21
|
+
"txtscape-mcp": "bin/txtscape-mcp.js"
|
|
22
|
+
},
|
|
23
|
+
"files": [
|
|
24
|
+
"bin/"
|
|
25
|
+
],
|
|
26
|
+
"engines": {
|
|
27
|
+
"node": ">=16"
|
|
28
|
+
}
|
|
29
|
+
}
|