Skip to main content
Glama
Sign In
feishu-user-plugin

feishu-user-plugin

by EthanQC
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

list_okr_periods

List all OKR periods (quarters and years) in your tenant, providing period IDs for filtering user OKRs.

Instructions

[Official API + UAT] List OKR periods (quarters / years) defined in the tenant. Use period_ids from this to filter list_user_okrs.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_okr_periods"
  }
}

Input Schema

NameRequiredDescriptionDefault
page_sizeNoItems per page (default 10)
page_tokenNoPagination token

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.10

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It implies read-only behavior via 'List' and reveals that the output contains period_ids. However, it does not describe pagination behavior or the full response structure. For a simple list tool, this is minimal but acceptable.

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?

The description is two sentences, front-loaded with the core purpose and followed by a practical usage note. No redundant information. The '[Official API + UAT]' prefix is extraneous but does not detract from clarity.

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?

This is a simple list tool with two optional pagination params and no output schema. The description gives purpose and usage, and hints at an output field (period_ids). It does not fully describe the response shape, but given the tool's simplicity, it is reasonably complete.

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% for both page_size and page_token, so the baseline is 3. The description does not add parameter-specific meaning beyond what the schema already provides, but no compensation is needed.

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?

The description clearly states the tool lists OKR periods (quarters/years) defined in the tenant, using a specific verb and resource. It distinguishes from sibling tools like list_user_okrs by explicitly noting that period_ids from this tool are used to filter list_user_okrs.

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?

The description provides explicit usage guidance: 'Use period_ids from this to filter list_user_okrs.' This tells the agent when and why to use this tool. However, it does not mention exclusions or other alternatives beyond that single use case.

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