Skip to main content
Glama

Get Scan Configuration

get_scan_config
Read-only

Read the working setup, including strategicGoal, before editing a site or topic. personas, products and journeyStages contain reusable definitions with IDs and names: assign relevant IDs in create_prompt when creating questions. Pass scanId to read the saved setup used by that scan, not current editing IDs. subjectKind distinguishes sites and topics. Topics return topicContext (title/scope), optional clientId, focalEntityId (null means equal treatment), trackedEntities with stable entityId and classification, models, regions and prompt counts. Topics have no business profile and support manual baseline scans. Sites return their business profile and strategy. Use list_prompts and list_competitors for lists; onsomble://model explains the relationships.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scanIdNo
siteIdYesSite or topic ID from list_sites_and_topics. Check subjectKind; topics support manual baseline scans.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelsYes
scanIdNo
sourceNo
promptsYes
regionsYes
summaryYes
clientIdNo
personasYes
productsYes
scheduleYes
competitorsYes
subjectKindYes
topicContextNo
configVersionNo
focalEntityIdNo
journeyStagesYes
strategicGoalYes
businessProfileYes
trackedEntitiesNo
scanExecutionSupportedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the bar is lower. The description adds real semantics beyond that: focalEntityId=null means equal treatment, topics have no business profile and support manual baseline scans, and scanId returns the saved setup rather than in-progress editing IDs. Minor gap: no pagination/size expectations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The leading sentence front-loads purpose and the editing precondition. It is dense but not padded, though the topic return-field enumeration (topicContext, trackedEntities, models, regions, prompt counts) overlaps with the output schema and makes the block longer than a 2-parameter getter strictly needs.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return formats need not be spelled out, yet the description usefully disambiguates the site-vs-topic branches and the saved-vs-working-config behavior. With safe-read annotations covered, an agent has enough to invoke it correctly; only edge cases like empty/missing configs are unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50% – siteId is documented in the schema, but scanId has only a UUID pattern and no description there. The description fills that gap directly: 'Pass scanId to read the saved setup used by that scan, not current editing IDs,' which is meaningful semantics beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'Read the working setup, including strategicGoal'. It also separates the tool from nearby list siblings by pointing to list_prompts/list_competitors for enumeration. It does not explicitly rule out get_site/get_topic, so the boundary with those read tools is left to inference rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear when-to-use ('before editing a site or topic'), names the alternatives for list-style needs ('Use list_prompts and list_competitors for lists'), and clarifies the scanId branch as the saved-vs-current distinction. No explicit when-not clause for the tool overall, but the routing guidance is strong.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources