Schema

Server Configuration

Describes the environment variables required to run the server.

Name	Required	Description
`SOURCESYNC_API_KEY`	Yes	Your SourceSync.ai API key
`SOURCESYNC_TENANT_ID`	No	Your tenant ID
`SOURCESYNC_NAMESPACE_ID`	No	Default namespace ID to use for operations

Prompts

Interactive templates invoked by user choice

Name	Description
No prompts

Resources

Contextual data attached and managed by the client

Name	Description
No resources

Tools

Functions exposed to the LLM to take actions

Name	Description
validateApiKey	Validates the API key by attempting to list namespaces. Returns the list of namespaces if successful.
createNamespace	Creates a new namespace with the provided configuration. Requires a name, file storage configuration, vector storage configuration, and embedding model configuration.
listNamespaces	Lists all namespaces available for the current API key and optional tenant ID.
getNamespace	Retrieves a specific namespace by its ID.
updateNamespace	Updates an existing namespace with the provided configuration parameters.
deleteNamespace	Permanently deletes a namespace by its ID.
ingestText	Ingests raw text content into the namespace. Supports optional metadata and chunk configuration.
ingestFile	Ingests a file into the namespace. Supports various file formats with automatic parsing.
ingestUrls	Ingests content from a list of URLs. Supports scraping options and metadata.
ingestSitemap	Ingests content from a website using its sitemap.xml. Supports path filtering and link limits.
ingestWebsite	Crawls and ingests content from a website recursively. Supports depth control and path filtering.
ingestConnector	Ingests all documents in the connector that are in backlog or failed status. No need to provide the document ids or file ids for the ingestion. Ids are already in the backlog when picked thorough the picker. If not, the user has to go through the authorization flow again, where they will be asked to pick the documents again.
getIngestJobRunStatus	Checks the status of a previously submitted ingestion job.
fetchDocuments	Fetches documents from the namespace based on filter criteria. Supports pagination and including specific document properties.
updateDocuments	Updates metadata for documents that match the specified filter criteria.
deleteDocuments	Permanently deletes documents that match the specified filter criteria.
resyncDocuments	Reprocesses documents that match the specified filter criteria. Useful for updating after schema changes.
semanticSearch	Performs semantic search across the namespace to find relevant content based on meaning rather than exact keyword matches.
hybridSearch	Performs a combined keyword and semantic search, balancing between exact matches and semantic similarity. Requires hybridConfig with weights for both search types.
createConnection	Creates a new connection to a specific source. The connector parameter should be a valid SourceSync connector enum value. The clientRedirectUrl parameter is optional and can be used to specify a custom redirect URL for the connection. This will give you a authorization url which you can redirect the user to. The user will then be asked to pick the documents they want to ingest.
listConnections	Lists all connections for the current namespace, optionally filtered by connector type.
getConnection	Retrieves details for a specific connection by its ID.
updateConnection	Updates a connection to a specific source. The connector parameter should be a valid SourceSync connector enum value. The clientRedirectUrl parameter is optional and can be used to specify a custom redirect URL for the connection. This will give you a authorization url which you can redirect the user to. The user will then be asked to pick the documents they want to ingest. This is useful if you want to update the connection to a different source or if you want to update the clientRedirectUrl or if you want to pick a different or new set of documents.
revokeConnection	Revokes access for a specific connection, removing the integration with the external service.
fetchUrlContent	Fetches the content of a URL. Particularly useful for fetching parsed text file URLs.