get_api_doc

Look up Ghidra API documentation for a class or method.

Server Ghidra Api taardisaa/ghidra-api-mcp
Category Read
Risk class Low
Parameters 00 required

What get_api_doc does on Ghidra Api

AI agents call get_api_doc to retrieve information from Ghidra Api without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

Why get_api_doc needs a policy

The tool retrieves existing API documentation—a read-only operation with no side effects. It does not execute code, modify data, delete resources, or commit financial obligations. While it provides information that could be used to write Ghidra scripts, the tool itself merely looks up and returns reference material, making it a classic Read category tool with low risk.

From the tool's definition Tool name is 'get_api_doc' and description states 'Look up Ghidra API documentation for a class or method.' This is a retrieval operation that queries and returns documentation without modifying state or executing arbitrary code.

Questions about get_api_doc

What does the get_api_doc tool do? +

Look up Ghidra API documentation for a class or method. It is categorised as a Read tool in the Ghidra Api MCP Server, which means it retrieves data without modifying state.

How do I enforce a policy on get_api_doc? +

Register the Ghidra Api MCP server in PolicyLayer and add a rule for get_api_doc: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Ghidra Api. Nothing to install.

What risk level is get_api_doc? +

get_api_doc is a Read tool with low risk. Read-only tools are generally safe to allow by default.

Can I rate-limit get_api_doc? +

Yes. Add a rate_limit block to the get_api_doc rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block get_api_doc completely? +

Set action: deny in the PolicyLayer policy for get_api_doc. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides get_api_doc? +

get_api_doc is provided by the Ghidra Api MCP server (taardisaa/ghidra-api-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// THE FULL RECORD

get_api_doc is one line of Ghidra Api's registry record.

The record carries the whole server: verified identity, auth posture, risk grade, every tool classified, recommended policy — re-checked continuously.

Teams ship this data inside their own products. See what a licence covers →

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.