Skip to content

Commit a4ed2ad

Browse files
committed
docs(readme + skills): document new schemas + Cursor/Windsurf/Cline MCP snippets
- README.md + zh-TW: add manual mcp.json snippet block for Cursor / Windsurf / Cline (the three hosts without scripted installer). Per-IDE config path table inside <details>. - skill_sample/claude/ecp/SKILL.md: refresh NodeKind / RelType lists to cover schema additions on origin/main since the branch diverged — EnumVariant, PathLiteral, TransactionScope, Annotation, Struct/Enum/Trait /Impl/Namespace/Module/SchemaField/EventTopic node kinds + Decorates / OpensTxScope / UsesPathLiteral / MirrorsField / Publishes / Subscribes / EventTopicMirror / Overrides rel types.
1 parent f8743ef commit a4ed2ad

3 files changed

Lines changed: 54 additions & 2 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,32 @@ ecp admin gemini install skills
280280

281281
Progressive path (TUI): `ecp admin → Agent Integrations → MCP → <host> → install`.
282282

283+
<details>
284+
<summary><b>Manual mcp.json snippet</b> — Cursor / Windsurf / Cline (no scripted installer yet)</summary>
285+
286+
These hosts read an `mcp.json` (or equivalent) but the file location varies per IDE. Paste this server entry into the host's MCP config; the binary just needs to be on `$PATH`:
287+
288+
```json
289+
{
290+
"mcpServers": {
291+
"ecp": {
292+
"command": "ecp",
293+
"args": ["admin", "mcp", "serve"]
294+
}
295+
}
296+
}
297+
```
298+
299+
Per-host file:
300+
301+
- **Cursor**`~/.cursor/mcp.json` (global) or `<repo>/.cursor/mcp.json` (per-project)
302+
- **Windsurf**`~/.codeium/windsurf/mcp_config.json`
303+
- **Cline** → VS Code settings → `cline.mcpServers` (object keyed the same way)
304+
305+
After saving, restart the IDE; verify with `ecp admin mcp tools` matches what the host now lists.
306+
307+
</details>
308+
283309
<details>
284310
<summary><b>Codex CLI native integration</b> (separate from MCP — prepares a patch for an openai/codex fork)</summary>
285311

docs/readme_i18n/README_zh-TW.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,32 @@ ecp admin claude install mcp-server
231231
ecp admin gemini install skills
232232
```
233233

234+
<details>
235+
<summary><b>手動 mcp.json snippet</b> —— Cursor / Windsurf / Cline(尚無 scripted installer)</summary>
236+
237+
這幾個 host 讀 `mcp.json`(或同類設定),但檔案位置依 IDE 各異。把下面這段 server entry 貼進對應設定即可,binary 只要在 `$PATH` 上:
238+
239+
```json
240+
{
241+
"mcpServers": {
242+
"ecp": {
243+
"command": "ecp",
244+
"args": ["admin", "mcp", "serve"]
245+
}
246+
}
247+
}
248+
```
249+
250+
各 host 設定檔位置:
251+
252+
- **Cursor**`~/.cursor/mcp.json`(global)或 `<repo>/.cursor/mcp.json`(per-project)
253+
- **Windsurf**`~/.codeium/windsurf/mcp_config.json`
254+
- **Cline** → VS Code settings → `cline.mcpServers`(key 結構一樣)
255+
256+
存檔後重啟 IDE,跑 `ecp admin mcp tools` 對照 host 那邊列出的工具集對得上即可。
257+
258+
</details>
259+
234260
<details>
235261
<summary><b>Codex CLI 原生整合</b>(跟 MCP 不一樣 —— 對 openai/codex fork 出 patch)</summary>
236262

skill_sample/claude/ecp/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ For agent → agent piping `toon` is better than json (compact key:value); for s
8181

8282
WHERE: `AND / OR / NOT`, `= != < <= > >=`, `STARTS WITH / ENDS WITH / CONTAINS / =~ / IN [...]`. 支援 `COUNT(*)` / `DISTINCT` / `ORDER BY` / `SKIP` / `LIMIT` / `WITH` / `UNION` / 變長 `[:Rel*1..2]` / 反向 `<-[r:Rel]-`.
8383

84-
**NodeKind** (case-sensitive): `Function Method Class Property Constructor Interface Const Variable Import Route Process Document Section EntryPoint File`
85-
**RelType** (CamelCase only — `HAS_METHOD``unknown RelType`): `Calls Extends Imports Implements HasMethod HasProperty Accesses HandlesRoute StepInProcess References Defines Fetches`
84+
**NodeKind** (case-sensitive). Symbol: `Function Method Class Interface Constructor Property Variable Const Struct Enum EnumVariant Typedef Trait Impl Annotation Macro`. Scope: `File Namespace Module Process`. Runtime: `Route EntryPoint TransactionScope`. Data/IO: `SchemaField EventTopic PathLiteral`. Import/doc: `Import Document Section`.
85+
**RelType** (CamelCase only — `HAS_METHOD``unknown RelType`). Structure: `Defines HasMethod HasProperty Extends Implements Overrides`. Flow: `Calls Accesses References Imports`. Routing/IO: `HandlesRoute Fetches StepInProcess UsesPathLiteral`. Schema/event/tx: `MirrorsField Publishes Subscribes EventTopicMirror OpensTxScope`. Metadata: `Decorates`.
8686
**Node props**: `name uid kind filePath content` · **Edge props**: `rel_type confidence reason`
8787

8888
`HasMethod` target kind 依語言:Python `def` 和 Rust 關聯 fn 是 `Function`;真 method 是 `Method``MATCH (c:Class)-[:HasMethod]->(m) RETURN m``:Method` filter 通用(涵蓋所有語言)。

0 commit comments

Comments
 (0)