Skip to main content
Glama
scmdr

SourceSync.ai MCP Server

by scmdr

ingestSitemap

Extract website content automatically by processing sitemap.xml files with configurable path filtering and link limits for structured data ingestion.

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

  • The core handler implementation in SourceSyncApiClient.ingestSitemap that performs the HTTP POST to the SourceSync API endpoint /v1/ingest/sitemap with the sitemap configuration.
     * Ingest a 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:270-288 (registration)
    MCP server registration of the 'ingestSitemap' tool, including name, description, input schema, and handler that delegates to SourceSyncApiClient.ingestSitemap.
    // Add ingestSitemap tool
    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 definition for validating inputs to the ingestSitemap tool, including namespaceId, ingestConfig with sitemap url and options, and tenantId.
    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 SourceSyncIngestSitemapRequest, defining the structure expected by the SourceSync API for sitemap ingestion.
    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 mentions 'ingests content' and 'supports path filtering and link limits,' which implies a write operation with configurable scoping, but it doesn't cover critical aspects like permissions required, rate limits, whether the ingestion is asynchronous or immediate, error handling, or what happens to existing content. For a tool with 3 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.

Conciseness5/5

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

The description is appropriately sized and front-loaded: it states the core purpose in the first clause and adds feature details in the second. Every sentence earns its place by conveying essential information without waste, making it efficient and easy to parse.

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 (3 parameters with nested objects, no annotations, no output schema), the description is incomplete. It lacks details on behavioral traits, full parameter meanings, and expected outcomes. For an ingestion tool that likely involves data processing and storage, more context is needed to guide effective use, such as prerequisites, side effects, or response format.

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 schema provides no parameter descriptions. The description adds minimal semantics: it implies 'url' is for the sitemap.xml, 'maxLinks' sets a limit, and 'includePaths'/'excludePaths' filter paths. However, it doesn't explain 'namespaceId', 'tenantId', 'metadata', or 'chunkConfig', leaving 3 out of 3 top-level parameters partially or fully undocumented. The description compensates poorly for the low schema coverage.

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.' It specifies the verb ('ingests'), resource ('content from a website'), and mechanism ('using its sitemap.xml'). However, it doesn't explicitly differentiate from siblings like 'ingestWebsite' or 'ingestUrls', which likely have overlapping functionality, so it doesn't reach the highest 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?

The description provides no guidance on when to use this tool versus alternatives. It mentions 'Supports path filtering and link limits,' which are features but not usage contexts. With siblings like 'ingestWebsite' and 'ingestUrls' that might handle similar tasks, the lack of explicit when-to-use or when-not-to-use advice leaves the agent guessing.

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/scmdr/sourcesyncai-mcp'

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