Skip to main content
Glama

ingestSitemap

Ingest website content from sitemap.xml for knowledge management. Filter by paths and set link limits to organize content in SourceSync.ai.

Instructions

Ingests content from a website using its sitemap.xml. Supports path filtering and link limits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
namespaceIdNo
ingestConfigYes
tenantIdNo

Implementation Reference

  • Core handler function in SourceSyncApiClient that performs the actual API call to ingest sitemap content via POST /v1/ingest/sitemap.
    public async ingestSitemap({
      ingestConfig,
    }: Omit<
      SourceSyncIngestSitemapRequest,
      'namespaceId'
    >): Promise<SourceSyncIngestResponse> {
      return this.client
        .url('/v1/ingest/sitemap')
        .json({
          namespaceId: this.namespaceId,
          ingestConfig: {
            ...ingestConfig,
            chunkConfig: SourceSyncApiClient.CHUNK_CONFIG,
          },
        } satisfies SourceSyncIngestSitemapRequest)
        .post()
        .json<SourceSyncIngestResponse>()
    }
  • src/index.ts:271-288 (registration)
    MCP tool registration for 'ingestSitemap' using server.tool, which creates a thin wrapper handler delegating to SourceSyncApiClient.ingestSitemap.
    server.tool(
      'ingestSitemap',
      'Ingests content from a website using its sitemap.xml. Supports path filtering and link limits.',
      IngestSitemapSchema.shape,
      async (params) => {
        return safeApiCall(async () => {
          const { namespaceId, ingestConfig, tenantId } = params
    
          // Create a client with the provided parameters
          const client = createClient({ namespaceId, tenantId })
    
          // Direct passthrough to the API
          return await client.ingestSitemap({
            ingestConfig,
          })
        })
      },
    )
  • Zod schema defining input parameters for the ingestSitemap tool, including namespaceId, ingestConfig with sitemap url, limits, paths, metadata, and chunkConfig.
    export const IngestSitemapSchema = z.object({
      namespaceId: namespaceIdSchema.optional(),
      ingestConfig: z.object({
        source: z.literal(SourceSyncIngestionSource.SITEMAP),
        config: z.object({
          url: z.string(),
          maxLinks: z.number().optional(),
          includePaths: z.array(z.string()).optional(),
          excludePaths: z.array(z.string()).optional(),
          metadata: z.record(z.union([z.string(), z.array(z.string())])).optional(),
        }),
        chunkConfig: chunkConfigSchema.optional(),
      }),
      tenantId: tenantIdSchema,
    })
  • TypeScript type definition for the SourceSyncIngestSitemapRequest used in the API client handler for type safety.
    export type SourceSyncIngestSitemapRequest = {
      namespaceId: string
      ingestConfig: {
        source: SourceSyncIngestionSource.SITEMAP
        config: {
          url: string
          maxLinks?: number
          includePaths?: string[]
          excludePaths?: string[]
          scrapeOptions?: SourceSyncScrapeOptions
          metadata?: Record<string, any>
        }
        chunkConfig?: SourceSyncChunkConfig
      }
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool ingests content and supports filtering/limits, but fails to describe critical behaviors: whether this is a read/write operation, what permissions are needed, if it's idempotent or destructive, rate limits, or what the output looks like. For a tool with complex parameters and no output schema, this is a significant gap.

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 description is concise and front-loaded, with two sentences that efficiently convey the core functionality and key features. There's no wasted verbiage, though it could benefit from more structured details given the tool's complexity.

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 tool's complexity (3 parameters with nested objects, no annotations, no output schema, and 0% schema coverage), the description is incomplete. It lacks essential context: behavioral traits, parameter explanations, output expectations, and differentiation from siblings. This leaves the agent poorly equipped to use the tool effectively.

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%, meaning parameters are undocumented in the schema. The description adds minimal value: it mentions 'path filtering' (hinting at 'includePaths'/'excludePaths') and 'link limits' (hinting at 'maxLinks'), but doesn't explain the purpose of 'namespaceId', 'tenantId', 'metadata', or 'chunkConfig', nor does it clarify parameter formats or constraints. This insufficiently compensates for the coverage gap.

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 tool's purpose: 'Ingests content from a website using its sitemap.xml.' This specifies the verb ('ingests'), resource ('content from a website'), and mechanism ('using its sitemap.xml'). However, it doesn't explicitly differentiate from sibling tools like 'ingestWebsite' or 'ingestUrls', which likely have overlapping functionality.

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?

The description provides no guidance on when to use this tool versus alternatives. It mentions 'Supports path filtering and link limits,' which hints at capabilities but doesn't specify scenarios, prerequisites, or exclusions. With siblings like 'ingestWebsite' and 'ingestUrls' available, this lack of comparative context leaves the agent guessing about appropriate use cases.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/sitegpt/sourcesyncai-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server