Reference and downloads

Use this page when you need the exact fields for an API request or MCP tool call. If you are connecting TKP for the first time, start with the integration guide and its runnable examples.

REST API reference

The REST API accepts HTTP requests from your application. Its OpenAPI schema is a JSON file describing the available URLs, request fields, responses and errors. An interactive viewer lets you browse that schema and try requests.

Open /api/documentation on your TKP application, which may use a different hostname from this documentation site. For example, if TKP runs at https://tkp.example.com, open https://tkp.example.com/api/documentation. The viewer supports the access tokens and OAuth connections used by TKP.

You can download the running application's schema at /docs?api-docs.json:

curl --fail-with-body 'https://tkp.example.com/docs?api-docs.json' \
  --output openapi.json

Alternatively, download the schema shipped with this documentation. If you use it to generate an API client, set the client server URL to your TKP application address plus /api, for example https://tkp.example.com/api. Use the running application's schema if its version differs from this site.

MCP tool reference

An MCP client asks TKP which tools it may call. The tools/list request returns their names, descriptions and input schemas, which describe the accepted arguments. The MCP quickstart shows how to make that request.

The tool catalog lists every tool registered in this version of TKP. A particular connection may have access to fewer tools because of its permissions. Build your application's tool set from that connection's tools/list response, rather than assuming it can use the entire catalog.

You can also download the full tool schemas and server instructions. The instructions explain how TKP expects a client to use its tools and source references. The server sends them when the client initializes its connection; the client obtains tool definitions separately through tools/list.

Runnable examples and agent-readable docs

The examples below use only Python's standard library. Each linked quickstart explains how to configure and run it:

• Download the REST example for Python 3.9 or later, then follow the REST quickstart.
• Download the MCP example for Python 3.10 or later, then follow the MCP quickstart.

llms.txt is a plain-text index linking Markdown copies of these guides and the downloadable schemas. Follow the coding-agent guide if you want an agent to build an integration using those files.