Previz/Developers/Connect a client

    LangChain and LlamaIndex

    by the PREVIZ team

    Works today with an API key in a header.

    Before you start

    Works todayCredential: API key as an Authorization header
    Server addresshttps://mcp.aimpreviz.comStreamable HTTP, JSON-RPC 2.0. Your key goes in the Authorization header as a bearer token.

    You need a PREVIZ account and an API key. Mint the key in Account → API keys and give it a monthly credit cap: an agent holding the key can spend inside that cap and no further, and a paid tool answers with a quote and runs nothing until it is called again with that quote's token. The key is shown once; keep it in an environment variable named PVZ_KEY, which the snippets below read.

    A key holds only the access classes its owner gave it, set in Account → API keys → the key's Access: a new key holds read and write, and spend needs a monthly credit cap. tools/list shows only the tools a key holds, and a call to any other is refused with INSUFFICIENT_SCOPE. A key made before access classes existed keeps what it could do then (read, write, spend and live) until its owner sets its access; produce is given, never inherited.

    Set it up

    1. 01

      LangChain

      The MCP adapters package turns PREVIZ's tools into LangChain tools (pip install langchain-mcp-adapters).

      Python
      import os
      from langchain_mcp_adapters.client import MultiServerMCPClient
      
      client = MultiServerMCPClient({
          "previz": {
              "transport": "streamable_http",
              "url": "https://mcp.aimpreviz.com",
              "headers": {"Authorization": f"Bearer {os.environ['PVZ_KEY']}"},
          }
      })
      tools = await client.get_tools()   # hand these to your agent
    2. 02

      LlamaIndex

      The MCP tools package does the same for LlamaIndex (pip install llama-index-tools-mcp).

      Python
      import os
      from llama_index.tools.mcp import BasicMCPClient, McpToolSpec
      
      client = BasicMCPClient("https://mcp.aimpreviz.com",
                              headers={"Authorization": f"Bearer {os.environ['PVZ_KEY']}"})
      tools = await McpToolSpec(client=client).to_tool_list_async()

    Config formats belong to each client and change with its releases; if a field name above is refused, check the client's own documentation for its current remote-server entry. The address and the header never change.

    Test the connection

    Two free calls prove the whole path: the key, the address, the client and your projects. Neither spends a credit.

    1. Ask for your PREVIZ projects. The client calls list_projects and answers with their names and ids. An empty list means the key reaches no project yet, not that the connection failed.
    2. Ask what a cinematic frame of something would cost in one of them. The client calls plan_quote or generate_frame without a quote token, and answers with a price. Nothing renders and nothing is charged.
    3. If the client reports 401 or unauthorized, the key is missing, mistyped or revoked; if it reports no tools, the address or the transport is wrong. Fix that before anything else.

    What to know

    • Both adapters list every tool; filter by name if your agent should only read.
    • Spend with the quote's quoteToken or your own idempotencyKey, never a bare confirm: then a call the framework retries after a timeout joins the first run and is charged once (see Quotes and money).