Skip to main content
Glama
GetNote MCP Server

GetNote MCP Server

by iswalle

save_note

Create new plain text, link, or image notes in GetNote. Use for adding fresh notes only; existing notes cannot be edited.

Instructions

新建笔记(⚠️ 仅支持新建,不支持编辑已有笔记)。支持纯文本笔记(plain_text)、链接笔记(link)和图片笔记(img_text)。

🔗 笔记内链:Get笔记正文支持链接到其他笔记,格式为 https://biji.com/note/{note_id}。如需在笔记正文中引用其他笔记,按此格式填写 content 中的链接。若当前笔记后续会被分享出去,则应优先调用 share_note 工具获取被引用笔记的分享链接,并以分享链接替代内链写入正文。

图片笔记流程:先用 upload_image 上传图片获取 image_url,再调用此接口传入 image_urls。

返回值说明:

  • plain_text:同步返回 id、title、created_at、updated_at。

  • link(分享链接:biji.com/note/share_note/* 或 d.biji.com/* 短链):同步返回 id、title、created_at、updated_at,无需轮询。

  • link(普通链接):返回 tasks 数组(每项含 task_id 和 url),需用 get_note_task_progress 轮询进度。

Input Schema

NameRequiredDescriptionDefault
tagsNo标签列表(最多 5 个,每个不超过 10 个汉字)
titleNo笔记标题
contentNo笔记正文(Markdown 格式)。链接笔记不需要此字段
link_urlNo链接 URL(note_type=link 时必填)。分享链接(biji.com/note/share_note/* 或 d.biji.com/* 短链)同步返回笔记 ID;普通链接异步处理需轮询
topic_idNo目标知识库 ID(来自 list_topics;支持 DEFAULT、BOOKSPACE、CUSTOMER、TEAMSPACE)
note_typeNo笔记类型:plain_text(纯文本,默认)、link(链接笔记)、img_text(图片笔记)plain_text
parent_idNo父笔记 ID(优先传十进制字符串;创建子笔记时填,父笔记的 is_child_note 必须为 false)
image_urlsNo图片 URL 列表(note_type=img_text 时必填)
client_request_idNo可选幂等键(1-128 个 ASCII 字符)。重试同一创建请求时必须复用同一个值

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv1.10.1
    • addedInput schema / properties / client_request_id
      Added value: +{
      +  "description": "可选幂等键(1-128 个 ASCII 字符)。重试同一创建请求时必须复用同一个值",
      +  "type": "string"
      +}
    • changedInput schema / properties / link_url / description
      Previous value: -"链接 URL(note_type=link 时必填)"New value: +"链接 URL(note_type=link 时必填)。分享链接(biji.com/note/share_note/* 或 d.biji.com/* 短链)同步返回笔记 ID;普通链接异步处理需轮询"
    • changedInput schema / properties / parent_id / description
      Previous value: -"父笔记 ID(创建子笔记时填,父笔记的 is_child_note 必须为 false)"New value: +"父笔记 ID(优先传十进制字符串;创建子笔记时填,父笔记的 is_child_note 必须为 false)"
    • changedInput schema / properties / parent_id / type
      Previous value: -[
      -  "number",
      -  "string"
      -]New value: +[
      +  "string",
      +  "number"
      +]
    • addedInput schema / properties / topic_id
      Added value: +{
      +  "description": "目标知识库 ID(来自 list_topics;支持 DEFAULT、BOOKSPACE、CUSTOMER、TEAMSPACE)",
      +  "type": "string"
      +}
  2. First observedv1.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the burden well: it discloses that ordinary link notes are asynchronous and return a tasks array requiring polling, while plain_text and share-link notes return ids synchronously, and it lists the returned fields per type. Gaps remain on permissions, quota implications (a get_quota sibling exists) and what happens to topic placement if topic_id is omitted.

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?

Front-loads the most important constraint (create-only) and uses bold section headers so the flow and return-value rules are scannable. It is somewhat long and repeats the share-link sync/async rule that the link_url schema field already states, which is mild duplication.

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?

A 9-parameter, multi-mode creation tool with no output schema, and the description compensates by explaining return values per note type and the chained upload/poll tools. Not fully complete: no guidance on default topic placement, sub-note creation via parent_id, or limits/idempotency expectations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so baseline is 3; the description adds genuine meaning beyond it by explaining the required two-step image_urls flow, the internal-link URL format for content, and the sync/async consequence of link_url type. It does not add anything about parent_id or topic_id semantics, which remain schema-only.

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?

Opens with a specific verb+resource (create a note) and immediately draws the boundary against the closest sibling by stating it only creates and cannot edit existing notes (update_note exists among siblings). It then enumerates the three supported note types, so an agent can distinguish it from get_note/list_notes without opening the schema.

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

Usage Guidelines5/5

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

Gives explicit workflows and alternatives: for img_text call upload_image first to obtain image_url, and for citing notes in shared contexts prefer share_note and embed the share link instead of an internal link. It also states when polling is required (ordinary links via get_note_task_progress) versus not required (share links), which is exactly the when-to-use routing an agent needs.

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