Skip to content

Commit 3dfd84d

Browse files
committed
no-mistakes(document): Sync flag docs with split-identifiers and full-body changes
1 parent 3a05fca commit 3dfd84d

3 files changed

Lines changed: 11 additions & 18 deletions

File tree

‎crates/codegraph-server/src/main.rs‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,10 @@ struct Args {
5959
#[arg(long, default_value = "bge-small")]
6060
embedding_model: String,
6161

62-
/// Embed full function body instead of just name+signature (captured at parse time, minimal overhead)
63-
/// Takes an optional value, so the default can be overridden:
64-
/// `--full-body-embedding=false` turns it off. With a bare
65-
/// `default_value` this parsed as a flag that rejected a value and was
66-
/// always true, which made the option impossible to disable.
62+
/// Embed full function body instead of just name+signature (captured at parse time, minimal overhead).
63+
/// Takes an optional value: `--full-body-embedding=false` turns it off.
64+
// With a bare `default_value` this parsed as a flag that rejected a value
65+
// and was always true, which made the option impossible to disable.
6766
#[arg(
6867
long,
6968
num_args = 0..=1,
@@ -78,12 +77,12 @@ struct Args {
7877
///
7978
/// Names already separated by `_` or `-` are left alone: they tokenise into
8079
/// the same words, where this measured as a wash to a small loss. A leading
81-
/// or trailing delimiter separates nothing, so `_handleClick` is split. Disable to embed raw names, as releases up to 0.20.1 did.
82-
/// Takes an optional value so the default can actually be turned off:
80+
/// or trailing delimiter separates nothing, so `_handleClick` is split.
81+
/// Disable to embed raw names, as releases up to 0.20.1 did.
8382
/// `--split-identifiers` and `--split-identifiers=true` enable it,
84-
/// `--split-identifiers=false` disables it. A bare `default_value` on a
85-
/// `bool` parses as a flag that is always true - see
86-
/// `--full-body-embedding`, which cannot be disabled for that reason.
83+
/// `--split-identifiers=false` disables it.
84+
// Takes an optional value for the same reason as `--full-body-embedding`:
85+
// a bare `default_value` on a `bool` parses as an always-true flag.
8786
#[arg(
8887
long,
8988
num_args = 0..=1,

‎jetbrains/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Claude Code, Cursor and the AI Assistant MCP settings all read:
118118
"codegraph": {
119119
"command": "/path/to/codegraph-server",
120120
"args": ["--mcp", "--workspace", "/path/to/project",
121-
"--embedding-model", "bge-small", "--full-body-embedding"]
121+
"--embedding-model", "bge-small"]
122122
}
123123
}
124124
}

‎vscode/README.md‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,7 @@ CodeGraph's Symbols and Memories views live in the CodeGraph activity-bar contai
4646

4747
### MCP Server flags
4848

49-
| Flag | Default | Description |
50-
|------|---------|-------------|
51-
| `--workspace <path>` | current dir | Directories to index (repeatable for multi-project) |
52-
| `--exclude <dir>` | — | Directories to skip (repeatable) |
53-
| `--embedding-model <model>` | `bge-small` | `bge-small` (384d, fast), `jina-code-v2` (768d, 6x slower), or `static` (model2vec, 256d — ~100× faster indexing, no ONNX, ~90% of BGE quality in hybrid search; needs a local model directory, see `codegraph.staticModelPath` below) |
54-
| `--full-body-embedding` | `true` | Embed full function body (~50 lines) for better semantic search and duplicate detection |
55-
| `--max-files <n>` | 5000 | Maximum files to index |
49+
The engine's command-line flags (`--workspace`, `--exclude`, `--embedding-model`, `--full-body-embedding`, `--split-identifiers` and more) are documented in the [main README](https://github.com/codegraph-ai/codegraph#mcp-server-flags).
5650

5751
### VS Code settings
5852

0 commit comments

Comments
 (0)