@ushiradineth/veil 0.4.1 → 0.6.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 +34 -132
- package/dist/bin.js +24 -51366
- package/package.json +32 -42
package/README.md
CHANGED
|
@@ -1,85 +1,30 @@
|
|
|
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
|
-
###
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
npx -y @ushiradineth/veil@latest init
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### Setup manually
|
|
41
|
-
|
|
42
|
-
#### Install the CLI
|
|
43
|
-
|
|
44
|
-
Package managers:
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
npm i -g @ushiradineth/veil
|
|
48
|
-
pnpm add -g @ushiradineth/veil
|
|
49
|
-
yarn global add @ushiradineth/veil
|
|
50
|
-
bun add -g @ushiradineth/veil
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Homebrew:
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
brew tap ushiradineth/homebrew https://github.com/ushiradineth/homebrew
|
|
57
|
-
brew install veil
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
#### Install the Skill (based on your preference)
|
|
61
|
-
|
|
62
|
-
CLI skill:
|
|
9
|
+
### Run MCP server
|
|
63
10
|
|
|
64
11
|
```bash
|
|
65
|
-
npx -y
|
|
12
|
+
npx -y @ushiradineth/veil@latest
|
|
66
13
|
```
|
|
67
14
|
|
|
68
|
-
MCP skill
|
|
15
|
+
### Install MCP skill
|
|
69
16
|
|
|
70
17
|
```bash
|
|
71
|
-
npx -y skills add https://github.com/ushiradineth/veil --skill veil
|
|
18
|
+
npx -y skills add https://github.com/ushiradineth/veil --skill veil
|
|
72
19
|
```
|
|
73
20
|
|
|
74
|
-
### MCP
|
|
21
|
+
### MCP client configuration
|
|
75
22
|
|
|
76
23
|
<details>
|
|
77
24
|
<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
25
|
|
|
81
26
|
```bash
|
|
82
|
-
codex mcp add veil -- npx -y @ushiradineth/veil@latest
|
|
27
|
+
codex mcp add veil -- npx -y @ushiradineth/veil@latest
|
|
83
28
|
```
|
|
84
29
|
|
|
85
30
|
</details>
|
|
@@ -87,20 +32,16 @@ codex mcp add veil -- npx -y @ushiradineth/veil@latest mcp server
|
|
|
87
32
|
<details>
|
|
88
33
|
<summary>Claude Code</summary>
|
|
89
34
|
|
|
90
|
-
Install via CLI:
|
|
91
|
-
|
|
92
35
|
```bash
|
|
93
|
-
claude mcp add --scope user veil -- npx -y @ushiradineth/veil@latest
|
|
36
|
+
claude mcp add --scope user veil -- npx -y @ushiradineth/veil@latest
|
|
94
37
|
```
|
|
95
38
|
|
|
96
|
-
See the <a href="https://code.claude.com/docs/en/mcp">Claude Code MCP guide</a> for more details.
|
|
97
|
-
|
|
98
39
|
</details>
|
|
99
40
|
|
|
100
41
|
<details>
|
|
101
42
|
<summary>OpenCode</summary>
|
|
102
43
|
|
|
103
|
-
Add
|
|
44
|
+
Add to `~/.config/opencode/opencode.json`:
|
|
104
45
|
|
|
105
46
|
```json
|
|
106
47
|
{
|
|
@@ -108,29 +49,7 @@ Add the following configuration to your `opencode.json` file. If you do not have
|
|
|
108
49
|
"mcp": {
|
|
109
50
|
"veil": {
|
|
110
51
|
"type": "local",
|
|
111
|
-
"command": ["npx", "-y", "@ushiradineth/veil@latest"
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
</details>
|
|
118
|
-
|
|
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"]
|
|
52
|
+
"command": ["npx", "-y", "@ushiradineth/veil@latest"]
|
|
134
53
|
}
|
|
135
54
|
}
|
|
136
55
|
}
|
|
@@ -138,45 +57,28 @@ Or install manually in `Cursor Settings` -> `MCP` -> `New MCP Server` with:
|
|
|
138
57
|
|
|
139
58
|
</details>
|
|
140
59
|
|
|
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
60
|
## Capabilities
|
|
148
61
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
|
|
|
166
|
-
|
|
|
167
|
-
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
| Grammar install | Enables parser IDs. | `veil grammar install --parsers js,ts` | `veil_grammar_install` |
|
|
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` |
|
|
62
|
+
| Capability | MCP tool |
|
|
63
|
+
| ----------------------------------- | ----------------------------------------------------------------------------------------- |
|
|
64
|
+
| Index status | `veil_status` |
|
|
65
|
+
| Incremental refresh | `veil_refresh` |
|
|
66
|
+
| Full rebuild | `veil_build` |
|
|
67
|
+
| Discover files/symbols/chunks | `veil_discover` |
|
|
68
|
+
| Fetch one chunk by id | `veil_chunk` |
|
|
69
|
+
| Intent-aware lookup | `veil_lookup` |
|
|
70
|
+
| File path retrieval | `veil_files` |
|
|
71
|
+
| Symbol retrieval | `veil_symbols` |
|
|
72
|
+
| Content search | `veil_search` |
|
|
73
|
+
| Grammar list/install/remove/update | `veil_grammar_list`, `veil_grammar_install`, `veil_grammar_remove`, `veil_grammar_update` |
|
|
74
|
+
| Grammar recommendation/install plan | `veil_grammar_recommend` |
|
|
75
|
+
| Grammar runtime package install | `veil_grammar_runtime_install` |
|
|
76
|
+
| Web search | `veil_web_search` |
|
|
77
|
+
| URL fetch | `veil_fetch_url` |
|
|
78
|
+
| Git status/log/diff/show | `veil_git_status`, `veil_git_log`, `veil_git_diff`, `veil_git_show` |
|
|
79
|
+
| GitHub context lookup | `veil_gh_lookup` |
|
|
80
|
+
| Diagnostics | `veil_diagnostics` |
|
|
81
|
+
|
|
82
|
+
## Note
|
|
83
|
+
|
|
84
|
+
> Veil is still experimental and under active development. Please report any issues or suggestions.
|