Skip to main content
Glama

listConnections

Retrieve all configured data source connections for your knowledge base, with optional filtering by specific cloud storage providers like Notion or Google Drive.

Instructions

Lists all connections for the current namespace, optionally filtered by connector type.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
namespaceIdNo
connectorNo
tenantIdNo

Implementation Reference

  • MCP tool handler function for 'listConnections'. Parses params, creates SourceSyncApiClient, and calls its listConnections method.
    async (params: any) => {
      return safeApiCall(async () => {
        const { namespaceId, connector, tenantId } = params
    
        // Create a client with the provided parameters
        const client = createClient({ namespaceId, tenantId })
    
        // Call the listConnections method with the connector as enum if provided
        return await client.listConnections({
          connector: connector || undefined,
        })
      })
    },
  • src/index.ts:658-675 (registration)
    Registers the 'listConnections' tool with the MCP server, including description, input schema, and handler.
    server.tool(
      'listConnections',
      'Lists all connections for the current namespace, optionally filtered by connector type.',
      ListConnectionsSchema.shape,
      async (params: any) => {
        return safeApiCall(async () => {
          const { namespaceId, connector, tenantId } = params
    
          // Create a client with the provided parameters
          const client = createClient({ namespaceId, tenantId })
    
          // Call the listConnections method with the connector as enum if provided
          return await client.listConnections({
            connector: connector || undefined,
          })
        })
      },
    )
  • Zod schema defining input parameters for the listConnections tool: optional namespaceId, connector, and tenantId.
    export const ListConnectionsSchema = z.object({
      namespaceId: namespaceIdSchema.optional(),
      connector: ConnectorEnum.optional(),
      tenantId: tenantIdSchema,
    })
  • SourceSyncApiClient method that performs the actual API call to list connections via GET /v1/connections with namespaceId and optional connector query params.
    public async listConnections({
      connector,
    }: SourceSyncListConnectionsRequest): Promise<SourceSyncListConnectionsResponse> {
      return this.client
        .url('/v1/connections')
        .query({ namespaceId: this.namespaceId, connector })
        .get()
        .json<SourceSyncListConnectionsResponse>()
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden but reveals minimal behavioral traits. It states it's a list operation (implies read-only) and mentions optional filtering, but doesn't disclose pagination behavior, rate limits, authentication requirements, error conditions, or what 'current namespace' means contextually. For a tool with 3 parameters and no annotation coverage, this is inadequate.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core purpose ('Lists all connections for the current namespace') and adds qualifying detail ('optionally filtered by connector type'). There's no wasted verbiage or structural issues.

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

Completeness2/5

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

Given 3 parameters with 0% schema coverage, no annotations, and no output schema, the description is incomplete. It adequately states the purpose but fails to provide necessary context about parameter usage, behavioral expectations, or return values. For a list operation with filtering parameters, more guidance is needed to help an agent invoke it correctly.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must compensate but adds minimal parameter semantics. It mentions optional filtering by 'connector type' (hinting at the connector parameter), but doesn't explain namespaceId or tenantId parameters, their relationships, or what 'current namespace' implies versus explicit namespaceId. The description doesn't clarify if parameters are required or how they interact.

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?

The description clearly states the action ('Lists') and resource ('connections for the current namespace'), with optional filtering by connector type. It distinguishes from siblings like getConnection (singular) and createConnection/updateConnection/revokeConnection (mutations), but doesn't explicitly contrast with other list tools like listNamespaces.

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

Usage Guidelines3/5

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

The description implies usage when needing to see all connections, optionally filtered by type, but provides no explicit guidance on when to choose this over alternatives like getConnection (for a specific connection) or when not to use it. It mentions filtering capability but doesn't compare to other search/filter tools in the sibling set.

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