Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/A-Point-Systems-ltd/ms-sql-mcp/llms.txt

Use this file to discover all available pages before exploring further.

ListInsights returns a paginated snapshot of AIInsights.SchemaInsights for browsing and auditing the current insights cache coverage. Rows are returned newest-first by LastAnalyzed. Use GetInsight to retrieve the full record — including dataPatterns, usageGuidelines, and relatedObjects — for a specific object.

Parameters

schemaName
string
Filter results to a single schema (e.g. dbo). Pass null to return insights across all schemas.
objectType
string
Filter results to a single object type. Must be one of: Table, View, Procedure, Function, Trigger. Pass null to return all types.
take
integer
Maximum number of rows to return. Clamped server-side to the range 1–2000. Defaults to 100. Use small values such as 50 for quick triage.

Returns

success
boolean
required
true when the query completed without error.
data
array
Present when success is true. Array of summary insight rows ordered by LastAnalyzed descending. Each element contains a subset of the full SchemaInsight record.
error
string
Present only when success is false. Contains the exception message.
ListInsights requires USE_INSIGHTS_LAYER to be enabled (the default). When the layer is disabled, the tool returns an error indicating the layer is off.
ListInsights returns summary fields only. To retrieve the full insight record — including dataPatterns, usageGuidelines, relatedObjects, and schemaFingerprint — call GetInsight with the specific object coordinates.

Build docs developers (and LLMs) love