Skip to main content
Glama

getNamespace

Retrieve a specific namespace by its ID from SourceSync.ai's knowledge management platform to organize and access content in knowledge bases.

Instructions

Retrieves a specific namespace by its ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
namespaceIdNo
tenantIdNo

Implementation Reference

  • src/index.ts:160-174 (registration)
    Registration of the 'getNamespace' MCP tool, including the handler function that creates a SourceSync client and calls getNamespace on it.
    server.tool(
      'getNamespace',
      'Retrieves a specific namespace by its ID.',
      getNamespaceSchema.shape,
      async (params: GetNamespaceParams) => {
        return safeApiCall(async () => {
          const { namespaceId, tenantId } = params
    
          // Create a client with the provided API key
          const client = createClient({ namespaceId, tenantId })
    
          return await client.getNamespace()
        })
      },
    )
  • Zod schema defining input parameters for the getNamespace tool: namespaceId and optional tenantId.
    export const getNamespaceSchema = z.object({
      namespaceId: namespaceIdSchema,
      tenantId: tenantIdSchema,
    })
  • The handler function for the getNamespace tool, which extracts parameters, creates the client, and delegates to client.getNamespace() wrapped in safeApiCall.
    async (params: GetNamespaceParams) => {
      return safeApiCall(async () => {
        const { namespaceId, tenantId } = params
    
        // Create a client with the provided API key
        const client = createClient({ namespaceId, tenantId })
    
        return await client.getNamespace()
      })
  • Core implementation in SourceSyncApiClient that performs the HTTP GET request to fetch the namespace details from the API.
    public async getNamespace(): Promise<SourceSyncGetNamespaceResponse> {
      return this.client
        .url(`/v1/namespaces/${this.namespaceId}`)
        .get()
        .json<SourceSyncGetNamespaceResponse>()
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.8/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool retrieves data, implying a read-only operation, but lacks details on permissions, rate limits, error handling, or response format. This leaves significant gaps for an agent to understand how to invoke it safely and effectively.

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 directly states the tool's purpose without unnecessary words. It is front-loaded and wastes no space, making it easy for an agent to parse quickly.

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 the complexity of a retrieval tool with 2 parameters, no annotations, and no output schema, the description is insufficient. It doesn't explain what data is returned, how errors are handled, or the operational context (e.g., authentication needs), leaving the agent with critical gaps in understanding.

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?

The schema has 0% description coverage for its two parameters (namespaceId and tenantId), and the tool description adds no information about their meaning, format, or relationships. For example, it doesn't clarify if tenantId is required or optional, or how these IDs are structured, failing to compensate for the schema's lack of documentation.

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 ('Retrieves') and resource ('a specific namespace by its ID'), making the purpose unambiguous. However, it doesn't differentiate from sibling tools like 'listNamespaces' or 'getConnection', which would require explicit comparison to achieve a perfect score.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives such as 'listNamespaces' for browsing or 'getConnection' for related resources. The description implies usage for fetching a single namespace by ID but offers no context about prerequisites, error conditions, or typical workflows.

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