@ushiradineth/veil 0.4.1 → 0.6.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 +39 -124
- package/dist/bin.js +41533 -49494
- package/package.json +2 -15
package/README.md
CHANGED
|
@@ -1,85 +1,42 @@
|
|
|
1
1
|
# Veil Agent Toolkit
|
|
2
2
|
|
|
3
|
-
Veil
|
|
3
|
+
Veil is an MCP-first retrieval toolkit for coding agents.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
- search too many files
|
|
8
|
-
- guess where symbols are
|
|
9
|
-
- repeat the same scans after each change
|
|
10
|
-
|
|
11
|
-
With Veil, agents can:
|
|
12
|
-
|
|
13
|
-
- use `discover` to get files, symbols, and code chunks in one step
|
|
14
|
-
- use `lookup` to get the most relevant context for the task
|
|
15
|
-
- use `files`, `symbols`, and `search` for focused follow-up
|
|
16
|
-
- use built-in git and web tools instead of ad hoc shell commands
|
|
17
|
-
|
|
18
|
-
Agents should:
|
|
19
|
-
|
|
20
|
-
- Start broad with `discover`
|
|
21
|
-
- Narrow with `lookup`, `search`, `files`, or `symbols`
|
|
22
|
-
- Use built-in git and web commands instead of ad hoc shell fallbacks
|
|
23
|
-
|
|
24
|
-
## What It Is For
|
|
25
|
-
|
|
26
|
-
Veil is built for agents that need to move from prompt to implementation quickly.
|
|
27
|
-
|
|
28
|
-
It gives the agent indexed access to files, symbols, and relevant code chunks, so it can retrieve precise context before writing code. This reduces broad file reads and repeated text scans, improves token efficiency, and shortens time to first meaningful code change.
|
|
29
|
-
|
|
30
|
-
In practice, Veil acts as a local retrieval layer for coding agents: discover where code lives, resolve symbols, pull focused context, then execute edits.
|
|
5
|
+
It provides one compact tool surface for local code retrieval, git context, web context, and GitHub context.
|
|
31
6
|
|
|
32
7
|
## Setup
|
|
33
8
|
|
|
34
|
-
###
|
|
9
|
+
### Run MCP server
|
|
35
10
|
|
|
36
11
|
```bash
|
|
37
|
-
npx -y @ushiradineth/veil@latest
|
|
12
|
+
npx -y @ushiradineth/veil@latest
|
|
38
13
|
```
|
|
39
14
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
#### Install the CLI
|
|
43
|
-
|
|
44
|
-
Package managers:
|
|
15
|
+
Local dev:
|
|
45
16
|
|
|
46
17
|
```bash
|
|
47
|
-
|
|
48
|
-
pnpm add -g @ushiradineth/veil
|
|
49
|
-
yarn global add @ushiradineth/veil
|
|
50
|
-
bun add -g @ushiradineth/veil
|
|
18
|
+
nix run nixpkgs#bun -- run src/bin.ts
|
|
51
19
|
```
|
|
52
20
|
|
|
53
|
-
|
|
21
|
+
Optional Streamable HTTP mode:
|
|
54
22
|
|
|
55
23
|
```bash
|
|
56
|
-
|
|
57
|
-
brew install veil
|
|
24
|
+
VEIL_HTTP=1 npx -y @ushiradineth/veil@latest
|
|
58
25
|
```
|
|
59
26
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
CLI skill:
|
|
27
|
+
### Install MCP skill
|
|
63
28
|
|
|
64
29
|
```bash
|
|
65
|
-
npx -y skills add https://github.com/ushiradineth/veil --skill veil
|
|
30
|
+
npx -y skills add https://github.com/ushiradineth/veil --skill veil
|
|
66
31
|
```
|
|
67
32
|
|
|
68
|
-
MCP
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
npx -y skills add https://github.com/ushiradineth/veil --skill veil-mcp
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
### MCP Client Configuration
|
|
33
|
+
### MCP client configuration
|
|
75
34
|
|
|
76
35
|
<details>
|
|
77
36
|
<summary>Codex</summary>
|
|
78
|
-
Follow the <a href="https://developers.openai.com/codex/mcp/#configure-with-the-cli">configure MCP guide</a>
|
|
79
|
-
using the standard config from above. You can also install Veil using the Codex CLI:
|
|
80
37
|
|
|
81
38
|
```bash
|
|
82
|
-
codex mcp add veil -- npx -y @ushiradineth/veil@latest
|
|
39
|
+
codex mcp add veil -- npx -y @ushiradineth/veil@latest
|
|
83
40
|
```
|
|
84
41
|
|
|
85
42
|
</details>
|
|
@@ -87,20 +44,16 @@ codex mcp add veil -- npx -y @ushiradineth/veil@latest mcp server
|
|
|
87
44
|
<details>
|
|
88
45
|
<summary>Claude Code</summary>
|
|
89
46
|
|
|
90
|
-
Install via CLI:
|
|
91
|
-
|
|
92
47
|
```bash
|
|
93
|
-
claude mcp add --scope user veil -- npx -y @ushiradineth/veil@latest
|
|
48
|
+
claude mcp add --scope user veil -- npx -y @ushiradineth/veil@latest
|
|
94
49
|
```
|
|
95
50
|
|
|
96
|
-
See the <a href="https://code.claude.com/docs/en/mcp">Claude Code MCP guide</a> for more details.
|
|
97
|
-
|
|
98
51
|
</details>
|
|
99
52
|
|
|
100
53
|
<details>
|
|
101
54
|
<summary>OpenCode</summary>
|
|
102
55
|
|
|
103
|
-
Add
|
|
56
|
+
Add to `~/.config/opencode/opencode.json`:
|
|
104
57
|
|
|
105
58
|
```json
|
|
106
59
|
{
|
|
@@ -108,7 +61,7 @@ Add the following configuration to your `opencode.json` file. If you do not have
|
|
|
108
61
|
"mcp": {
|
|
109
62
|
"veil": {
|
|
110
63
|
"type": "local",
|
|
111
|
-
"command": ["npx", "-y", "@ushiradineth/veil@latest"
|
|
64
|
+
"command": ["npx", "-y", "@ushiradineth/veil@latest"]
|
|
112
65
|
}
|
|
113
66
|
}
|
|
114
67
|
}
|
|
@@ -116,67 +69,29 @@ Add the following configuration to your `opencode.json` file. If you do not have
|
|
|
116
69
|
|
|
117
70
|
</details>
|
|
118
71
|
|
|
119
|
-
<details>
|
|
120
|
-
<summary>Cursor</summary>
|
|
121
|
-
|
|
122
|
-
Click to install:
|
|
123
|
-
|
|
124
|
-
[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=veil&config=eyJjb21tYW5kIjoibnB4IC15IEB1c2hpcmFkaW5ldGgvdmVpbEBsYXRlc3QgbWNwIHNlcnZlciJ9)
|
|
125
|
-
|
|
126
|
-
Or install manually in `Cursor Settings` -> `MCP` -> `New MCP Server` with:
|
|
127
|
-
|
|
128
|
-
```json
|
|
129
|
-
{
|
|
130
|
-
"mcpServers": {
|
|
131
|
-
"veil": {
|
|
132
|
-
"command": "npx",
|
|
133
|
-
"args": ["-y", "@ushiradineth/veil@latest", "mcp", "server"]
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
}
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
</details>
|
|
140
|
-
|
|
141
|
-
<details>
|
|
142
|
-
<summary>Windsurf</summary>
|
|
143
|
-
Follow the <a href="https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json">configure MCP guide</a>
|
|
144
|
-
using the standard config from above.
|
|
145
|
-
</details>
|
|
146
|
-
|
|
147
72
|
## Capabilities
|
|
148
73
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
| Grammar remove | Disables parser IDs. | `veil grammar remove --parsers ts` | `veil_grammar_remove` |
|
|
174
|
-
| Grammar update | Refreshes parser metadata for selected or all installed IDs. | `veil grammar update --all` | `veil_grammar_update` |
|
|
175
|
-
| Web search | Runs multi-provider web search for external context. | `veil web-search --query "<query>"` | `veil_web_search` |
|
|
176
|
-
| URL fetch and markdown normalization | Fetches web content and normalizes output for agent-friendly reading. | `veil fetch-url --url <url> --format markdown` | `veil_fetch_url` |
|
|
177
|
-
| Git status | Shows branch state, dirty files, and untracked changes. | `veil git-status --workspace .` | `veil_git_status` |
|
|
178
|
-
| Git log | Returns recent commits with metadata for project history checks. | `veil git-log --workspace . --limit 10` | `veil_git_log` |
|
|
179
|
-
| Git diff | Returns working tree or revision-range diffs. | `veil git-diff --workspace .` | `veil_git_diff` |
|
|
180
|
-
| Git show | Shows full details for a specific revision. | `veil git-show --workspace . --rev HEAD` | `veil_git_show` |
|
|
181
|
-
| GitHub context lookup | Pulls repository or pull request context via `gh` integration. | `veil gh-lookup --repo <owner/repo> --kind repo_context` | `veil_gh_lookup` |
|
|
182
|
-
| Runtime diagnostics | Surfaces cache counters and latency diagnostics, with optional reset. | `veil diagnostics [--reset]` | `veil_diagnostics` |
|
|
74
|
+
| Capability | MCP tool |
|
|
75
|
+
| ---------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
76
|
+
| Index status | `veil_status` |
|
|
77
|
+
| Incremental refresh | `veil_refresh` |
|
|
78
|
+
| Full rebuild | `veil_build` |
|
|
79
|
+
| Discover files/symbols/chunks | `veil_discover` |
|
|
80
|
+
| Fetch one chunk by id | `veil_chunk` |
|
|
81
|
+
| Intent-aware lookup | `veil_lookup` |
|
|
82
|
+
| File path retrieval | `veil_files` |
|
|
83
|
+
| Symbol retrieval | `veil_symbols` |
|
|
84
|
+
| Content search | `veil_search` |
|
|
85
|
+
| Grammar list/install/remove/update | `veil_grammar_list`, `veil_grammar_install`, `veil_grammar_remove`, `veil_grammar_update` |
|
|
86
|
+
| Web search | `veil_web_search` |
|
|
87
|
+
| URL fetch | `veil_fetch_url` |
|
|
88
|
+
| Git status/log/diff/show | `veil_git_status`, `veil_git_log`, `veil_git_diff`, `veil_git_show` |
|
|
89
|
+
| GitHub context lookup | `veil_gh_lookup` |
|
|
90
|
+
| Diagnostics | `veil_diagnostics` |
|
|
91
|
+
|
|
92
|
+
## Notes
|
|
93
|
+
|
|
94
|
+
- MCP responses are TOON text and compact by default.
|
|
95
|
+
- Retrieval tools auto-refresh on stale or dirty worktrees by default.
|
|
96
|
+
- Full chunk content is opt-in on retrieval calls via `include_content`.
|
|
97
|
+
- `veil_fetch_url` blocks private/local network targets by default unless explicitly allowed.
|