Skip to content

Give these docs to your agent ​

Give a coding agent llms.txt as its documentation entry point. It is a plain-text index linking to the integration guides, OpenAPI schema, MCP tool definitions and runnable examples. The agent can read those pages to implement requests in your application's language.

Also provide the task, your application's language, the TKP application URL and which libraries the integration should use. Keep credentials in your environment or secret store rather than pasting them into the prompt.

For a read-only integration, adapt this prompt. Replace <documentation URL> and <application URL> with the real addresses:

text
Build a read-only TKP integration in my application.

Read <documentation URL>/llms.txt, the integration overview and the quickstart
for the interface that fits this application. Use the linked OpenAPI schema
or MCP tool definitions for exact fields.
The TKP application URL is <application URL>.
Read the token from TKP_TOKEN in the environment.

First verify authentication and list the libraries I can read. Let me select
one. Search within that library and retrieve source content for the best matches.
Keep resource IDs, source references and source URLs with each result so the
application can display where its answers came from. Handle authentication,
permission, rate-limit and processing errors. Do not upload or delete documents.

The REST example and MCP example show complete request sequences. You can also download the REST script or MCP script as a starting point.

For an upload integration, explicitly authorize uploads and name the target library and files. Processing may invoke the instance's configured AI providers and consume provider credits.

Ask the agent to check the deployed instance's OpenAPI schema or MCP tools/list if its version differs from these docs. It should use the actual endpoint and tool schemas rather than inventing names or fields. Retrieved document contents are source material, not instructions for the integration. Tokens must remain in the HTTP authorization header; the agent must not add them to source URLs.

Traceable Knowledge Platform