On this page
Reference
ctx_outline
Input contract and parameters for ctx_outline.
MCP tool · Search & code intelligence
Call this tool through your MCP client. Its availability depends on your active configuration and profile.
This registry contract is separate from the SDK. For terminal commands, use the CLI reference.
Parameters
Generated from the registered input schema. “Required” reflects the schema; individual actions can impose additional requirements.
formatstringOutput format: text (default) | json (deterministic)
kindstringFilter by kind: fn|struct|class|trait|enum|impl|all
matchstringKeep only symbols whose name contains this (case-insensitive)
pathstringRequiredFile or directory
Exact JSON schema
Inspect the complete input schema
{
"properties": {
"format": {
"description": "Output format: text (default) | json (deterministic)",
"type": "string"
},
"kind": {
"description": "Filter by kind: fn|struct|class|trait|enum|impl|all",
"type": "string"
},
"match": {
"description": "Keep only symbols whose name contains this (case-insensitive)",
"type": "string"
},
"path": {
"description": "File or directory",
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}Runtime description
The following is the tool's own agent-facing description, reproduced from the reviewed registry. It can contain implementation terminology; it does not expand the public stability commitment.
Read the agent-facing description
WORKFLOW: call BEFORE ctx_read to map code structure (a syntax-aware table of contents).
Accepts a FILE or a DIRECTORY (folder surface — per-file symbols). Symbols come from
tree-sitter (27 languages, real line spans); a conservative regex fallback covers the rest.
kind=fn|struct|class|trait|enum|impl|all filters by kind; match=<substr> filters by name
(case-insensitive); format=json emits deterministic JSON labelling the backend per file.
ANTIPATTERN: NOT for file content (use ctx_read) or deep understanding (use ctx_compose).Sources & versions
- mcp_manifest.rsrust/src/core/mcp_manifest.rsReviewed checkout
- registry.rsrust/src/server/registry.rsReviewed checkout
- dynamic_tools.rsrust/src/server/dynamic_tools.rsReviewed checkout
- Core checkout
50fbff09c9- Installed runtime
- 3.10.2
- SDK release
- 1.1.0
Separate baselines for source, CLI/configuration and SDK contracts. Review does not certify every platform or integration.
Versions & compatibility