Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
GWL_API_KEYYes必填。GWL API key,形如 gk_ + 43 位;长度 16~200。
GWL_TIMEOUTNo单次上游请求超时(秒,1~120)。20
GWL_USER_IDYes必填。GWL 数字用户 id(仪表盘「设置 - API Key」页面显示的数字 id)。
GWL_API_BASENo上游 API 基址;本地联调可改为 http://127.0.0.1:5000/api/v1。https://back.gwl.net.cn/api/v1
GWL_ENV_FILENo指向一个 .env 文件(真实进程环境变量优先于文件)。
GWL_HTTP_HOSTNoHTTP/SSE 传输的绑定主机。127.0.0.1
GWL_HTTP_PATHNoStreamable HTTP 路径(SSE 固定为 /sse)。/mcp
GWL_HTTP_PORTNoHTTP/SSE 传输的端口(0~65535;填 0 表示让系统挑选端口)。8765
GWL_LOG_LEVELNoDEBUG/INFO/WARNING/ERROR/CRITICAL;日志只写 stderr。WARNING
GWL_ORG_CLASSNo3 位组类 id,作为 X-Org-Class 请求头附带;不会因此提权。
GWL_ALLOW_HTTPNo上游基址是 http:// 时必须显式设为 1,防止明文泄露 key。0
GWL_MAX_RETRIESNo额外重试次数(0~5)。2
GWL_ENABLE_WRITESNo设为 0 表示只读模式,12 个写工具在调用时报错(工具仍在列表里,避免客户端行为突变)。1
GWL_TOTAL_TIMEOUTNo单次工具调用(含全部重试与退避)的总墙钟预算(秒,5~300,且需 ≥ GWL_TIMEOUT)。60
GWL_HTTP_AUTH_TOKENNo保护 MCP HTTP/SSE 端点本身的令牌(不是 GWL apikey),≥16 字符。绑非回环地址却没设置时会启动失败。
GWL_HTTP_MAX_BODY_MBNo请求体上限(MB,1~64)。16
GWL_HTTP_SESSION_TTLNo会话空闲回收(秒,60~86400)。1800
GWL_HTTP_JSON_RESPONSENo设为 1 时 POST 一律用 application/json 回应,不升级 SSE(反代会缓冲 SSE 时更稳)。0
GWL_HTTP_ALLOW_INSECURENo设为 1 允许「非回环绑定 + 不设令牌」(不推荐)。0
GWL_HTTP_ALLOWED_ORIGINSNo额外允许的浏览器 Origin,逗号分隔;默认仅允许内置回环与 Inspector(6274/6277)。SDK 精确匹配,端口要写全。

Instructions

Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.

这是 GFYGO(gwl.net.cn)的用户 API MCP 服务,全部工具都以「当前 API Key 所属用户」的身份执行,权限由服务端实时判定。 使用顺序建议:

  1. 第一次调用请走 gwl_ping,确认凭据可用并读到上游限流口径(读 120/分、写 30/分、单 IP 240/分);

  2. 找 cid 用 gwl_list_my_classes,找文档先用 gwl_list_documents / gwl_search 拿 id;

  3. 读文档正文优先 gwl_get_document_by_id(不计数);gwl_get_document 会让 view_count +1;

  4. 更新文档前必须先读到 version,并把 version 原样带回 gwl_update_document,否则并发编辑会返回 409(409 的 data 里有 current_version,重新读取后再提交);

  5. 标签写入是「全量替换」:先 gwl_get_object_tags 读回再合并提交;

  6. 不可恢复的永久删除接口刻意没有封装成工具,请勿尝试绕路删除。 参数请严格照 inputSchema 传:未知参数会被拒绝。写操作可通过 GWL_ENABLE_WRITES=0 一键关闭。 错误都以 isError=true 返回,首行是中文原因,后面附带 HTTP 状态、业务 code、Retry-After 等结构化信息。

Capabilities

Features and capabilities supported by this server

Protocol revision2025-11-25

CapabilityDetails
tools
{
  "listChanged": false
}
prompts
{
  "listChanged": false
}
resources
{
  "subscribe": false,
  "listChanged": false
}

Tools

Functions exposed to the LLM to take actions

NameDescription
gwl_pingA

验证当前 userid + apikey 是否可用,并返回身份信息与本进程生效的限流口径。 凭据(GWL_USER_ID / GWL_API_KEY)来自环境变量,工具参数里不需要也不能传 userid/apikey。 建议每次会话开始时先调用一次:它同时告诉你上游的读/写/IP 配额,便于安排后续调用节奏。返回 data 含 userid、username、real_level(1~5)、server_time(UTC ISO)、rate_limit{read_per_minute,write_per_minute,ip_per_minute,auth_fail_per_minute}。

gwl_get_meA

读取当前 API Key 所属用户的个人资料(与前端「个人中心」同源)。 返回 id、username、nickname、display_name、email、phone、avatar、theme、introduction、gender、location、group_id/group_name、slug、is_public、workspace_layout 等。 出于安全,永远不含 account_apikey、password_hash、pin;要拿权限等级请用 gwl_get_permissions。

gwl_get_permissionsA

返回本次请求实时解析出的权限(服务端每次请求重算,不信任任何客户端声明)。 字段:userid、real_level、level、context(apikey 路径恒为 null)、nodes(5 段权限节点串列表)、class_id 与 class_role(当前组类身份)。 想以某个组类身份操作,用环境变量 GWL_ORG_CLASS(或请求级 X-Org-Class 语义),不属于该组类时会被静默忽略。

gwl_list_my_classesA

平铺返回我加入或拥有的所有组类(组织 + 组),是找 cid 的入口。 每项含 id(3 位字母)、name、kind(organization/group)、org_id、owner、role、is_active、is_public、node、can_manage。 另带 status{tables_ready, missing, hint}:组织数据表未就绪时 hint 会说明原因。

gwl_list_my_orgsA

返回我加入/拥有的组织,组织为顶层、下辖我可见的组(groups 数组)。 适合先看清层级关系,再决定用哪个 cid 去调用组类详情或黑名单类工具。

gwl_get_classA

读取某个组类的详细信息:id、name、kind、org_id、owner、role、can_manage、permissions[]、permission_map。 仅成员、owner、上级组织管理方或超管可见;不是成员 403,不存在 404,cid 不是 3 位字母 400。

gwl_list_joinable_classesA

列出所有允许自助加入的 public 组(返回裸数组,上限 200 条)。 class_id 可收窄到某个组织下的组;传了不属于任何组织的 id 会 400。

gwl_get_join_infoA

查询某组类的可见性与「我」的状态:is_public、joinable、is_member、blacklisted、request(我提交的待处理申请,没有则 null)。 这条不需要组类身份,任何人都能先探测再决定要不要申请加入。

gwl_join_classA

加入组类:public 组直接入组(data.mode=joined),private 组转为提交申请(data.mode=requested)。 已经是成员不会报错,会回 already_member=true(幂等)。 失败语义:组已停用 / 非公开且不允许申请 / 我在黑名单 403;cid 非法 400。message 最多 200 个字符。

gwl_list_my_join_requestsA

列出我提交过的加入申请(裸数组)。默认只返回待处理(pending)的; handled=true 时连已批准/已拒绝/已撤回的一起返回。 每项含 group、requester_username、reviewer_username、status、already_member。

gwl_cancel_join_requestA

撤回我自己提交的加入申请,状态变为 cancelled。 只能撤自己的(否则 403);已被批准或拒绝过的再撤回会 409。 先用 gwl_list_my_join_requests 取 request_id。

gwl_list_class_join_requestsA

列出某组类收到的加入申请(裸数组,需管理权限)。 传组织 id 会汇总其下辖组的申请。status 默认 pending,可取 all / approved / rejected。需要该组类的管理角色(class_role=owner 或权限含 manage),否则 403。

gwl_review_join_requestA

批准或拒绝一条加入申请:approve=true 批准入组,false 拒绝。 批准只是建立成员关系,不会因此提权。 已处理过的再审批 409;目标用户在黑名单里 409;申请不存在 404。需要该组类的管理角色(class_role=owner 或权限含 manage),否则 403。

gwl_list_blacklistA

列出该组类的黑名单(裸数组:user_id、username、reason、created_by、created_at)。 传组织 id 时汇总下辖组。需要该组类的管理角色(class_role=owner 或权限含 manage),否则 403。

gwl_add_to_blacklistA

把一个用户加入组类黑名单(会同时给对方发一条站内通知)。 拉黑自己 400;已在名单里 409。需要该组类的管理角色(class_role=owner 或权限含 manage),否则 403。

gwl_remove_from_blacklistB

把一个用户移出组类黑名单(同样会通知对方)。 该用户不在名单里时返回 404;重复调用不幂等。需要该组类的管理角色(class_role=owner 或权限含 manage),否则 403。

gwl_list_foldersA

只列文件夹(不含文档),返回裸数组:id、name、scope、user_id、group_name、parent_id、sort_order、is_active、created_at、updated_at;group 范围的项还带 class_id/org_id/group_root。 scope 省略时返回我全部可见的文件夹;parent_id=0 只取根级,正整数只取该文件夹的直接子级,省略则返回全部层级。

gwl_list_documentsA

按范围列出文档元信息(不含正文),逐条判权后分页。 返回 {items,page,size,total,has_more};items 是 meta 视图,取正文用 gwl_get_document_by_id(不加浏览数)或 gwl_get_document(会 +1 浏览数)。 folder_id:0=根目录(默认)、-1=该范围下全部文件夹、正整数=指定文件夹。 deleted=1 只看回收站里的(需相应权限);author_id 只在 scope=public 生效。 tags 最多 8 个,tag_mode=all 表示同时命中,any 表示任一命中。

gwl_create_documentA

创建一篇文档,返回文档详情(含 content,version=1)。 title 必填非空;slug 省略时上游按毫秒时间戳自动生成,已占用则 400。 写入范围(visibility/owning/folder_id/permission_bits)由服务端做写边界校验,越界返回 403;folder_id 不存在返回 400。 本工具不幂等:网络失败时不要盲目重试,先用 gwl_list_my_documents 确认是否已经建过。

gwl_list_my_documentsA

列出我自己的未删除文档(分页包络)。 folder_id 默认 0(只看根目录);要一次看全部请传 -1。

gwl_list_trashA

列出被我软删除的文档(分页包络,按删除时间倒序)。 配合 gwl_restore_document 恢复;永久删除不提供工具。

gwl_get_documentA

按 slug 读取文档全文(返回字段随可见性做权限位掩码)。 ⚠️ 有副作用:每次命中都会 view_count + 1,因此标记为非幂等。 只是要读内容做编辑时,请改用 gwl_get_document_by_id(不加浏览数)。 不存在 404;无权查看 403。

gwl_get_document_by_idA

按文档 id 读取全文,不增加浏览数,是编辑前的推荐读法。 返回里的 version 就是乐观锁基线,更新时原样带回 data.version。 软删除的文档只有作者或超管能看到,其他人 404。

gwl_update_documentA

更新文档:至少要提供一个可变字段(title/content/summary/icon/folder_id/permission_bits/visibility/owning),否则本工具直接报参数错误而不发请求。 并发安全:强烈建议先 gwl_get_document_by_id 拿到 version 并原样传入;版本不符返回 409,且 data 带 current_version / expected_version / editor_username。 base_content 表示「你准备改动的那份原文」,必须与 content 同时提供,服务端据此自动合并他人改动。 重复提交同样内容返回 msg=无变更(幂等)。revision_summary 是这次修订的说明。

gwl_delete_documentA

把文档移入回收站(软删除,可用 gwl_restore_document 恢复)。 仅作者或被授权者,否则 403;已经是回收站状态则 404。 不可恢复的永久删除接口本服务刻意不提供。

gwl_list_document_revisionsA

列出文档的修订历史(裸数组:revision_num、editor_username、summary、has_content、created_at)。 不含正文;取某一版全文用 gwl_get_document_revision。

gwl_get_document_revisionA

读取某一版修订的全文,并带 current_version 与 can_restore。 该修订不存在 404;没有内容快照 404。

gwl_restore_document_revisionA

把文档正文恢复到某一版修订(会新写一条修订记录,因此本身可逆)。 需要可编辑权限(403),同样受乐观锁保护:建议带 version。 当前正文已经与该版一致时返回 400(重复调用不幂等)。

gwl_restore_documentA

把软删除的文档从回收站恢复回来。 文档不在回收站 400;无权恢复 403。恢复后返回文档详情(msg=恢复成功)。

gwl_searchA

按标题跨对象搜索(文档 / 组织 / 组 / 发现条目),逐条判权后分页返回。 data 里除分页包络外还有 q、types[]、counts{document,organization,group,discover},items 每项含 type、id、title、summary、icon、url、matched 与范围字段。 types 可多值;传 discover_item 会被映射成上游的 discover。 q 必填且不超过 64 个字符,否则 400。命中量超过扫描上限时返回 scan_truncated=true。

gwl_suggest_tagsA

标签输入联想;q 省略或为空时返回热门标签。 返回 {q, items[{id,name,count}]},count 是该标签被使用的次数。

gwl_get_tag_facetsA

按对象类型聚合标签用量,返回 {object_type, scope, items[{id,name,count}]}。 object_type 必填;scope 只对 document 生效;不支持的类型返回 400。

gwl_get_object_tagsA

读取某个对象当前的标签(裸数组 [{id,name}],按名称排序)。 能看到对象就能看到标签;看不到对象 404 / 403。 object_id 用字符串:文档传 doc_id,组织/组传 3 位 cid,发现条目传条目 id。

gwl_set_object_tagsA

用给定列表整体替换该对象的标签(不是追加)。 tags=[] 表示清空;超过 8 个或单个超过 24 字返回 400;无权编辑该对象返回 403。 建议先 gwl_get_object_tags 读回现有标签再合并提交,避免误删他人的标签。

gwl_list_notificationsA

返回我的站内通知 + 我当前可见的全局通知 + 未读计数。 结构:{personal[], global[](带 is_read), unread{total,global,personal}}。 这不是分页包络,用 limit 截断(默认 100,最大 200)。

gwl_mark_notifications_readA

把指定通知标记为已读,返回新的未读计数 {unread{total,global,personal}}。 global_ids 与 personal_ids 至少要给一个且不能是空列表,否则本工具直接报错。 只能标记自己的通知;别人的 id 会被上游静默忽略。操作幂等(重复调用结果一致)。

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription
api-overviewGWL /api/v1 的基址、鉴权方式、限流口径、超时与重试策略、写保护状态(不含任何密钥)。
tool-inventory每个 MCP 工具对应的上游方法/路径、读写属性与参数列表;用于核对能力覆盖。
me当前 API Key 所属用户的资料(等价于 GET /api/v1/me)。
permissions当前请求的实时权限快照(等价于 GET /api/v1/permissions)。
notifications个人通知 + 可见的全局通知 + 未读计数(等价于 GET /api/v1/notifications?limit=50)。

TDQS

A3.7/5.0

Scored across 36 tools

Disambiguation4/5

Most tools have sharply distinct purposes, and the descriptions explicitly disambiguate dangerous near-pairs (gwl_get_document vs gwl_get_document_by_id, gwl_list_documents vs gwl_list_my_documents, gwl_ping vs gwl_get_me vs gwl_get_permissions). The remaining fuzziness is mild: gwl_list_my_classes, gwl_list_my_orgs and gwl_list_joinable_classes all partly answer "what can I access", and the three tag tools plus gwl_search overlap slightly on discovery.

Naming Consistency5/5

Every tool uses the same gwl_ prefix plus snake_case verb_noun construction (get/list/create/update/delete/restore/add/remove/set/join/cancel/review/mark/search/suggest), with no camelCase or stylistic drift. Only gwl_ping lacks a verb, which is a trivial and conventional exception.

Tool Count3/5

36 tools is heavy, but the surface genuinely spans several domains (identity/permissions, orgs & groups, join-request workflow, blacklist, documents + revisions, tags, search, notifications). It is still borderline oversized: the document and membership clusters each run ~12 tools and offer obvious consolidation room (e.g. separate list_my_documents / list_documents / list_trash variants).

Completeness3/5

Document lifecycle is excellent (create/read/update/soft-delete/restore, revisions and revision restore, trash), and the join-request and blacklist workflows are fully closed-loop. However there are notable holes: no way to list or remove members of a class, no leave_class, and folders are read-only (list_folders only) despite folder_id being required for create_document — agents will dead-end needing a folder they cannot create or manage.

Maintenance

ActivityMaintained
ResponsivenessNo recent community issues