Skip to main content
Glama
MichealJou

yuque-mcp-plus

by MichealJou
OverviewSchemaRelated ServersScoreDiscussions
JavaScript
Remote

yuque_search

Search documents, books, or users within the Yuque knowledge base platform to find specific content and information.

Instructions

Search Yuque content.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesSearch query.
typeNoSearch type.
pageNoPage number.
repoIdNoOptional repository ID filter.

Implementation Reference

  • src/tools.js:451-451 (handler)
    The handler function for the yuque_search tool, which calls the client's search method and wraps the result in jsonText.
    yuque_search: async (args, client) => jsonText(await client.search(args)),
  • src/tools.js:258-271 (schema)
    The definition and input schema for the yuque_search tool.
    {
  name: "yuque_search",
  description: "Search Yuque content.",
  inputSchema: {
    type: "object",
    properties: {
      query: schemaProperty("string", "Search query.", { minLength: 1 }),
      type: schemaProperty("string", "Search type.", { enum: ["DOC", "BOOK", "USER"] }),
      page: schemaProperty("number", "Page number.", { minimum: 1 }),
      repoId: schemaProperty("number", "Optional repository ID filter.")
    },
    required: ["query"]
  }
},

Tool Definition Quality

D1.8/5.0
Behavior1/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure, yet provides no information about result pagination limits (despite having a page parameter), result schema, case sensitivity, or rate limiting. The agent cannot determine if this is read-only or what the search returns without trial invocation.

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

Conciseness2/5

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

At three words ('Search Yuque content.'), it is technically concise, but severely under-loaded for a four-parameter tool with no annotations. The single sentence fails to earn its place by providing insufficient information density.

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

Completeness2/5

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

Given four parameters, 100% schema coverage but minimal descriptions therein, no annotations, and no output schema, the description inadequately prepares the agent to interpret results or understand search scope. It should explain what Yuque content comprises or what the search returns.

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 coverage is 100% with all four parameters documented. The description adds no parameter-specific semantics (e.g., explaining query syntax, page size defaults, or that repoId restricts scope), but baseline 3 is warranted given the schema carries the full load.

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

Purpose2/5

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

The description states a basic verb ('Search') and resource ('Yuque content'), but fails to specify the searchable entity types (DOC, BOOK, USER per the schema enum) or distinguish from sibling list/get operations like yuque_get_docs or yuque_list_docs. It is minimally informative and borders on tautology.

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

Usage Guidelines1/5

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

No guidance provided on when to use search versus alternatives like yuque_get_docs, yuque_list_docs, or yuque_get_repo. No mention of prerequisites, required authentication scope, or when the optional repoId filter should be applied.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/MichealJou/yuque-mcp-plus'

If you have feedback or need assistance with the MCP directory API, please join our Discord server