Skip to main content
Glama
xgq18237

SiYuan MCP Server

by xgq18237

put_file

Destructive

Write a file to a specific workspace path, optionally creating directories, with support for base64, local file, or text content.

Instructions

通过 Multipart 写入工作空间文件

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNo兼容字段:UTF-8 文本内容
pathYes目标工作空间路径
isDirNo是否创建目录
modTimeNoUnix 修改时间
fileNameNoMultipart 文件名
filePathNo要上传的本地文件路径
mimeTypeNoMIME 类型
contentBase64NoBase64 文件内容
Behavior2/5

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

Annotations declare destructiveHint: true, but the description adds no extra behavioral details. It does not mention permissions, side effects, or that it may overwrite existing files. The term 'Multipart' hints at upload mechanism but is not elaborated.

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 extremely concise (one sentence). However, it is adequately front-loaded and contains no filler. It could benefit from slightly more detail without becoming verbose.

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?

The tool has 8 parameters with a complex oneOf structure, yet the description provides no guidance on usage or return values. No output schema exists, so the description should cover what the tool returns, which it does not.

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 descriptions in the schema. The description adds no additional parameter meaning, but the baseline is 3 due to high coverage. It does not clarify how parameters relate (e.g., oneOf usage).

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

Purpose3/5

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

The description '通过 Multipart 写入工作空间文件' indicates writing files via Multipart, but it's vague. It doesn't specify whether it creates or overwrites files, and 'Multipart' is not explained. Compared to siblings like get_file and remove_file, the purpose is somewhat clear but lacks precision.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives (e.g., other file manipulation tools). No context about prerequisites or typical scenarios is provided.

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/xgq18237/siyuan_mcp_server'

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