Skip to main content
Glama

yuque_request

Execute custom API requests to the Yuque knowledge base platform for endpoints not covered by dedicated tools, enabling flexible data operations.

Instructions

Generic Yuque OpenAPI request passthrough for endpoints not wrapped by dedicated tools.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
methodNoHTTP method.
pathYesAPI path starting with /, for example /repos/123.
paramsNoOptional query parameters.
bodyNoOptional JSON request body.

Implementation Reference

  • The implementation of the yuque_request tool, which calls the client's rawRequest method.
    yuque_request: async (args, client) => jsonText(await client.rawRequest(args)),
  • The input schema definition for the yuque_request tool.
    {
      name: "yuque_request",
      description: "Generic Yuque OpenAPI request passthrough for endpoints not wrapped by dedicated tools.",
      inputSchema: {
        type: "object",
        properties: {
          method: schemaProperty("string", "HTTP method.", { enum: ["GET", "POST", "PUT", "DELETE", "PATCH"] }),
          path: schemaProperty("string", "API path starting with /, for example /repos/123."),
          params: {
            type: "object",
            description: "Optional query parameters."
          },
          body: {
            type: "object",
            description: "Optional JSON request body."
          }
        },
        required: ["path"]
      }
    },
Behavior2/5

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

No annotations provided, so description carries full burden. While 'passthrough' indicates direct API proxying, it fails to disclose that this supports destructive operations (DELETE, PUT), lacks rate limit warnings, or return value structure despite being a generic HTTP wrapper.

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?

Single 12-word sentence with zero waste. Front-loaded with the generic nature, followed immediately by the scope constraint. Every word earns its place.

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

Completeness3/5

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

Adequate for a passthrough tool but missing critical safety context given it supports all HTTP methods including DELETE with no annotations or output schema. Should warn about destructive capabilities and auth requirements.

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 has 100% description coverage with clear descriptions for method, path, params, and body. Description contains minimal parameter-specific semantics, but with complete schema coverage, no compensation is needed; baseline 3 is appropriate.

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?

Excellent clarity: 'Generic Yuque OpenAPI request passthrough' specifies the verb/pattern, and 'for endpoints not wrapped by dedicated tools' clearly scopes it against the extensive sibling tool list (create_doc, get_doc, etc.).

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?

Clear when-to-use ('endpoints not wrapped by dedicated tools'), which implicitly defines when NOT to use it (use specific siblings instead). However, lacks explicit guidance to 'prefer dedicated tools first' or examples of covered endpoints.

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