Skip to navigation

Tools

Everything an agent or a program can do through the Gateway.
View as Markdown

The Gateway has one set of tools. An agent calls them through MCP. A program calls the same tools through the SDKs or the HTTP API, where each tool is one operation.

The Needs column says what the key’s access level must allow. See Keys and access levels.

Identity

ToolWhat it doesNeeds
whoamiAnswers the organization, the key’s name and prefix, its scopes and its expiry.Any key

Documents

ToolWhat it doesNeeds
list_docsLists the documents: ID, title, version.Documents
read_docReads a document’s markdown. Basement records the version that was read.Documents
list_doc_versionsLists a document’s versions, newest first.Documents
create_docCreates a document.Documents, write
update_docReplaces a document’s body. Makes a new version.Documents, write
edit_docReplaces one piece of text in a document. Makes a new version.Documents, write
rename_docRenames a document.Documents, write
delete_docDeletes a document.Documents, write
restore_doc_versionRestores an earlier version.Documents, write
share_docTurns a document’s public link on or off.Documents, write

Files, skills and folders

ToolWhat it doesNeeds
list_filesLists the files in the folders the key can use.Documents
read_fileReads a file’s details and a download link. For a small text file, also its text.Documents
list_skillsLists the skills in the folders the key can use.Documents
list_foldersLists the folders the key can use, and its access to each.Documents
write_fileUploads a file of up to 5 MB, or a new version of one.Documents, write
edit_fileReplaces one piece of text in a text file.Documents, write
write_skillCreates a skill, or a new version of one.Documents, write
edit_skillReplaces one piece of text in a skill.Documents, write
create_folderCreates a private folder.Documents, write
share_folderAsks to share a folder. Basement emails a code to the person who connected the key.Documents, write
confirm_folder_shareApplies the share with that code.Documents, write

Search and text

ToolWhat it doesNeeds
searchFinds documents, files and skills. Answers up to 25 items.Documents
find_textFinds a phrase in one document or text file. Answers the lines that match.Documents
read_linesReads a range of lines of a document or a text file.Documents

Tasks

ToolWhat it doesNeeds
list_tasksLists the tasks, open ones by default.Tasks
create_taskCreates a task.Tasks, write
update_taskChanges a task’s status, title or due date, or reassigns it.Tasks, write

Connected services

ToolWhat it doesNeeds
list_connected_servicesLists the services and connections the key can use.A service
list_service_toolsLists the tools of one service, each marked read or write.That service
execute_service_toolRuns a tool of a service.That service. A write tool needs read and write.

The tools of each service come from the service itself. Call list_service_tools to see them with their arguments. See Connected services.

Names in the SDKs

In the SDKs, each tool is a method. The table shows a few; the API Reference lists all of them.

ToolTypeScriptPython
whoamibasement.whoami()basement.whoami()
list_docsbasement.docs.list()basement.docs.list()
read_docbasement.docs.read({ docId })basement.docs.read(doc_id=...)
searchbasement.search({ query })basement.search(query=...)
find_textbasement.text.find({ docId, query })basement.text.find(doc_id=..., query=...)
create_taskbasement.tasks.create({ title })basement.tasks.create(title=...)
execute_service_toolbasement.services.execute({ toolSlug, arguments })basement.services.execute(tool_slug=..., arguments=...)