@guildai/cli 0.5.9 → 0.5.10
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 +28 -1
- package/dist/commands/setup.js +11 -4
- package/docs/CLI_WORKFLOW.md +6 -0
- package/docs/DESIGN.md +2 -0
- package/docs/skills/agent-dev.md +6 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -210,8 +210,35 @@ guild version # Show version info
|
|
|
210
210
|
### Coding Assistant Skills
|
|
211
211
|
|
|
212
212
|
```bash
|
|
213
|
-
guild setup # Install
|
|
213
|
+
guild setup # Install skills + configure MCP server
|
|
214
214
|
guild setup --claude-md # Also create a CLAUDE.md template
|
|
215
|
+
guild setup --no-mcp # Install skills only, skip MCP configuration
|
|
216
|
+
guild mcp # Start MCP server (used by Claude Code, etc.)
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### MCP Server
|
|
220
|
+
|
|
221
|
+
The CLI includes an [MCP](https://modelcontextprotocol.io/) server that exposes Guild's API to AI coding assistants like Claude Code.
|
|
222
|
+
|
|
223
|
+
**Setup:**
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
guild setup
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
This installs Claude Code skills and adds a `guild` entry to `.mcp.json` in your project. Claude Code (and other MCP-compatible tools) will automatically connect when they detect it.
|
|
230
|
+
|
|
231
|
+
**What it provides:**
|
|
232
|
+
|
|
233
|
+
- 24 tools: workspaces, agents, sessions, triggers, contexts, credentials
|
|
234
|
+
- 2 resources: current workspace info and installed agents
|
|
235
|
+
- All tools use your `guild auth` credentials automatically
|
|
236
|
+
|
|
237
|
+
**Manual start (for debugging):**
|
|
238
|
+
|
|
239
|
+
```bash
|
|
240
|
+
guild mcp
|
|
241
|
+
guild mcp --debug # Verbose logging to stderr
|
|
215
242
|
```
|
|
216
243
|
|
|
217
244
|
## Configuration
|
package/dist/commands/setup.js
CHANGED
|
@@ -60,8 +60,8 @@ async function setupMcp(options) {
|
|
|
60
60
|
const content = await fs.readFile(mcpPath, 'utf-8');
|
|
61
61
|
existing = JSON.parse(content);
|
|
62
62
|
if (existing.mcpServers && 'guild' in existing.mcpServers && !options.force) {
|
|
63
|
-
output.progress('Guild
|
|
64
|
-
return;
|
|
63
|
+
output.progress('.mcp.json already has Guild server (use --force to overwrite)');
|
|
64
|
+
return 'skipped';
|
|
65
65
|
}
|
|
66
66
|
}
|
|
67
67
|
const updated = {
|
|
@@ -78,6 +78,7 @@ async function setupMcp(options) {
|
|
|
78
78
|
else {
|
|
79
79
|
output.success('Created .mcp.json with Guild MCP server');
|
|
80
80
|
}
|
|
81
|
+
return 'created';
|
|
81
82
|
}
|
|
82
83
|
async function setup(options) {
|
|
83
84
|
const output = createOutputWriter();
|
|
@@ -116,7 +117,13 @@ async function setup(options) {
|
|
|
116
117
|
}
|
|
117
118
|
// Handle --mcp flag
|
|
118
119
|
if (options.mcp) {
|
|
119
|
-
await setupMcp({ force: options.force });
|
|
120
|
+
const result = await setupMcp({ force: options.force });
|
|
121
|
+
if (result === 'created') {
|
|
122
|
+
filesCreated++;
|
|
123
|
+
}
|
|
124
|
+
else {
|
|
125
|
+
filesSkipped++;
|
|
126
|
+
}
|
|
120
127
|
}
|
|
121
128
|
// Handle CLAUDE.md template
|
|
122
129
|
if (options.claudeMd) {
|
|
@@ -155,7 +162,7 @@ export function createSetupCommand() {
|
|
|
155
162
|
.description('Set up Guild CLI skills for coding assistants (Claude Code, etc.)')
|
|
156
163
|
.option('--force', 'Overwrite existing skill files', false)
|
|
157
164
|
.option('--claude-md', 'Also create a CLAUDE.md template in the project root', false)
|
|
158
|
-
.option('--mcp', '
|
|
165
|
+
.option('--no-mcp', 'Skip MCP server configuration')
|
|
159
166
|
.action(async (options) => {
|
|
160
167
|
await setup(options);
|
|
161
168
|
});
|
package/docs/CLI_WORKFLOW.md
CHANGED
|
@@ -7,6 +7,12 @@ description: Agent development using the Guild CLI. Activated when user mentions
|
|
|
7
7
|
|
|
8
8
|
For local agent development using the Guild CLI. This workflow manages agent code via the Guild git server.
|
|
9
9
|
|
|
10
|
+
## MCP vs CLI
|
|
11
|
+
|
|
12
|
+
If Guild MCP tools are available (check for tools prefixed with `guild_`), use them for **read operations**: searching agents, listing workspaces, reading contexts, checking sessions, viewing credentials. MCP tools are faster and don't require shell execution.
|
|
13
|
+
|
|
14
|
+
Use the **CLI** (via Bash) for **local development operations**: `guild agent create`, `guild agent save`, `guild agent test`, `guild agent pull`, `guild agent clone`. These involve the local filesystem and git, which MCP can't do.
|
|
15
|
+
|
|
10
16
|
## CRITICAL: Always Use the Guild CLI
|
|
11
17
|
|
|
12
18
|
**NEVER manually create agent files or use raw git commands.**
|
package/docs/DESIGN.md
CHANGED
|
@@ -190,6 +190,8 @@ Environments are Docker containers managed by GuildCore. The CLI provides a simp
|
|
|
190
190
|
|
|
191
191
|
The CLI integrates with AI coding assistants like Claude Code, Cursor, and others. Run `guild setup` to install Guild skills into your project.
|
|
192
192
|
|
|
193
|
+
The CLI also exposes a [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server via `guild mcp`. This gives coding assistants direct access to Guild's API — searching agents, managing workspaces, reading contexts, and starting sessions — without leaving the editor. `guild setup` configures it by default; use `--no-mcp` to skip.
|
|
194
|
+
|
|
193
195
|
**Typical Workflow:**
|
|
194
196
|
|
|
195
197
|
1. Initialize agent: `guild agent init --name my-agent --template LLM`
|
package/docs/skills/agent-dev.md
CHANGED
|
@@ -7,6 +7,12 @@ description: Local agent development using the Guild CLI. Activated when user me
|
|
|
7
7
|
|
|
8
8
|
Build agents for Guild using the CLI. **Always use the Guild CLI for agent operations - never use raw git commands.**
|
|
9
9
|
|
|
10
|
+
## MCP vs CLI
|
|
11
|
+
|
|
12
|
+
If Guild MCP tools are available (check for tools prefixed with `guild_`), use them for **read operations**: searching agents, listing workspaces, reading contexts, checking sessions, viewing credentials. MCP tools are faster and don't require shell execution.
|
|
13
|
+
|
|
14
|
+
Use the **CLI** (via Bash) for **local development operations**: `guild agent create`, `guild agent save`, `guild agent test`, `guild agent pull`, `guild agent clone`. These involve the local filesystem and git, which MCP can't do.
|
|
15
|
+
|
|
10
16
|
## When to Use This
|
|
11
17
|
|
|
12
18
|
Activate when user:
|