Skip to content

Reference documents

Read the reference documents the MCP server publishes: the long form behind a tool, such as the guide to writing a V2 product feed, which the tool's description names before you call it.

A tool description holds what an assistant needs to call the tool correctly. The longer material, a field contract with types or a format's parsing rules, is published as a document with a docs:// URI. feeds_create points at docs://feeds/v2-guide, and an assistant that reads it first writes a transform that runs the first time.

The documents are MCP resources, so a client that supports resources lists them with resources/list and reads one with resources/read. Not every client does; several expose tools only. docs_list and docs_get serve the same documents as tools, so they are reachable from every client.

Tips & tricks

Pick the card that matches what you're doing. Each prompt is ready to paste into your assistant.

Feeds

Read the guide before the first feed

feeds_create names docs://feeds/v2-guide. Ask for it up front and the assistant knows what each format hands the transform, which fields a product may carry and how a run is verified, before it writes a line of code.

Read docs://feeds/v2-guide, then write the transformation code for my product feed at {feed url}.
Discovery

See what's published

New documents arrive with new tools. docs_list shows the current set, each with a one-line description of when to read it.

List the reference documents the Hello Retail MCP server publishes.

docs_list

List the reference documents the server publishes, with the URI to read each one through docs_get. Takes no arguments.

Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "docs_list",
    "arguments": {}
  }
}

{
  "docs": [
    {
      "uri": "docs://feeds/v2-guide",
      "title": "Writing a V2 product feed",
      "description": "How a V2 product feed run works end to end: itemsPath per format, the object each format hands transform(item), the sandbox, every product field the result may carry with its type, auto mapping, pagination and safety stops, delta runs, deletion of missing products, and how to verify a run. Read it before calling feeds_create or writing transformationCode."
    }
  ]
}

docs_get

Read one document by URI. The text is Markdown, the same content resources/read returns.

Name Type Required Description
uri string Yes URI of the document, from docs_list or from a tool description, e.g. docs://feeds/v2-guide.
Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "docs_get",
    "arguments": {
      "uri": "docs://feeds/v2-guide"
    }
  }
}

{
  "uri": "docs://feeds/v2-guide",
  "mimeType": "text/markdown",
  "text": "# Writing a V2 product feed\n\nA V2 product feed is a URL Hello Retail downloads on a schedule..."
}

An unknown URI is a tool error, No document found with uri: docs://…, so check docs_list for the current set.

Documents

URI Title Read it before
docs://feeds/v2-guide Writing a V2 product feed feeds_create, and feeds_update when it changes itemsPath or transformationCode. Covers how a run works, itemsPath per format, the object each format hands transform(item), the sandbox, every product field with its type, auto mapping, pagination and safety stops, delta runs, deletion of missing products and how to verify a run. See Feeds.

Reading them as resources

A client that supports MCP resources needs no tool call. resources/list returns the same set, and resources/read the same text.

Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "resources/list"
}

{
  "resources": [
    {
      "uri": "docs://feeds/v2-guide",
      "name": "feeds-v2-guide",
      "title": "Writing a V2 product feed",
      "description": "How a V2 product feed run works end to end...",
      "mimeType": "text/markdown"
    }
  ]
}

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "resources/read",
  "params": {
    "uri": "docs://feeds/v2-guide"
  }
}

{
  "contents": [
    {
      "uri": "docs://feeds/v2-guide",
      "mimeType": "text/markdown",
      "text": "# Writing a V2 product feed\n\n..."
    }
  ]
}

An unknown URI returns JSON-RPC error -32002, Resource not found.