What Your AI Assistant Can Do

When you connect DocStar, your assistant gets a set of tools. You don't call them yourself: ask in plain language and the assistant picks the right one. This page explains what each tool does so you know what to ask for.

Building an MCP server for your own app? Start with Build an MCP server for your app. The tools below are what your assistant uses to do it.

#

Find your work

Tool What it does
list_organizations Lists the workspaces you belong to. The assistant always asks which one to use.
list_collections Lists the collections (docs sites) in a workspace.
list_collection_pages Lists every page in a collection, so the assistant can find the one you mean.
#

Read and write pages

Tool What it does
get_page_content Reads a page's current content. The assistant reads before it edits.
create_page Creates a page or subpage with its content.
update_page Renames a page, changes its URL, or replaces its content.

Content is written in Markdown, so headings, lists, tables, code blocks and links all work.

#

Document APIs

Tool What it does
create_endpoint Adds an API endpoint: method, URL, headers, parameters, request body and sample responses.
update_endpoint Changes an endpoint's documentation.

Write a clear description and a full JSON body example for every endpoint. They are what assistants use to call your API correctly.

#

Publish

Tool What it does
update_page_state Publishes or unpublishes a page.
update_endpoint_state Publishes or unpublishes an API endpoint.

Every change is saved as a draft first. A page goes live only when it is published, and a page's parent must be published before the page itself.

#

Talk to the DocStar team

Tool What it does
send_feedback_to_docstar Sends a bug report, feature request or docs problem to the DocStar team, with your name attached. The assistant shows you the message before sending.
#

Everything else

The assistant can also reach the rest of DocStar's API. That includes your MCP server's tools, skill, instructions and custom domain, plus FAQs, changelogs, redirects, webhooks and environments. It looks up the right endpoint in DocStar's API docs and calls it for you, using search_docstar_docs, get_docstar_api_docs and call_any_api_of_docstar.

#

Example requests

  • "List my DocStar workspaces."
  • "Turn the API in this repo into an MCP server with DocStar. Read the code, document the endpoints and pick the 10 most important as tools."
  • "Write the skill for my Orders API MCP server and explain which endpoint to call first."
  • "In the Help Docs collection, add a page called 'Billing FAQ' under Getting Started."
  • "Read the Webhooks page and rewrite it so it's easier for beginners. Show me the new version before saving."
  • "Document every route in src/routes/orders.ts in the Orders API collection, then publish them."
  • "Unpublish the Beta Features page."
  • "Report a bug to DocStar: publishing fails when the page title has an emoji."
#

Good to know

  • Rewrites replace the whole page. When you ask for an edit, the assistant reads the page first and saves the complete new version.
  • Changing a URL can break links. Ask the assistant to keep a redirect from the old URL.
  • Deleting is deliberate. There are no shortcut tools for deleting. The assistant can still delete through the API, and always asks you first.
Built with DocStar