Grepai Mcp Tools

yoanbernabeu/grepai-skills/skills/integration/grepai-mcp-tools

作者 yoanbernabeu382d40261c0d41109c6e11872574ba0be9b064d0無授權條款收錄於 2026年10月9日更新於 2026年10月9日

Reference for all GrepAI MCP tools. Use this skill to understand available MCP tools and their parameters.

僅含說明AI & Agents Software Development

AI 產生的概覽

GrepAI MCP 工具的參考文件，涵蓋參數、回應與用法。

功能: 這個技能是一份參考文件，說明 GrepAI MCP 伺服器提供的工具：語意程式碼搜尋、呼叫者與被呼叫者追蹤、呼叫圖建立，以及索引狀態檢查。它列出每個工具的參數、預設值、範例請求和 JSON 回應，包括精簡輸出的鍵名與錯誤碼。文件也介紹 MCP 協定的請求和回應格式，以及針對 AI 整合的權杖效率建議。
適用情境: 當你需要了解 GrepAI 有哪些 MCP 工具、它們接受哪些參數，或如何解讀其回應時使用。它也適合將 GrepAI 整合到 AI 助理，或排查 MCP 工具使用問題。
執行需求: 僅為說明文件，不附帶指令碼。使用所描述的工具需要 GrepAI 命令列工具，並透過 grepai mcp-serve 指令啟動其 MCP 伺服器，還需要已建立的程式碼索引，以及可連線的嵌入服務供應者（例如 Ollama）。

GrepAI MCP Tools Reference

This skill provides a complete reference for all tools available through GrepAI's MCP server.

When to Use This Skill

Understanding available MCP tools
Learning tool parameters and options
Integrating GrepAI with AI assistants
Debugging MCP tool usage

Starting the MCP Server

The server exposes tools via the Model Context Protocol.

Available Tools

1. grepai_search

Semantic code search using embeddings.

Parameters

Parameter	Type	Required	Default	Description
`query`	string	Yes	-	Search query describing what to find
`limit`	number	No	10	Maximum results to return
`compact`	boolean	No	false	Return compact output (no content)
`format`	string	No	"json"	Output format: "json" or "toon" (v0.26.0+)

Example Request

json

{  "tool": "grepai_search",  "parameters": {    "query": "user authentication middleware",    "limit": 5,    "compact": true,    "format": "toon"  }}

{  "tool": "grepai_search",  "parameters": {    "query": "user authentication middleware",    "limit": 5,    "compact": true,    "format": "toon"  }}

Response (Compact)

json

{  "q": "user authentication middleware",  "r": [    {"s": 0.92, "f": "src/auth/middleware.go", "l": "15-45"},    {"s": 0.85, "f": "src/auth/jwt.go", "l": "23-55"},    {"s": 0.78, "f": "src/handlers/auth.go", "l": "10-40"}  ],  "t": 3}

{  "q": "user authentication middleware",  "r": [    {"s": 0.92, "f": "src/auth/middleware.go", "l": "15-45"},    {"s": 0.85, "f": "src/auth/jwt.go", "l": "23-55"},    {"s": 0.78, "f": "src/handlers/auth.go", "l": "10-40"}  ],  "t": 3}

Response (Full)

json

{  "query": "user authentication middleware",  "results": [    {      "score": 0.92,      "file": "src/auth/middleware.go",      "start_line": 15,      "end_line": 45,      "content": "func AuthMiddleware() gin.HandlerFunc {\n    ..."    }  ],  "total": 3}

{  "query": "user authentication middleware",  "results": [    {      "score": 0.92,      "file": "src/auth/middleware.go",      "start_line": 15,      "end_line": 45,      "content": "func AuthMiddleware() gin.HandlerFunc {\n    ..."    }  ],  "total": 3}

2. grepai_trace_callers

Find all functions that call a specified symbol.

Parameters

Parameter	Type	Required	Default	Description
`symbol`	string	Yes	-	Function/method name to trace
`compact`	boolean	No	false	Return compact output (no context)
`format`	string	No	"json"	Output format: "json" or "toon" (v0.26.0+)

Example Request

Response (Compact)

json

{  "q": "Login",  "m": "callers",  "c": 3,  "r": [    {"f": "handlers/auth.go", "l": 42, "fn": "HandleAuth"},    {"f": "handlers/auth_test.go", "l": 15, "fn": "TestLoginSuccess"},    {"f": "cmd/main.go", "l": 88, "fn": "RunCLI"}  ]}

{  "q": "Login",  "m": "callers",  "c": 3,  "r": [    {"f": "handlers/auth.go", "l": 42, "fn": "HandleAuth"},    {"f": "handlers/auth_test.go", "l": 15, "fn": "TestLoginSuccess"},    {"f": "cmd/main.go", "l": 88, "fn": "RunCLI"}  ]}

Response (Full)

json

{  "query": "Login",  "mode": "callers",  "count": 3,  "results": [    {      "file": "handlers/auth.go",      "line": 42,      "caller": "HandleAuth",      "context": "user.Login(ctx, credentials)"    }  ]}

{  "query": "Login",  "mode": "callers",  "count": 3,  "results": [    {      "file": "handlers/auth.go",      "line": 42,      "caller": "HandleAuth",      "context": "user.Login(ctx, credentials)"    }  ]}

3. grepai_trace_callees

Find all functions called by a specified symbol.

Parameters

Parameter	Type	Required	Default	Description
`symbol`	string	Yes	-	Function/method name to trace
`compact`	boolean	No	false	Return compact output (no context)
`format`	string	No	"json"	Output format: "json" or "toon" (v0.26.0+)

Example Request

json

{  "tool": "grepai_trace_callees",  "parameters": {    "symbol": "ProcessOrder",    "compact": true  }}

{  "tool": "grepai_trace_callees",  "parameters": {    "symbol": "ProcessOrder",    "compact": true  }}

Response (Compact)

json

{  "q": "ProcessOrder",  "m": "callees",  "c": 4,  "r": [    {"f": "services/order.go", "l": 45, "fn": "validateOrder"},    {"f": "services/order.go", "l": 48, "fn": "calculateTotal"},    {"f": "services/order.go", "l": 51, "fn": "applyDiscount"},    {"f": "services/order.go", "l": 55, "fn": "sendConfirmation"}  ]}

{  "q": "ProcessOrder",  "m": "callees",  "c": 4,  "r": [    {"f": "services/order.go", "l": 45, "fn": "validateOrder"},    {"f": "services/order.go", "l": 48, "fn": "calculateTotal"},    {"f": "services/order.go", "l": 51, "fn": "applyDiscount"},    {"f": "services/order.go", "l": 55, "fn": "sendConfirmation"}  ]}

4. grepai_trace_graph

Build a complete call graph starting from a symbol.

Parameters

Parameter	Type	Required	Default	Description
`symbol`	string	Yes	-	Root function for the graph
`depth`	number	No	2	Maximum recursion depth
`compact`	boolean	No	false	Return compact JSON format
`format`	string	No	"json"	Output format: "json" or "toon" (v0.26.0+)

Example Request

json

{  "tool": "grepai_trace_graph",  "parameters": {    "symbol": "main",    "depth": 3,    "compact": true  }}

{  "tool": "grepai_trace_graph",  "parameters": {    "symbol": "main",    "depth": 3,    "compact": true  }}

Response (Compact)

json

{  "q": "main",  "d": 3,  "r": {    "n": "main",    "c": [      {        "n": "initialize",        "c": [          {"n": "loadConfig"},          {"n": "connectDB"}        ]      },      {        "n": "startServer",        "c": [          {"n": "registerRoutes"}        ]      }    ]  },  "s": {"nodes": 6, "depth": 3}}

{  "q": "main",  "d": 3,  "r": {    "n": "main",    "c": [      {        "n": "initialize",        "c": [          {"n": "loadConfig"},          {"n": "connectDB"}        ]      },      {        "n": "startServer",        "c": [          {"n": "registerRoutes"}        ]      }    ]  },  "s": {"nodes": 6, "depth": 3}}

Response (Full)

json

{  "query": "main",  "mode": "graph",  "depth": 3,  "root": {    "name": "main",    "file": "cmd/main.go",    "line": 10,    "children": [      {        "name": "initialize",        "file": "cmd/main.go",        "line": 15,        "children": [...]      }    ]  },  "stats": {    "nodes": 6,    "max_depth": 3  }}

{  "query": "main",  "mode": "graph",  "depth": 3,  "root": {    "name": "main",    "file": "cmd/main.go",    "line": 10,    "children": [      {        "name": "initialize",        "file": "cmd/main.go",        "line": 15,        "children": [...]      }    ]  },  "stats": {    "nodes": 6,    "max_depth": 3  }}

5. grepai_index_status

Check the health and status of the code index.

Parameters

Example Request

Response

json

{  "status": "healthy",  "project": "/path/to/project",  "embedder": {    "provider": "ollama",    "model": "nomic-embed-text",    "status": "connected"  },  "store": {    "backend": "gob",    "location": ".grepai/index.gob"  },  "index": {    "files": 245,    "chunks": 1234,    "last_updated": "2025-01-28T10:30:00Z"  },  "daemon": {    "running": true,    "pid": 12345  }}

{  "status": "healthy",  "project": "/path/to/project",  "embedder": {    "provider": "ollama",    "model": "nomic-embed-text",    "status": "connected"  },  "store": {    "backend": "gob",    "location": ".grepai/index.gob"  },  "index": {    "files": 245,    "chunks": 1234,    "last_updated": "2025-01-28T10:30:00Z"  },  "daemon": {    "running": true,    "pid": 12345  }}

Compact Format Reference

When compact: true, responses use abbreviated keys:

Full Key	Compact Key	Description
`query`	`q`	Search query or symbol
`results`	`r`	Results array
`total`	`t`	Total count
`count`	`c`	Count
`score`	`s`	Similarity score
`file`	`f`	File path
`line`	`l`	Line number(s)
`mode`	`m`	Trace mode
`depth`	`d`	Graph depth
`name`	`n`	Node name
`children`	`c`	Child nodes
`stats`	`s`	Statistics
`function`	`fn`	Function name

Token Efficiency

Compact mode reduces tokens significantly:

Error Responses

Index Not Found

Embedder Connection Failed

json

{  "error": "Cannot connect to embedding provider. Is Ollama running?",  "code": "EMBEDDER_UNAVAILABLE"}

{  "error": "Cannot connect to embedding provider. Is Ollama running?",  "code": "EMBEDDER_UNAVAILABLE"}

Symbol Not Found

Invalid Parameters

Best Practices for AI Integration

Use compact mode: Reduces token usage by ~80%
Limit results: Request only what you need
Check status first: Use grepai_index_status before searches
Handle errors: Check for error responses
Combine tools: Search + trace for full understanding

MCP Protocol Details

Request Format

json

{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "grepai_search",    "arguments": {      "query": "authentication",      "limit": 5,      "compact": true    }  }}

{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "grepai_search",    "arguments": {      "query": "authentication",      "limit": 5,      "compact": true    }  }}

Response Format

json

{  "jsonrpc": "2.0",  "id": 1,  "result": {    "content": [      {        "type": "text",        "text": "{\"q\":\"authentication\",\"r\":[...],\"t\":5}"      }    ]  }}

{  "jsonrpc": "2.0",  "id": 1,  "result": {    "content": [      {        "type": "text",        "text": "{\"q\":\"authentication\",\"r\":[...],\"t\":5}"      }    ]  }}

Output Format

MCP tools reference summary:

📚 GrepAI MCP Tools Reference
Tools available:
1. grepai_search   - Semantic code search   - Params: query*, limit, compact
2. grepai_trace_callers   - Find function callers   - Params: symbol*, compact
3. grepai_trace_callees   - Find function callees   - Params: symbol*, compact
4. grepai_trace_graph   - Build call graph   - Params: symbol*, depth, compact
5. grepai_index_status   - Check index health   - Params: verbose
* = required parameter
Compact mode: ~80% token reduction

📚 GrepAI MCP Tools Reference
Tools available:
1. grepai_search   - Semantic code search   - Params: query*, limit, compact
2. grepai_trace_callers   - Find function callers   - Params: symbol*, compact
3. grepai_trace_callees   - Find function callees   - Params: symbol*, compact
4. grepai_trace_graph   - Build call graph   - Params: symbol*, depth, compact
5. grepai_index_status   - Check index health   - Params: verbose
* = required parameter
Compact mode: ~80% token reduction

來源與署名

來源：yoanbernabeu/grepai-skills位於skills/integration/grepai-mcp-tools提交382d402

授權條款：無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

Response Type	Full	Compact	Savings
Search (5 results)	~800	~150	81%
Trace callers (10)	~600	~120	80%
Trace graph (depth 3)	~1200	~250	79%

Grepai Mcp Tools

GrepAI MCP Tools Reference

When to Use This Skill

Starting the MCP Server

Available Tools

1. grepai_search

Parameters

Example Request

Response (Compact)

Response (Full)

2. grepai_trace_callers

Parameters

Example Request

Response (Compact)

Response (Full)

3. grepai_trace_callees

Parameters

Example Request

Response (Compact)

4. grepai_trace_graph

Parameters

Example Request

Response (Compact)

Response (Full)

5. grepai_index_status

Parameters

Example Request

Response

Compact Format Reference

Token Efficiency

Error Responses

Index Not Found

Embedder Connection Failed

Symbol Not Found

Invalid Parameters

Best Practices for AI Integration

MCP Protocol Details

Request Format

Response Format

Output Format

來源與署名

更多來自 yoanbernabeu/grepai-skills 的技能

Grepai Trace Graph

Grepai Trace Callers

Grepai Trace Callees

Grepai Storage Postgres

Grepai Storage Gob

Grepai Search Tips

更多AI & Agents技能

Discernment Nudge

Ppt Template Creator

Skill Development

Plugin Structure

Command Development

Claude Md Improver