Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| JOERN_HOST | Yes | The host address for the Joern server | |
| JOERN_PORT | Yes | The port number for the Joern server | |
| JOERN_PASSWORD | Yes | The password for Joern server authentication | |
| JOERN_USERNAME | Yes | The username for Joern server authentication |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_help | Get help information from joern server |
| check_connection | Check if the Joern MCP plugin is running |
| ping | Checks if the Joern server is running and responsive by querying its version |
| load_cpg | |
| get_method_callees | Retrieves a list of methods info that are called by the specified method @param method_full_name: The fully qualified name of the source method(e.g., com.android.nfc.NfcService$6.onReceive(android.content.Context,android.content.Intent)) @return: List of full name, name, signature and id of methods which call the source method |
| get_method_callers | Retrieves a list of methods that call the specified method |
| get_class_full_name_by_id | Retrieves the fully name of a class by its ID |
| get_class_methods_by_class_full_name | Get the methods of a class by its fully qualified name |
| get_method_code_by_full_name | Get the code of a method by its fully name, If you know the full name of the method, you can use this tool to get the method code directly. If you only know the full name of the class and the name of the method, you should use get_method_code_by_class_full_name_and_method_name @param method_full_name: The fully qualified name of the method (e.g., com.android.nfc.NfcService$6.onReceive(android.content.Context,android.content.Intent)) @return: The source code of the specified method |
| get_method_code_by_id | Get the code of a method by its class full name and method name |
| get_method_full_name_by_id | Retrieves the fully qualified name of a method by its ID |
| get_call_code_by_id | Get the source code of a specific call node from the loaded CPG by the call id |
| get_method_code_by_class_full_name_and_method_name | Get the code of a method by its class full name and method name, this tool is usually used when you don't know the full name of the method, but you know the full name of the class and the name of the method. If there are multiple methods with the same name in the class, the code of all methods will be returned. |
| get_derived_classes_by_class_full_name | Get the derived classes of a class |
| get_parent_classes_by_class_full_name | Get the parent classes of a class |
| get_method_by_call_id | Get the method info by the call id which the call is in the method |
| get_referenced_method_full_name_by_call_id | Get the method info by the call id which the call is referenced the method |
| get_calls_in_method_by_method_full_name | Get the calls info by the method full name which the call is in the method |