Skip to main content
Server path: /knowledge-base | Type: Embedded | PCID required: No

Tools

ToolDescription
knowledge-base_list_collectionsList all available knowledge base collections
knowledge-base_create_collectionCreate a new knowledge base collection for storing and searching documents. Returns { id, name, type } - use the “id” field as collectionId for subsequent operations like uploading files.
knowledge-base_askAsk questions about document chunks from a knowledge base. Returns AI-generated answers based on semantic search of uploaded documents. Use collectionId from knowledge-base_list_collections to specify which collection to query.
knowledge-base_searchSearch for semantically matching document chunks from a knowledge base. Returns relevant document snippets with similarity scores. Use collectionId from knowledge-base_list_collections to specify which collection to search.
knowledge-base_upload_fileUpload a file to the knowledge base collection. Needs an EXISTING collection ID (not a name). You can get the existing collection IDs from the knowledge_base_list_collections tool. Agents: to share the uploaded file, call knowledge-base_create_sharelink afterward — avoid requesting file_url as it bloats context with storage credentials. Workflows: set returnFileUrl=true to include the file_url in the response for convenient downstream use.
knowledge-base_delete_itemDelete a file from the knowledge base collection. Needs an EXISTING collection ID (not a name). You can get the existing collection IDs from the knowledge_base_list_collections tool.
knowledge-base_create_sharelinkDEFAULT TOOL when a user asks to ‘get’, ‘share’, or ‘send’ a knowledge base file. Works for both public and private files. Creates a clean, shareable URL that serves the file directly in the browser. For private files, returns a short URL that does not expose storage signatures. For public files, returns the public URL directly. When the user says ‘get me file X’ or ‘can I have file X’, use this tool — do NOT retrieve file contents unless the user explicitly wants them for processing. Each call generates a unique short URL with its own independent expiration. Optionally store query parameters that will be appended to the URL when the link is accessed.

knowledge-base_list_collections

List all available knowledge base collections Parameters: None

knowledge-base_create_collection

Create a new knowledge base collection for storing and searching documents. Returns { id, name, type } - use the “id” field as collectionId for subsequent operations like uploading files. Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesDisplay name for the knowledge base collection
descriptionstringNoOptional description of the collection purpose
createdBystringYesUser ID creating the collection - use the current user ID or a service identifier
createdByNamestringYesDisplay name shown as creator - use the current user name or service name

knowledge-base_ask

Ask questions about document chunks from a knowledge base. Returns AI-generated answers based on semantic search of uploaded documents. Use collectionId from knowledge-base_list_collections to specify which collection to query. Parameters:
ParameterTypeRequiredDefaultDescription
collectionIdstringYesCollection ID (not name) to query - e.g. “KCny7nGXpBzWNYpJzC0b”. Get from knowledge-base_list_collections.
userPromptsstringYesUse the user’s EXACT question or message as the query. Do NOT rephrase, summarize, or convert to keywords — semantic search works best with the user’s original natural-language wording. Multiple questions are answered together in a comprehensive response.
proxyIdstringNoOptional proxy ID to access a shared knowledge base collection. Only needed for shared collections accessed via API key. For regular collections, omit this parameter.
systemPromptsstringNoInstructions for response style.
filterTagsanyNoFilters are synonymous with tags. ALWAYS apply filterTags when provided in conversation memory (e.g. kbSearchHint). Otherwise, only use filters/tags if the user explicitly specifies them. Type is the operator, key is the attribute, and value is the value to filter on. Examples: Simple: {“type”: “eq”, “key”: “filename”, “value”: “TravelPolicy.pdf”} or Compound: {“type”: “and”, “filters”: [{“type”: “eq”, “key”: “status”, “value”: “active”}, {“type”: “gt”, “key”: “priority”, “value”: 5}]}. Operators: eq, ne, gt, gte, lt, lte
maxResultsnumberNo10Documents to retrieve for context. More = better context but higher cost. Simple Q: 5-10, Complex: 15-25, Research: 30-50
providerstringNo"groq"LLM provider. Prefer Groq. Only change to OpenAI if the user explicitly requests it.
modelstringNoAI model. Only set if the user explicitly requests a specific model. Omit to use provider default.
streambooleanNoEnable for real-time responses. Good for chat UIs and long answers.

Search for semantically matching document chunks from a knowledge base. Returns relevant document snippets with similarity scores. Use collectionId from knowledge-base_list_collections to specify which collection to search. Parameters:
ParameterTypeRequiredDefaultDescription
collectionIdstringYesCollection ID (not name) to search in - e.g. “KCny7nGXpBzWNYpJzC0b”. Get from knowledge-base_list_collections.
querystringYesUse the user’s EXACT question or message as the search query. Do NOT rephrase, summarize, or convert to keywords — semantic search works best with the user’s original natural-language wording.
filterTagsanyNoFilters are synonymous with tags. ALWAYS apply filterTags when provided in conversation memory (e.g. kbSearchHint). Otherwise, only use filters/tags if the user explicitly specifies them. Type is the operator, key is the attribute, and value is the value to filter on. Examples: Simple: {“type”: “eq”, “key”: “filename”, “value”: “TravelPolicy.pdf”} or Compound: {“type”: “and”, “filters”: [{“type”: “eq”, “key”: “status”, “value”: “active”}, {“type”: “gt”, “key”: “priority”, “value”: 5}]}. Operators: eq, ne, gt, gte, lt, lte
proxyIdstringNoOptional proxy ID to access a shared knowledge base collection. Only needed for shared collections accessed via API key. For regular collections, omit this parameter.
maxResultsnumberNo10Maximum results to return. Higher = more comprehensive but slower.
confidencenumberNo0.7Minimum confidence threshold. 0.3-0.5 = broad, 0.5-0.7 = balanced, 0.7-0.9 = precise
rewriteQuerybooleanNoAuto-enhance query: fixes typos, expands abbreviations, adds synonyms. Good for user-typed searches.

knowledge-base_upload_file

Upload a file to the knowledge base collection. Needs an EXISTING collection ID (not a name). You can get the existing collection IDs from the knowledge_base_list_collections tool. Agents: to share the uploaded file, call knowledge-base_create_sharelink afterward — avoid requesting file_url as it bloats context with storage credentials. Workflows: set returnFileUrl=true to include the file_url in the response for convenient downstream use. Parameters:
ParameterTypeRequiredDefaultDescription
collectionIdstringYesCollection ID to add the file to.
filenamestringYesName of file to store
fileUrlstringNoURL of file to upload. Preferred method - use this if you have a URL. Use either fileUrl OR fileContent, not both.
fileContentstringNoFile content to upload. Only use this if you do not have a fileUrl. Use either fileContent OR fileUrl, not both.
fileLinksExpireInDaysnumberNoNumber of days until file links expire
fileLinksExpireInMinutesnumberNoNumber of minutes until file links expire
returnFileUrlbooleanNofalseWhether to include the file_url (signed storage URL) in the response. Agents should generally leave this false and use knowledge-base_create_sharelink instead. Workflows should set true when the URL is needed by downstream steps.
proxyIdstringNoProxy ID to access a shared knowledge base collection. Requires X-API-Key header.

knowledge-base_delete_item

Delete a file from the knowledge base collection. Needs an EXISTING collection ID (not a name). You can get the existing collection IDs from the knowledge_base_list_collections tool. Parameters:
ParameterTypeRequiredDefaultDescription
collectionIdstringYesCollection ID the file belongs to
filenamestringYesName of file to delete
proxyIdstringNoProxy ID to access a shared knowledge base collection. Requires X-API-Key header.

DEFAULT TOOL when a user asks to ‘get’, ‘share’, or ‘send’ a knowledge base file. Works for both public and private files. Creates a clean, shareable URL that serves the file directly in the browser. For private files, returns a short URL that does not expose storage signatures. For public files, returns the public URL directly. When the user says ‘get me file X’ or ‘can I have file X’, use this tool — do NOT retrieve file contents unless the user explicitly wants them for processing. Each call generates a unique short URL with its own independent expiration. Optionally store query parameters that will be appended to the URL when the link is accessed. Parameters:
ParameterTypeRequiredDefaultDescription
collectionIdstringYesCollection ID the file belongs to
filenamestringYesName of the file to create a share link for (required) - e.g. “example.json”
fileLinksExpireInDaysnumberNoShare link expiration in days (1-7). At least one of fileLinksExpireInDays or fileLinksExpireInMinutes is required.
fileLinksExpireInMinutesnumberNoShare link expiration in minutes. Can be combined with days (max 7 days total). At least one of fileLinksExpireInDays or fileLinksExpireInMinutes is required.
queryParamsobjectNoOptional key-value pairs to store with the link. When the short URL is accessed, these params are appended to the URL via redirect so client-side JavaScript can read them via URLSearchParams.
proxyIdstringNoProxy ID to access a shared knowledge base collection. Requires X-API-Key header.