> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/mcp-integration-contributor-guide/mcpapimodule.md).

# MCPApiModule

All MCP integrations use the shared MCPApiModule to handle MCP protocol communication. You should not reimplement MCP logic, as the module provides everything you need:

### Key classes and functions

**Client class: Handles all MCP communication**

* **test\_connection():** Verifies connectivity to the MCP server.
* **list\_tools(server\_name):** Retrieve available tools.
* **call\_tool(tool\_name, arguments):** Execute a tool.
* **close():** Clean up the connection.

**AuthMethods enum: Supported authentication types**

* **Simple auth methods:** BASIC, TOKEN, BEARER, API\_KEY, RAW\_TOKEN, CLIENT\_CREDENTIALS.
* **OAuth methods requiring user authorization:** AUTHORIZATION\_CODE, DYNAMIC\_CLIENT\_REGISTRATION.

**Utility functions**

* **parse\_custom\_headers(text):** Parse multiline header input.
* **extract\_root\_error\_message(exception):** Unwrap nested exceptions for error reporting.
* **generate\_login\_url(oauth\_handler, ...)**: Generate OAuth login URLs.
* **REDIRECT\_URI:** Default OAuth redirect URI constant.

For the complete API in the content repository, see the`Packs/ApiModules/Scripts/MCPApiModule/MCPApiModule.py` .


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cortex-docs.paloaltonetworks.com/mcp-integration-contributor-guide/mcpapimodule.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
