tokenos 1.1.1 → 1.1.2
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 +38 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# TokenOS
|
|
2
2
|
|
|
3
|
+
[](https://badge.fury.io/js/tokenos)
|
|
4
|
+
|
|
3
5
|
> **Local-first codebase graph intelligence for AI assistants — powered by SQLite, ts-morph, and Ollama.**
|
|
4
6
|
|
|
5
7
|
`TokenOS` is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that statically analyses your TypeScript/TSX codebase, stores it as a structural dependency graph in SQLite, optionally enriches nodes with semantic embeddings via Ollama, and exposes high-precision query tools for AI coding assistants like Claude, Cursor, or any MCP-compatible client.
|
|
@@ -33,36 +35,14 @@
|
|
|
33
35
|
|
|
34
36
|
## Quick Start
|
|
35
37
|
|
|
36
|
-
|
|
38
|
+
Run TokenOS on any codebase instantly via `npx`. No installation, setup, or config files required!
|
|
37
39
|
|
|
38
40
|
```bash
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
npm install
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### 2. Configure
|
|
45
|
-
|
|
46
|
-
Edit `tokenos.config.json` in the project root:
|
|
41
|
+
# In your project folder
|
|
42
|
+
npx -y tokenos .
|
|
47
43
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
"watchPath": "/absolute/path/to/your/project",
|
|
51
|
-
"ollama": {
|
|
52
|
-
"url": "http://localhost:11434",
|
|
53
|
-
"model": "mxbai-embed-large:latest"
|
|
54
|
-
},
|
|
55
|
-
"ui": {
|
|
56
|
-
"enabled": false,
|
|
57
|
-
"port": 3333
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### 3. Run
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
npm run dev
|
|
44
|
+
# Or for a specific path
|
|
45
|
+
npx -y tokenos /absolute/path/to/project
|
|
66
46
|
```
|
|
67
47
|
|
|
68
48
|
That's it. The server will:
|
|
@@ -84,10 +64,11 @@ That's it. The server will:
|
|
|
84
64
|
|
|
85
65
|
| Command | Description |
|
|
86
66
|
|---|---|
|
|
87
|
-
| `
|
|
88
|
-
| `
|
|
89
|
-
| `
|
|
90
|
-
| `npm run
|
|
67
|
+
| `npx -y tokenos .` | Index the current folder and start the MCP server |
|
|
68
|
+
| `npx -y tokenos /path` | Index a specific folder and start the server |
|
|
69
|
+
| `npx tokenos --version` | Print the installed version |
|
|
70
|
+
| `npm run dev` | *(Cloned repo only)* Start in local development mode |
|
|
71
|
+
| `npm run reset` | *(Cloned repo only)* Wipe the development database |
|
|
91
72
|
|
|
92
73
|
---
|
|
93
74
|
|
|
@@ -120,36 +101,52 @@ Three tables are created automatically:
|
|
|
120
101
|
|
|
121
102
|
## MCP Client Configuration
|
|
122
103
|
|
|
123
|
-
|
|
104
|
+
You can add multiple entries — one for each project you want AI access to. They do not conflict, as each creates an isolated database inside its respective project folder.
|
|
124
105
|
|
|
125
|
-
|
|
106
|
+
### Antigravity IDE
|
|
107
|
+
|
|
108
|
+
Open `~/.gemini/antigravity/mcp_config.json` and add your projects under `mcpServers`:
|
|
126
109
|
|
|
127
110
|
```json
|
|
128
111
|
{
|
|
129
112
|
"mcpServers": {
|
|
130
|
-
"tokenos": {
|
|
131
|
-
"command": "
|
|
132
|
-
"args": ["/absolute/path/to/
|
|
113
|
+
"tokenos-myapp": {
|
|
114
|
+
"command": "npx",
|
|
115
|
+
"args": ["-y", "tokenos", "/absolute/path/to/myapp"],
|
|
116
|
+
"env": {}
|
|
133
117
|
}
|
|
134
118
|
}
|
|
135
119
|
}
|
|
136
120
|
```
|
|
137
121
|
|
|
138
|
-
###
|
|
122
|
+
### Claude Code
|
|
123
|
+
|
|
124
|
+
Open `~/.claude.json` and add underneath `"mcpServers"`:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
"tokenos-myapp": {
|
|
128
|
+
"type": "stdio",
|
|
129
|
+
"command": "npx",
|
|
130
|
+
"args": ["-y", "tokenos", "/absolute/path/to/myapp"],
|
|
131
|
+
"env": {}
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Claude Desktop
|
|
136
|
+
|
|
137
|
+
Open `~/Library/Application Support/Claude/claude_desktop_config.json` and add:
|
|
139
138
|
|
|
140
139
|
```json
|
|
141
140
|
{
|
|
142
141
|
"mcpServers": {
|
|
143
|
-
"tokenos": {
|
|
142
|
+
"tokenos-myapp": {
|
|
144
143
|
"command": "npx",
|
|
145
|
-
"args": ["
|
|
144
|
+
"args": ["-y", "tokenos", "/absolute/path/to/myapp"]
|
|
146
145
|
}
|
|
147
146
|
}
|
|
148
147
|
}
|
|
149
148
|
```
|
|
150
149
|
|
|
151
|
-
> **Note:** No need to pass the project path as CLI arg — it reads from `tokenos.config.json`.
|
|
152
|
-
|
|
153
150
|
---
|
|
154
151
|
|
|
155
152
|
## MCP Tools
|