> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Assistants connect to Parse over MCP at [https://agent.parse.gl/mcp](https://agent.parse.gl/mcp) (Streamable HTTP). With no sign-in it answers from Parse's public view (the numbers parse.gl's public pages show, up to 5 rows a list), starting with `check_brand`. Signed in with Parse, or sent a workspace key (`parse_mcp_…`), it works in the person's workspace, starting with `get_brief`. Scripts call the same tools over REST at `https://agent.parse.gl/v1/tools/<tool>`.
>
> ```bash
> npx parse-gl init
> ```
>
> To install just the skills: `npx skills add Parsegl/skills`.
> Every tool is also a POST to https://agent.parse.gl/v1/tools/<tool>; its OpenAPI description is https://agent.parse.gl/openapi.json.

# Change settings, save a topic, report a wrong fact

> update_settings: a workspace tool on Parse for agents (agent.parse.gl). Arguments, price, and a call over REST and MCP.

Change brief schedule, nudges, pace, or monthly budget (lowering budget, pausing spend, validated webhook, and alerts apply immediately; raising budget or resuming spend returns needs\_confirm for an admin). Also manages private saved topics (topic), data/claim error reports (correction), unconfirmed brand facts (fact), brand background (about), and push ping URL (wake — sends empty ping; call get\_brief on arrival). Send one form per call. Free.

## Who may call it, and what it costs

| Name | Access | Effect |
| - | - | - |
| `update_settings` | A workspace key, or a sign-in that allows changes. | Changes the workspace |

**Price.** Free. Every reply says what the call cost in `meta.costCredits`. The prices are on [Spending, tracking and stopping](/docs/credits.md).

## Arguments

**brief** `object`

To have the brief delivered to an address, set webhookUrl (https) with the webhook channel: Parse sends it there. maxPerWeek limits each channel separately. Weekly and on-change email uses the Monday slot; daily email uses hour in workspace time. Webhooks use hour and timeZone for scheduled deliveries. alerts: kinds sent at once (default fact\_contradicted)

**brief.schedule** `one of on_change, daily, weekly, off`

**brief.channels** `list of one of webhook, email`

up to 2

**brief.webhookUrl** `string or null`

**brief.minMovePoints** `number`

min 1, max 50

**brief.scope** `one of tracked, all`

**brief.rivals** `boolean`

**brief.maxPerWeek** `integer`

min 1, max 21

**brief.hour** `integer`

min 0, max 23

**brief.timeZone** `string`

**brief.alerts** `list of one of fact_contradicted, proof_step_blocked, own_page_changed, page_changed, page_dropped, page_first_cited, mention_move, rival_move, finding`

up to 9

**nudges** `boolean`

**pace** `one of off, light, steady, fast`

off|light|steady|fast: how often Parse watches claimed tasks, checks outcomes and scouts questions by itself, within the budget; any pace applies at once

**budget** `object`

monthlyUsd: the workspace's one monthly budget, everything Parse spends for it in a UTC month. paused: true pauses spending at once; false asks a person to resume it

**budget.monthlyUsd** `number`

min 1, max 300000

**budget.paused** `boolean`

**autoTopUp** `object or null`

the wallet's auto top-up: a person's setting, refused from an assistant

**standingInstructions** `any`

the standing instructions get\_brief opens with: a person writes them in Settings, refused from an assistant

**fact** `object`

one fact this workspace holds about a brand it saved or tracks, with where you got it (source). Stored unconfirmed until a person confirms it in Parse or Parse finds it on the brand's site; delete: true withdraws it. Alone, without settings

**fact.brand** `string` *required*

brd\_ id of a brand in this workspace, saved or tracked

**fact.kind** `one of one_liner, audience, buyers, claim, not_offered` *required*

one\_liner (what the brand is), audience (who it is for: the kind of customer), buyers (only the geographic regions or cities it serves, never a kind of customer), claim (one thing it offers), not\_offered (one thing it does not offer)

**fact.text** `string`

the fact, as one statement; with delete, the claim or not\_offered to withdraw

**fact.source** `string` *required*

where you got it: a URL, "person" when the person told you, or a file or note reference

**fact.delete** `boolean`

withdraw this workspace's fact of that kind

**about** `object`

the brand's background every agent reads in get\_brief (positioning, launches, rivals), replacing what it held; shown as an assistant's until a person saves it. Alone, without settings

**about.brand** `string` *required*

**about.text** `string` *required*

**brandAllowance** `object`

lower one brand's monthly allowance, a slice of the budget an admin set for that brand: a lower figure applies at once; setting or raising one is an admin's, in Parse. Alone, without settings

**brandAllowance.brand** `string` *required*

brd\_ id of a brand of this workspace

**brandAllowance.monthlyUsd** `number` *required*

min 0, max 300000

**wake** `object`

a wake address you may set yourself: url (https) and an optional bearer token for the receiver, which no call shows again. Parse POSTs \{"type":"parse.wake"} to it, and nothing else: no workspace, no text, no ids. The receiver then calls get\_brief. url: null turns it off. Alone, without settings

**wake.url** `string or null` *required*

**wake.token** `string or null`

**topic** `object`

a private topic: id alone shows it; name and include save a new one; id with name, include or exclude changes it; id with delete: true deletes it. Alone, without settings

**topic.id** `string`

top\_saved\_ id: alone shows the topic; with name, include or exclude changes it

**topic.name** `string`

required to save a new topic; with id, renames it

**topic.include** `object`

questions to add

**topic.exclude** `object`

**topic.delete** `boolean`

with id: delete the saved topic

**correction** `object`

a wrong fact, in Parse's data or claimed on any page or in any answer: kind not\_this\_brand (brand with site or page), wrong\_market (market), off\_target\_topic (topic), duplicate (otherBrand), wrong\_judgment (answer, judgment), other (note: a page's or an answer's wrong claim, with its URL or ans\_ id). Alone, without settings

**correction.kind** `one of not_this_brand, wrong_market, off_target_topic, duplicate, wrong_judgment, other` *required*

**correction.brand** `string`

brd\_ id the fact is about

**correction.site** `string`

a domain or site: id (not\_this\_brand)

**correction.page** `string`

pg\_ id; for not\_this\_brand its site stops counting as the brand's

**correction.market** `string`

mkt\_ id (wrong\_market)

**correction.topic** `string`

top\_ id (off\_target\_topic)

**correction.answer** `string`

ans\_ id (wrong\_judgment)

**correction.otherBrand** `string`

brd\_ id of the second record (duplicate)

**correction.judgment** `object`

the facet and the value it should have (wrong\_judgment)

**correction.note** `string`

Every argument the tool takes, as `GET /v1/tools` serves it, every shared object written out; `https://agent.parse.gl/openapi.json` serves the same schema with the filter and the window named once under `components` and pointed to by `$ref`. MCP `tools/list` leaves out the arguments few calls send, and says the filter and the window once, under `search_answers`; `resolve_ids {"kinds": ["argument"]}` lists what it left out, and a call with any of them runs:

```json theme={null}
{
  "type": "object",
  "properties": {
    "brief": {
      "description": "To have the brief delivered to an address, set webhookUrl (https) with the webhook channel: Parse sends it there. maxPerWeek limits each channel separately. Weekly and on-change email uses the Monday slot; daily email uses hour in workspace time. Webhooks use hour and timeZone for scheduled deliveries. alerts: kinds sent at once (default fact_contradicted)",
      "type": "object",
      "properties": {
        "schedule": {
          "type": "string",
          "enum": [
            "on_change",
            "daily",
            "weekly",
            "off"
          ]
        },
        "channels": {
          "maxItems": 2,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "webhook",
              "email"
            ]
          }
        },
        "webhookUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500,
              "format": "starts_with",
              "pattern": "^https:\\/\\/.*"
            },
            {
              "type": "null"
            }
          ]
        },
        "minMovePoints": {
          "type": "number",
          "minimum": 1,
          "maximum": 50
        },
        "scope": {
          "type": "string",
          "enum": [
            "tracked",
            "all"
          ]
        },
        "rivals": {
          "type": "boolean"
        },
        "maxPerWeek": {
          "type": "integer",
          "minimum": 1,
          "maximum": 21
        },
        "hour": {
          "type": "integer",
          "minimum": 0,
          "maximum": 23
        },
        "timeZone": {
          "type": "string",
          "maxLength": 64
        },
        "alerts": {
          "maxItems": 9,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "fact_contradicted",
              "proof_step_blocked",
              "own_page_changed",
              "page_changed",
              "page_dropped",
              "page_first_cited",
              "mention_move",
              "rival_move",
              "finding"
            ]
          }
        }
      },
      "additionalProperties": false
    },
    "nudges": {
      "type": "boolean"
    },
    "pace": {
      "description": "off|light|steady|fast: how often Parse watches claimed tasks, checks outcomes and scouts questions by itself, within the budget; any pace applies at once",
      "type": "string",
      "enum": [
        "off",
        "light",
        "steady",
        "fast"
      ]
    },
    "budget": {
      "description": "monthlyUsd: the workspace's one monthly budget, everything Parse spends for it in a UTC month. paused: true pauses spending at once; false asks a person to resume it",
      "type": "object",
      "properties": {
        "monthlyUsd": {
          "type": "number",
          "minimum": 1,
          "maximum": 300000
        },
        "paused": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "autoTopUp": {
      "description": "the wallet's auto top-up: a person's setting, refused from an assistant",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "belowUsd": {
              "type": "number",
              "minimum": 1,
              "maximum": 10000
            },
            "amountUsd": {
              "type": "number",
              "minimum": 10,
              "maximum": 10000
            }
          },
          "required": [
            "belowUsd",
            "amountUsd"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "standingInstructions": {
      "description": "the standing instructions get_brief opens with: a person writes them in Settings, refused from an assistant"
    },
    "fact": {
      "description": "one fact this workspace holds about a brand it saved or tracks, with where you got it (source). Stored unconfirmed until a person confirms it in Parse or Parse finds it on the brand's site; delete: true withdraws it. Alone, without settings",
      "type": "object",
      "properties": {
        "brand": {
          "type": "string",
          "minLength": 3,
          "maxLength": 220,
          "description": "brd_ id of a brand in this workspace, saved or tracked"
        },
        "kind": {
          "type": "string",
          "enum": [
            "one_liner",
            "audience",
            "buyers",
            "claim",
            "not_offered"
          ],
          "description": "one_liner (what the brand is), audience (who it is for: the kind of customer), buyers (only the geographic regions or cities it serves, never a kind of customer), claim (one thing it offers), not_offered (one thing it does not offer)"
        },
        "text": {
          "description": "the fact, as one statement; with delete, the claim or not_offered to withdraw",
          "type": "string",
          "minLength": 1,
          "maxLength": 300
        },
        "source": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500,
          "description": "where you got it: a URL, \"person\" when the person told you, or a file or note reference"
        },
        "delete": {
          "description": "withdraw this workspace's fact of that kind",
          "type": "boolean"
        }
      },
      "required": [
        "brand",
        "kind",
        "source"
      ],
      "additionalProperties": false
    },
    "about": {
      "description": "the brand's background every agent reads in get_brief (positioning, launches, rivals), replacing what it held; shown as an assistant's until a person saves it. Alone, without settings",
      "type": "object",
      "properties": {
        "brand": {
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "text": {
          "type": "string",
          "maxLength": 4000
        }
      },
      "required": [
        "brand",
        "text"
      ],
      "additionalProperties": false
    },
    "brandAllowance": {
      "description": "lower one brand's monthly allowance, a slice of the budget an admin set for that brand: a lower figure applies at once; setting or raising one is an admin's, in Parse. Alone, without settings",
      "type": "object",
      "properties": {
        "brand": {
          "type": "string",
          "minLength": 3,
          "maxLength": 220,
          "description": "brd_ id of a brand of this workspace"
        },
        "monthlyUsd": {
          "type": "number",
          "minimum": 0,
          "maximum": 300000
        }
      },
      "required": [
        "brand",
        "monthlyUsd"
      ],
      "additionalProperties": false
    },
    "wake": {
      "description": "a wake address you may set yourself: url (https) and an optional bearer token for the receiver, which no call shows again. Parse POSTs {\"type\":\"parse.wake\"} to it, and nothing else: no workspace, no text, no ids. The receiver then calls get_brief. url: null turns it off. Alone, without settings",
      "type": "object",
      "properties": {
        "url": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500,
              "format": "starts_with",
              "pattern": "^https:\\/\\/.*"
            },
            {
              "type": "null"
            }
          ]
        },
        "token": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "url"
      ]
    },
    "topic": {
      "description": "a private topic: id alone shows it; name and include save a new one; id with name, include or exclude changes it; id with delete: true deletes it. Alone, without settings",
      "type": "object",
      "properties": {
        "id": {
          "description": "top_saved_ id: alone shows the topic; with name, include or exclude changes it",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "name": {
          "description": "required to save a new topic; with id, renames it",
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "include": {
          "description": "questions to add",
          "type": "object",
          "properties": {
            "topics": {
              "description": "top_ ids, Parse's or saved: the questions asked under them in the last 90 days",
              "maxItems": 20,
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 220
              }
            },
            "questions": {
              "description": "qst_ ids",
              "maxItems": 500,
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 220
              }
            },
            "filter": {
              "description": "the questions behind this filter's answers in the last 90 days",
              "type": "object",
              "properties": {
                "brand": {
                  "description": "brd_ ids; with brandRule, which answers count",
                  "maxItems": 20,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 220
                  }
                },
                "brandRule": {
                  "description": "default named; not_recommended keeps judged answers recommending none of the filter brands; warned filters to answers flagged with facet mention.advised_against",
                  "type": "string",
                  "enum": [
                    "named",
                    "recommended",
                    "first",
                    "not_named",
                    "not_recommended",
                    "warned"
                  ]
                },
                "match": {
                  "description": "with several brands; default any",
                  "type": "string",
                  "enum": [
                    "any",
                    "all"
                  ]
                },
                "topic": {
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 220
                  }
                },
                "market": {
                  "description": "Industry or category markets. For countries use country, and for cities use place.",
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 220
                  }
                },
                "question": {
                  "maxItems": 100,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 220
                  }
                },
                "engine": {
                  "description": "surface ids (resolve_ids with kinds: [\"surface\"] lists them); without engine or surfaceClass, the counted engines",
                  "maxItems": 10,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "maxLength": 40
                  }
                },
                "surfaceClass": {
                  "description": "classes of engines to cover; default counted",
                  "maxItems": 5,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "counted",
                      "wider",
                      "memory",
                      "search",
                      "imported"
                    ]
                  }
                },
                "place": {
                  "description": "plc_ ids (resolve_ids finds them): the place a question is about, with the places under each (a region holds its cities). \"all\": every place, in place of a local subject's area. A country code here reads as filter.country for one release",
                  "anyOf": [
                    {
                      "type": "string",
                      "const": "all"
                    },
                    {
                      "maxItems": 20,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "maxLength": 80
                      }
                    }
                  ]
                },
                "country": {
                  "description": "ISO country codes the question was asked from; an answer asked with no place set counts as US",
                  "maxItems": 20,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "maxLength": 2
                  }
                },
                "site": {
                  "description": "domains or site: ids of cited sites",
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "maxLength": 200
                  }
                },
                "page": {
                  "description": "pg_ ids of cited pages",
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 220
                  }
                },
                "text": {
                  "description": "Full-text search over answer text: keywords, \"exact phrases\", AND/OR/NOT, NEAR/n, prefix*. A call reads at most the first 100,000 matches (20,000 in search_answers) before the brand filter and the rest apply: a brand filter does not narrow it, so a common word over a long window can miss a brand's answers; narrow by window, topic, market or engine",
                  "type": "string",
                  "maxLength": 500
                },
                "facet": {
                  "description": "a facet with \"filter\" in its usableIn list",
                  "type": "object",
                  "propertyNames": {
                    "type": "string",
                    "maxLength": 80
                  },
                  "additionalProperties": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "maxItems": 50,
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      {
                        "type": "object",
                        "properties": {
                          "gte": {
                            "type": "number"
                          },
                          "lte": {
                            "type": "number"
                          }
                        },
                        "additionalProperties": false
                      }
                    ]
                  }
                },
                "scope": {
                  "description": "default all: public plus this workspace's own; own: only the answers this workspace bought; tracked: its own answers and those about the questions, topics and brands it watches with the track tool (not the brands it added in the app); public: public answers only; index: the answers parse.gl's public pages count, which a logged-out call always reads",
                  "type": "string",
                  "enum": [
                    "tracked",
                    "public",
                    "own",
                    "all",
                    "index"
                  ]
                }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "exclude": {
          "type": "object",
          "properties": {
            "questions": {
              "description": "qst_ ids to leave out",
              "maxItems": 500,
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 3,
                "maxLength": 220
              }
            },
            "text": {
              "description": "leave out questions whose wording contains this, in any case",
              "type": "string",
              "minLength": 2,
              "maxLength": 200
            }
          },
          "additionalProperties": false
        },
        "delete": {
          "description": "with id: delete the saved topic",
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "correction": {
      "description": "a wrong fact, in Parse's data or claimed on any page or in any answer: kind not_this_brand (brand with site or page), wrong_market (market), off_target_topic (topic), duplicate (otherBrand), wrong_judgment (answer, judgment), other (note: a page's or an answer's wrong claim, with its URL or ans_ id). Alone, without settings",
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "not_this_brand",
            "wrong_market",
            "off_target_topic",
            "duplicate",
            "wrong_judgment",
            "other"
          ]
        },
        "brand": {
          "description": "brd_ id the fact is about",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "site": {
          "description": "a domain or site: id (not_this_brand)",
          "type": "string",
          "minLength": 3,
          "maxLength": 253
        },
        "page": {
          "description": "pg_ id; for not_this_brand its site stops counting as the brand's",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "market": {
          "description": "mkt_ id (wrong_market)",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "topic": {
          "description": "top_ id (off_target_topic)",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "answer": {
          "description": "ans_ id (wrong_judgment)",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "otherBrand": {
          "description": "brd_ id of the second record (duplicate)",
          "type": "string",
          "minLength": 3,
          "maxLength": 220
        },
        "judgment": {
          "description": "the facet and the value it should have (wrong_judgment)",
          "type": "object",
          "properties": {
            "facet": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            },
            "value": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            }
          },
          "required": [
            "facet",
            "value"
          ],
          "additionalProperties": false
        },
        "note": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        }
      },
      "required": [
        "kind"
      ],
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}
```

## Example call

Lower the workspace's monthly budget to \$10. Over REST:

```bash theme={null}
export PARSE_API_KEY="<your-key>"

curl -s -X POST https://agent.parse.gl/v1/tools/update_settings \
  -H 'content-type: application/json' \
  -H "Authorization: Bearer $PARSE_API_KEY" \
  -d '{"budget":{"monthlyUsd":10}}'
```

Over MCP, the assistant calls the tool by name with the same arguments:

```json theme={null}
{
  "method": "tools/call",
  "params": {
    "name": "update_settings",
    "arguments": {
      "budget": {
        "monthlyUsd": 10
      }
    }
  }
}
```

More calls:

* Send the brief once a week: `{"brief":{"schedule":"weekly"}}`
* Save a set of questions as a private topic: `{"topic":{"name":"Agency project management","include":{"questions":["qst_…"]}}}`
* Delete a saved topic: `{"topic":{"id":"top_saved_…","delete":true}}`
* Tell Parse a site is not the brand's: `{"correction":{"kind":"not_this_brand","brand":"<brd_ id>","site":"example.com","note":"This site belongs to another company with the same name"}}`
* Write the brand's background every agent reads in get\_brief: send the whole text, which replaces what it held: `{"about":{"brand":"<brd_ id>","text":"Observability for platform teams. We launch the mobile app in December; buyers compare us with Datadog."}}`

The reply has `data`, `context`, `next`, `page` and `meta`; follow `next` for the calls that come after. A refused call returns `{ code, message, fix }`: see the [error table](/docs/mcp-reference.md#errors).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.