Skip to main content
Glama
bim-ba

ycli

by bim-ba
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

List Forms surveys

forms_surveys_list
Read-onlyIdempotent

List accessible forms and surveys with filters for name, group, ownership, publication, and favourites, then use each returned ID for related form retrieval tools.

Instructions

Every form (survey) the caller can see, auto-paginated over the API's offset pages.

Capped at the configured item cap unless limit is given. Each item's id is the form id you pass to surveys_get / questions_list / answers_list.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoKeep the forms whose name matches.
groupNoKeep the forms of this group.
limitNoMax forms to return; omitted means the configured cap (YCLI__HTTP__MAX_ITEMS).
orderbyNoSort, a comma list such as ``name,-modified,-count``.
show_allNoFor an administrator, every form of the organization.
favouriteNoOnly favourites (true) or only the others (false).
ownershipNo``mine`` (created by the caller) or ``shared`` (open to them).
publishedNoOnly published (true) or only unpublished (false).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.122.1
    • addedInput schema / properties / show_all / anyOf
      Added value: +[
+  {
+    "type": "boolean"
+  },
+  {
+    "type": "null"
+  }
+]
    • changedInput schema / properties / show_all / default
      Previous value: -falseNew value: +null
    • removedInput schema / properties / show_all / type
      Removed value: -"boolean"
  2. First observedv0.67.0

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=true, so the safety profile is covered. The description adds real behavior beyond that: automatic pagination across the API's offset pages, and an implicit item cap that only 'limit' overrides. It stops short of describing result fields or rate limits, but the added context is substantive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the purpose and scope, followed by the pagination/cap constraint and the id linkage. Nothing is padded and each sentence carries operational value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description must carry return-value context; it does disclose pagination and that each item carries an 'id' usable downstream. It omits what other fields an item contains, which is the only notable gap for a read-only list tool with fully documented filters.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all eight filters (name, group, orderby, show_all, favourite, ownership, published, limit) are already documented in the schema. The description only restates the limit/cap relationship, which the schema's own 'limit' description already explains, so it adds no new parameter meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('List') and resource ('every form (survey)') plus the access scope ('the caller can see'), and it positions itself as the entry point whose item ids feed surveys_get / questions_list / answers_list. An agent can tell this apart from the get/list siblings without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear usage context: call this to enumerate forms and obtain the form ids needed downstream by surveys_get / questions_list / answers_list. It does not state when-not to use it or name an alternative list tool, but for a list endpoint tied to a known family the context is sufficient.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools