Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Read how often an entity is named, or its recorded mention count.
get_mention_score. Operation: read. Uses the authorized connection; no project or content changes are made by this tool.
| Name | Type | Required | Default | Meaning and accepted values |
|---|---|---|---|---|
project_id | string | Yes | Required | Project ID from list_projects. Select the project in the intended workspace and environment. |
run_id | string | Yes | Required | Run ID from list_runs for this project. Use the exact returned value and check readiness before reading measurements. |
metric | string | No | 'coverage' | coverage requests how often responses mention the entity; count requests mention occurrences. Coverage is a proportion; count is a tally. |
aggregation_level | string | No | 'entity' | entity selects individual measured names; bundle requests configured brand groupings. Coverage is served at entity level even when bundle is requested; read served_aggregation_level. |
group_by | string[] or null | No | null | Split results into rows by the requested dimensions. Check both filters_applied.group_by and each row’s group_by_values before labeling the groups. |
filters | object[] or null | No | null | Select measured answers with objects containing dimension and values. Use labels from list_dimension_options; inspect returned warnings for filters that were not applied. |
subject | string or object or null | No | null | Choose brands with kind: leaderboard, all, self, self_and_competitors, or specified. For specified, provide entities_or_bundles. An unmeasured name is not a measured zero. |
params object for MCP tools/call.
{
"name": "get_mention_score",
"arguments": {
"project_id": "PROJECT_ID",
"run_id": "RUN_ID",
"metric": "coverage",
"aggregation_level": "entity",
"subject": {
"kind": "specified",
"entities_or_bundles": [
"Colorescience"
]
},
"group_by": [
"platform"
]
}
}
data.metric, data.rows, and data.served_aggregation_level when supplied. Rows include entity_or_bundle, group_by_values, estimate, and brand flags.
| Field | Meaning and use |
|---|---|
data.served_aggregation_level | Reporting unit actually served. It can differ from the requested bundle grouping for coverage. |
data.rows[].entity_or_bundle | Measured name or grouping represented by this row. |
data.rows[].estimate.value | Mention coverage as a proportion, or mention count as a tally, according to data.metric. |
data.rows[].estimate.n_responses | Response count provided for coverage; do not substitute estimate.n as a universal denominator. |
data.rows[].estimate.stability | Row quality. It does not replace the run-level convergence result. |
data.filters_applied.warnings | Requested scope or data limitations to retain with the result. |
{
"data_ready": true,
"data": {
"metric": "coverage",
"aggregation_level": "entity",
"served_aggregation_level": "entity",
"rows": [
{
"entity_or_bundle": "Colorescience",
"group_by_values": {
"platform": "VERTEX"
},
"estimate": {
"value": 0.39166666666666666,
"ci": {
"lower": 0.3320830242376262,
"upper": 0.4546636584163782,
"level": 0.95
},
"n": 94,
"n_responses": 240,
"stability": "stable",
"stability_n": 240
}
}
],
"filters_applied": {
"filters": {},
"group_by": [
"platform"
],
"warnings": []
}
}
}