Tools - NeetoKB Docs

You do not need these names to use the server. Ask in plain language and the assistant picks the right tool. The list is here for when you want to know exactly what a connection can do. Every tool takes an optional workspace argument, the subdomain of a connected workspace. Left out, it runs against the workspace the connection was set up with. ListWorkspaces reports the values you can pass. What a tool returns depends on the credential behind the connection. Over OAuth, listings are filtered to the permissions of the person who approved it and an article they cannot open is refused; an API key reaches the whole workspace. A tool that creates, updates, or deletes is also refused when the OAuth connection was approved without the Create and update or Delete permission.

Articles

Tool	What it does
`SearchArticles`	Full-text search across published articles, ranked by relevance, returning each match with its id, title, absolute URLs and a highlighted snippet. Paginated.
`ListArticles`	Lists articles in the workspace, drafts alongside published, with optional filters for state, search term and category, plus sort order and pagination.
`GetArticle`	Returns one article in full, including its HTML content, plain text content, category, author, tags and URLs. Covers drafts and published articles alike.
`GetPublicArticle`	Reads one published article from any workspace by its subdomain and id, without workspace access. Returns only published articles in non-private categories, from workspaces that do not require sign in.
`CreateArticle`	Creates an article under a category path given as an array of category names, innermost first, such as `["Getting Started", "Help"]`, auto-creating any missing categories. Defaults to a draft; a published article is readable on the public knowledge base site.
`UpdateArticle`	Updates an article’s title, HTML content, slug or state. Publishing applies the changes to the live article and promotes any draft revision it was carrying.
`search`	Searches published articles and returns up to 20 matches, each with its id, title, an openable URL and a short extract.
`fetch`	Returns the full text of one published article by its id.

Article tools address an article by its slug, its permalink identifier (a-XXXXXXXX) or its UUID. GetPublicArticle also needs the workspace subdomain, and it never exposes drafts or the author’s email address. It has no page in the API reference, which is why it is not linked above.

search and fetch are the two tools the ChatGPT connector specification requires, so they overlap with SearchArticles and GetArticle rather than adding anything new. They have no separate REST endpoint, which is why they are not linked above.

Unlisted links

Tool	What it does
`GetUnlistedLink`	Returns the unlisted share link an article already has. Only published articles can have one.
`RegenerateUnlistedLink`	Issues a fresh unlisted link for a published article, with an optional expiry, and is how an article gets its first link.

An unlisted link is an article’s secret share URL, which lets anyone holding it read the article without signing in. Treat the URL as sensitive.

RegenerateUnlistedLink replaces the token, so any previously shared URL stops working immediately. Confirm nobody still depends on the old link before you approve the call.

Tool	What it does
`ListCategories`	Lists every category the workspace holds, including private categories and categories that carry no articles yet, flattened depth first with each category’s parent, depth and published article counts.

Authors

Tool	What it does
`ListAuthors`	Lists the people credited on at least one article, deactivated members included, with each author’s name, email address and profile image.

Recommendations

Tool	What it does
`ListRecommendations`	Lists the article recommendations configured for the workspace, each with a preview of the published articles it surfaces. Can be narrowed to the recommendations that match a page path.

Team members

Tool	What it does
`ListTeamMembers`	Lists active team members with their id, email address, name, time zone and role. Can be narrowed to one exact email address.
`GetTeamMember`	Returns one active team member’s email address, name, time zone and role.
`CreateTeamMember`	Invites one or more people to the workspace by email, each assigned a role. An address that already belongs to the workspace is not invited again.
`UpdateTeamMember`	Updates a team member’s email address, name, time zone or role.
`DeleteTeamMember`	Deactivates a team member, ending their access. Their user record is kept so the articles they authored stay attributed to them.

The team member tools also check the connected person’s NeetoKB role: it must allow managing members, and changing a member’s role needs the manage-roles permission as well. These are role permissions inside NeetoKB, separate from the Create and update and Delete permissions ticked when approving the connection. An API key skips role checks.

Workspace

Tool	What it does
`GetSetting`	Reads the public knowledge base settings: its configured name and the root URL where it is hosted.
`ListWorkspaces`	Lists the workspaces this connection can reach, with each one’s name and subdomain and which is the default. Pass a subdomain as the `workspace` argument of other tools to target that workspace.

An OAuth grant covers every workspace ticked on the Authorize access screen, which can be more than one. An API key covers the workspace it was generated in.

​Articles

​Unlisted links

​Categories

​Authors

​Recommendations

​Team members

​Workspace

Articles

Unlisted links

Categories

Authors

Recommendations

Team members

Workspace