Skip to content

Commit 433dc7e

Browse files
author
simuleite
committed
Update README
1 parent 7f23823 commit 433dc7e

1 file changed

Lines changed: 77 additions & 0 deletions

File tree

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,45 @@ Start coding(sub-agent) ─────────→ Execute Implementation
118118
119119
> Watch the demo video [here](https://github.com/cloudwego/abcoder/pull/141)
120120
121+
## Use ABCoder as a Skill
122+
123+
The **Skill** interface provides native Claude Code integration without MCP protocol overhead. It uses Claude Code's built-in skill system for a more streamlined workflow.
124+
125+
### Setup
126+
127+
The Skill is automatically configured when you run `abcoder init-spec`. The skill definitions are located in `internal/cmd/assets/.claude/skills/`.
128+
129+
### Available Tools
130+
131+
| Tool | Description |
132+
|------|-------------|
133+
| `list_repos` | List all available repositories |
134+
| `tree_repo` | Get repository file structure |
135+
| `get_file_structure` | Get all symbols in a file |
136+
| `get_file_symbol` | Get symbol details with dependencies and references |
137+
| `search_symbol` | Search symbols by name pattern |
138+
139+
### Usage Example
140+
141+
```bash
142+
# List all repositories
143+
abcoder cli list_repos
144+
145+
# Get repository file tree
146+
abcoder cli tree_repo 'repo_name'
147+
148+
# Get file structure
149+
abcoder cli get_file_structure 'repo_name' 'path/to/file.go'
150+
151+
# Get symbol details
152+
abcoder cli get_file_symbol 'repo_name' 'path/to/file.go' 'SymbolName'
153+
154+
# Search symbols
155+
abcoder cli search_symbol 'repo_name' 'Pattern*'
156+
```
157+
158+
For Claude Code integration, the skill tools are invoked directly via slash commands like `/abcoder:schedule`.
159+
121160
## Use ABCoder as a MCP server
122161

123162
1. Install ABCoder:
@@ -177,6 +216,44 @@ Start coding(sub-agent) ─────────→ Execute Implementation
177216
178217
- Try to use [the recommended prompt](llm/prompt/analyzer.md) and combine planning/memory tools like [sequential-thinking](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking) in your AI agent.
179218
219+
### Skill vs MCP
220+
221+
ABCoder provides two integration methods with Claude Code:
222+
223+
| Feature | MCP (mcp__abcoder) | Skill (skill__abcoder) |
224+
|---------|-------------------|----------------------|
225+
| **Invocation** | `mcp__abcoder__tool_name` | `skill__abcoder__tool_name` |
226+
| **Definition** | MCP protocol | .claude/skills/ |
227+
| **Use Case** | General AI agents | Claude Code workflow |
228+
| **Auto Detection** | - | Auto-detect `current_repo` from cwd |
229+
| **Memory Efficient** | - | Sonic lazy-load, on-demand parsing |
230+
| **Pipeline Support** | - | `rg` filter, `jq` extract |
231+
| **Symbol Search** | - | Regex pattern support |
232+
| **Example** | `mcp__abcoder__get_file_symbol` | `skill__abcoder__get_file_symbol` |
233+
234+
The **Skill** interface is the recommended approach for Claude Code users, providing a more streamlined workflow:
235+
236+
- **Auto-detect current repo**: `list_repos` automatically detects repos that match current working directory
237+
- **Memory efficient**: Uses Sonic for lazy JSON parsing, only loads needed data
238+
- **Pipeline friendly**: Output can be piped to `rg` for filtering or `jq` for extraction
239+
- **Regex search**: `search_symbol` supports regex patterns to precisely locate symbols
240+
241+
**Pipeline Examples:**
242+
```bash
243+
# Filter current repo(s) only
244+
abcoder cli list_repos | jq '.current_repo'
245+
246+
# Search with regex
247+
abcoder cli search_symbol myrepo "^Get.*User$"
248+
249+
# Filter related file
250+
abcoder cli tree_repo myrepo | rg 'related-file'
251+
252+
# Filter dependencies only
253+
abcoder cli get_file_symbol myrepo src/main.go MyFunc | jq '.node.dependencies'
254+
```
255+
256+
For detailed usage, see [Skill Definitions](internal/cmd/assets/.claude/skills/).
180257
181258
## Use ABCoder as an Agent (WIP)
182259

0 commit comments

Comments
 (0)