On this page

AI assistants

Use the docs with an AI assistant

You can connect an AI assistant, such as Claude, Cursor, GitHub Copilot or Codex, to this documentation. The assistant can then search the guides, look up GraphQL types and operations, read Infrastructure-as-Code (IaC) definitions and look up the Lua scripting API and check your GraphQL, IaC or Lua code while it helps you.

The connection uses the Model Context Protocol (MCP). The server address is:

Example
https://docs.wearecococo.com/mcp

You do not need an account or an API key. The server only reads published documentation. It cannot see your platform, run queries against it or change anything.

Add the server to your assistant

Choose the assistant you use. If yours is not listed, look in its settings for “MCP servers”, “connectors” or “tools”, and add a remote server with the address above. If it asks for a transport type, choose Streamable HTTP (sometimes called just HTTP).

Claude Code

Run this in your terminal:

Terminal
claude mcp add --transport http cococo-docs https://docs.wearecococo.com/mcp

To make the server available in every project, add --scope user before cococo-docs. Run claude mcp list to check that it connected.

Claude desktop app and claude.ai

  1. Open Settings, then Connectors.
  2. Choose Add custom connector.
  3. Enter the name CoCoCo docs and the URL https://docs.wearecococo.com/mcp.
  4. Choose Add. Leave the authentication settings empty.

Turn the connector on for a conversation from the tools menu in the message box.

Visual Studio Code

Create .vscode/mcp.json in your project, or add the server to an existing file:

JSON
{
  "servers": {
    "cococo-docs": {
      "type": "http",
      "url": "https://docs.wearecococo.com/mcp"
    }
  }
}

Select Start above the server entry, then open Copilot Chat in agent mode.

Cursor

Add the server to .cursor/mcp.json in your project, or to ~/.cursor/mcp.json to use it everywhere:

JSON
{
  "mcpServers": {
    "cococo-docs": {
      "url": "https://docs.wearecococo.com/mcp"
    }
  }
}

Codex

Add this to ~/.codex/config.toml:

TOML
[mcp_servers.cococo-docs]
url = "https://docs.wearecococo.com/mcp"

Check that it works

Start a new conversation and ask a question that needs the documentation, for example:

Using the CoCoCo docs, which GraphQL mutation creates a job, and what input does it take?

The assistant should show that it called a tool such as search_docs or get_graphql_operation, and its answer should link to pages on docs.wearecococo.com.

You can also check the server from a terminal:

Terminal
curl -s https://docs.wearecococo.com/mcp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

The response lists the available tools.

What the assistant can do

Tool What it does
search_docs Searches installation guides, GraphQL documentation and IaC resources. Returns passages with links.
read_passage Reads a passage found by search_docs.
read_doc Reads a whole documentation page, or one section of it.
list_topics Lists documentation topics and the GraphQL and IaC definitions in each.
search_graphql_schema Finds GraphQL types and operations by name or description.
get_graphql_type Gets the full definition of a GraphQL type.
get_graphql_operation Gets a query, mutation or subscription, with its arguments and examples.
search_iac_schema Finds IaC resources and models by name or description.
get_iac_definition Gets the full definition and an example for an IaC resource or model.
validate_graphql Checks a GraphQL document against the public schema without running it.
validate_iac Checks .cococo files with the same rules as the CoCoCo CLI, without contacting a platform.
validate_lua Type-checks a Lua script against the platform's Lua types, without running it.
search_lua_api Finds ctx functions, objects and their methods for Lua scripts, by name or description.
get_lua_api Gets one Lua function, object or namespace, with its signature, what it does and which scripts can use it.
list_lua_entry_points Lists every place a Lua script runs, how its data arrives and its limits.

All tools are read-only. validate_graphql checks syntax, fields and types; it cannot check your permissions or what the platform will do when the query runs. validate_iac and validate_lua work on the text your assistant sends them; they do not read files on your computer.

validate_lua checks a script for the kind of place it runs: most scripts, such as workflow script nodes, webhooks and custom apps, use the normal role; integration scripts and pure scripts, such as report preparation and scheduler penalties, have their own. Scripting explains the roles and where each kind of script runs. It does not check GraphQL queries inside the script, and it does not know your platform's own API clients or integration instances.

Tips

  • Ask the assistant to use the CoCoCo docs by name. This helps it choose these tools over a general web search.
  • Ask it to validate any GraphQL query, IaC file or Lua script it writes before you use it.
  • If the assistant reports that a passage is no longer available, ask it to search again. Passages change when the documentation is updated.

Troubleshooting

The assistant cannot connect. Check that the address ends in /mcp and starts with https://. If you are behind a company proxy or firewall, ask your IT team to allow HTTPS traffic to docs.wearecococo.com.

Opening the address in a browser shows an error. This is expected. The server only answers MCP requests, which your assistant sends for you.

The assistant does not use the tools. Check that the server is turned on for the conversation, then ask again and mention the CoCoCo docs.