Skip to main content
Glama

yuque_multipart_request

Upload files to Yuque knowledge base using multipart form-data for attachments and other upload workflows. Specify HTTP method, API path, parameters, and file details.

Instructions

Generic Yuque multipart request for upload-style endpoints such as attachment workflows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
methodNoHTTP method.
pathYesAPI path starting with /, for example /repos/123/resources.
paramsNoOptional query parameters.
fieldsNoOptional multipart text fields.
filesYesFiles to upload as multipart form-data.

Implementation Reference

  • The handler for 'yuque_multipart_request' calls 'client.multipartRequest(args)' and wraps the result in 'jsonText'.
    yuque_multipart_request: async (args, client) => jsonText(await client.multipartRequest(args)),
  • Definition of the 'yuque_multipart_request' tool including its input schema.
    {
      name: "yuque_multipart_request",
      description: "Generic Yuque multipart request for upload-style endpoints such as attachment workflows.",
      inputSchema: {
        type: "object",
        properties: {
          method: schemaProperty("string", "HTTP method.", { enum: ["POST", "PUT", "PATCH"] }),
          path: schemaProperty("string", "API path starting with /, for example /repos/123/resources."),
          params: {
            type: "object",
            description: "Optional query parameters."
          },
          fields: {
            type: "object",
            description: "Optional multipart text fields."
          },
          files: {
            type: "array",
            description: "Files to upload as multipart form-data.",
            items: {
              type: "object",
              properties: {
                fieldName: schemaProperty("string", "Multipart field name."),
                filePath: schemaProperty("string", "Absolute or workspace-local file path."),
                filename: schemaProperty("string", "Optional override filename."),
                contentType: schemaProperty("string", "Optional MIME type.")
              },
              required: ["fieldName", "filePath"]
            }
          }
        },
        required: ["path", "files"]
      }
Behavior2/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. While it mentions 'multipart' indicating the HTTP mechanism, it fails to disclose mutation safety, auth requirements, rate limits, return value structure, or potential side effects of uploading files to arbitrary paths.

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

Conciseness4/5

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

The description is a single, efficient sentence with no wasted words. It front-loads the key identifier ('Generic Yuque multipart request') and qualifies it with use cases. It is appropriately concise, though the complexity of this generic tool arguably warrants a second sentence explaining its role as an escape hatch.

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?

Given 100% schema coverage and 5 well-documented parameters, the description provides the minimum viable context for a low-level HTTP utility. However, as a generic 'escape hatch' tool among many specific resource-oriented siblings, it should explicitly state that this is for operations not covered by specific tools (like attachment uploads) and warn about the low-level nature of the operation.

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%, establishing a baseline of 3. The description adds domain context ('multipart,' 'upload-style') that helps clarify the intent behind the `files` and `fields` parameters, but does not elaborate on specific parameter syntax, validation rules, or interdependencies beyond what the schema already documents.

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

Purpose4/5

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

The description identifies this as a multipart request tool for 'upload-style endpoints' and 'attachment workflows,' providing a clear verb (request) and resource scope. It implicitly distinguishes this from the sibling `yuque_request` tool by specifying 'multipart,' though it could explicitly clarify when to choose this over the generic request tool.

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

Usage Guidelines3/5

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

The description implies usage context through examples like 'attachment workflows' and 'upload-style endpoints,' suggesting when it might be needed. However, it lacks explicit guidance on when NOT to use this tool (e.g., for standard JSON API calls) or direct comparison to the `yuque_request` sibling.

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