Build on Pinch with AI
Use Pinch’s AI-ready documentation resources to give coding assistants accurate context when you build with the Pinch API.
LLMs.txt
Pinch publishes an llms.txt file at https://docs.getpinch.com.au/llms.txt.
llms.txt is a machine-readable entry point for AI tools. It points large language models (LLMs) to documentation content that is useful when answering questions, generating code, or helping you integrate with an API.
You can use Pinch’s llms.txt file to:
- Give an AI assistant a reliable starting point for Pinch API documentation.
- Help coding tools find relevant guides and API reference material before they generate implementation suggestions.
- Reduce incorrect or outdated answers by grounding AI responses in the current Pinch docs.
- Share the docs index with tools that support
llms.txtdirectly.
If your AI tool accepts a documentation URL, provide:
https://docs.getpinch.com.au/llms.txtLLMs.txt vs MCP
Use llms.txt when you want to give an AI tool a static, discoverable index of the Pinch documentation.
Use the MCP server when your AI tool supports Model Context Protocol (MCP) and you want it to connect directly to the Pinch docs as a context source. MCP is useful in coding environments such as VS Code, Cursor, Claude Code, and other tools that can connect to MCP servers.
Install the Pinch API docs MCP server
To open VS Code and automatically add the Pinch MCP, click install. Alternatively, add the following to your .vscode/mcp.json file in your workspace. To learn more, see the VS Code documentation.
{
"servers": {
"pinch": {
"type": "http",
"url": "https://docs.getpinch.com.au/mcp"
}
}
}Available MCP tools
After you connect the MCP server, your AI tool can use the available tools to inspect the Pinch API and documentation without you manually copying content into the chat.
| Tool | Category | What it does |
|---|---|---|
list-endpoints | OpenAPI | Lists API paths and HTTP methods with their summaries. |
get-endpoint | OpenAPI | Returns detailed information for a specific endpoint, including its description, parameters, and security requirements. |
search-specs | OpenAPI | Searches across API paths, operations, and schemas. |
execute-request | OpenAPI | Makes a live API request and returns the response. This requires the relevant API authentication headers to be available to your MCP client. |
list-specs | OpenAPI | Lists the API specs available in the project when multiple specs are available. |
get-server-variables | OpenAPI | Returns configured server variables when the API spec defines them. |
Sample apps using these tools
Updated about 16 hours ago
