Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| GETNOTE_API_KEY | Yes | Your API Key for Get笔记 Open API, obtained from https://www.biji.com/openapi | |
| GETNOTE_CLIENT_ID | Yes | Your Client ID for Get笔记 Open API, obtained from https://www.biji.com/openapi |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_notes | 获取笔记列表(每次固定返回 20 条)。首次请求 since_id 传 0,后续用上一页最后一条笔记的 ID。 |
| get_note | 获取指定笔记的详细内容,包括正文、标签、附件、音频转录、网页链接等。 |
| save_note | 新建笔记(⚠️ 仅支持新建,不支持编辑已有笔记)。支持纯文本笔记(plain_text)、链接笔记(link)和图片笔记(img_text)。 图片笔记流程:先用 upload_image 上传图片获取 image_url,再调用此接口传入 image_urls。 返回值说明:
|
| get_note_task_progress | 查询创建笔记任务的处理进度。用于链接笔记(note_type=link)创建后,通过 save_note 返回的 task_id 轮询任务状态,直到 status 变为 success(可获取 note_id)或 failed(可获取 error_msg)。建议每 10~30 秒轮询一次,约 3 分钟内完成。需要 note.content.read scope。 |
| delete_note | 删除笔记(移入回收站)。需要 note.content.trash scope。 |
| update_note | 更新已有笔记的标题、内容或标签。⚠️ 仅支持 plain_text 类型笔记,链接笔记、图片笔记等暂不支持更新。至少需要传 title、content、tags 中的一个。tags 是替换操作,会覆盖原有标签。 |
| add_note_tags | 为指定笔记添加标签。 |
| delete_note_tag | 删除笔记的指定标签(系统标签不可删除)。 |
| list_topics | 获取知识库列表(每页固定 20 条)。返回 topics[]、has_more、total。每个 topic 包含 id(alias id)、name、description、cover、stats(笔记数、文件数、博主数、直播数)等。 |
| create_topic | 创建新的知识库。⚠️ 限制:每天最多创建 50 个知识库,北京时间自然日 00:00 重置。 |
| list_topic_notes | 获取指定知识库内的笔记列表(每页 20 条)。 |
| batch_add_notes_to_topic | 批量将笔记添加到知识库(每批最多 20 个)。 |
| remove_note_from_topic | 将笔记从知识库中移除。 |
| get_upload_config | 获取图片上传配置,包括支持的文件类型、大小限制等。上传图片前先调用此接口了解约束。 |
| get_upload_token | 获取 OSS 图片上传凭证。返回 accessid/host/policy/signature 等字段,用于 multipart/form-data POST 上传图片到阿里云 OSS。上传成功后获取 image_id,再用 save_note 创建图片笔记。⚠️ mime_type 必须与实际文件格式一致,否则 OSS 签名失败。 |
| upload_image | 上传图片到 OSS。返回 image_url(用于创建图片笔记的 image_urls 参数)。 |
| list_topic_bloggers | 获取知识库订阅的博主列表。需要 topic.blogger.read scope。 |
| list_topic_blogger_contents | 获取知识库中某个博主发布的内容列表(摘要,不含原文)。需要 topic.blogger.read scope。 |
| get_blogger_content_detail | 获取博主内容详情,包含完整原文(post_media_text)。需要 topic.blogger.read scope。 |
| list_topic_lives | 获取知识库中已完成且 AI 已处理的直播列表。需要 topic.live.read scope。 |
| get_live_detail | 获取直播详情,包含 AI 摘要(post_summary)和完整原文转写(post_media_text)。需要 topic.live.read scope。 |
| get_quota | 查询当前 API Key 的调用配额,包括 read/write/write_note 三类的日/月剩余次数。 |
| recall | 全局语义搜索:在所有笔记中进行语义召回。适用场景:「搜一下」「找找我哪些笔记提到了 XX」。返回结果按相关度从高到低排序。需要 note.recall.read scope。 |
| recall_knowledge | 知识库语义搜索:在指定知识库范围内进行语义召回。适用场景:「在我的 XX 知识库搜一下 XX」。返回结果按相关度从高到低排序。需要 note.topic.recall.read scope。 |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |