Yuque MCP
mcpkey · packageio.github.wwwwujl/yuque-mcp · v1.1.0
Yuque MCP server with safe read/write tools for groups, group members, repositories, docs, and TOC.
run it
on your own machines, one way per deploy methodgenerated from the record, not tested yet
# once, as root:
# as_mcp DIR COMMAND...: runs COMMAND as the mcp user in DIR, its home, sandboxed as the
# units are: a package's install scripts can write to DIR only, as the server later can
as_mcp() {
local dir="$1"; shift
systemd-run --quiet --wait --pipe --collect --uid=mcp --gid=mcp \
-p WorkingDirectory="$dir" -p Environment=HOME="$dir" -p ReadWritePaths="$dir" \
-p NoNewPrivileges=true -p ProtectSystem=strict -p ProtectHome=true -p PrivateTmp=true \
-- "$@" </dev/null
}
install -d -m 0750 -o mcp -g mcp /var/lib/mcp/yuque
# yuque: its packages, installed whole before its unit starts (no session installs)
# npx takes a half-installed tree for installed: a rerun starts them afresh
systemctl stop mcp-my-agent-yuque.service 2>/dev/null || true
as_mcp /var/lib/mcp/yuque rm -rf /var/lib/mcp/yuque/.npm/_npx
as_mcp /var/lib/mcp/yuque npx --yes --package=@wwwwwujl/[email protected] -- true
as_mcp /var/lib/mcp/yuque npx --yes --package=supergateway@4 -- true
#!/usr/bin/env bash
# yuque (io.github.wwwwujl/yuque-mcp), recipe baremetal (generated).
# Generated by Hub for toolset "my-agent"; started by mcp-my-agent-yuque.service.
set -euo pipefail
export HOST=127.0.0.1 PORT=8101
exec npx -y supergateway@4 --stdio 'npx -y @wwwwwujl/[email protected]' --outputTransport streamableHttp --stateful --host 127.0.0.1 --port 8101 --streamableHttpPath /mcp --healthEndpoint /healthz
[Unit]
Description=MCP server yuque (toolset my-agent), generated by Hub
After=network-online.target
Wants=network-online.target
[Service]
Type=simple
User=mcp
Group=mcp
EnvironmentFile=/etc/mcp/my-agent.env
Environment=HOME=/var/lib/mcp/yuque
WorkingDirectory=/var/lib/mcp/yuque
ExecStart=/opt/mcp/my-agent/bin/yuque.sh
Restart=on-failure
RestartSec=5
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
PrivateTmp=true
ReadWritePaths=/var/lib/mcp/yuque
[Install]
WantedBy=multi-user.target
generated from the record, not tested yet
docker run --rm -p 127.0.0.1:8101:8000 -e YUQUE_TOKEN -e YUQUE_ENDPOINT -e YUQUE_TIMEOUT_MS -e YUQUE_MAX_RETRIES -e YUQUE_ALLOW_WRITE -e YUQUE_WRITE_NAMESPACE_ALLOWLIST -e YUQUE_WRITE_GROUP_ALLOWLIST -e YUQUE_ALLOW_DELETE -e YUQUE_DELETE_NAMESPACE_ALLOWLIST -e YUQUE_FILE_ROOT -e YUQUE_FILE_MAX_BYTES -e YUQUE_FILE_ALLOWED_EXTENSIONS node:22-alpine sh -c 'npx -y supergateway@4 --stdio '"'"'npx -y @wwwwwujl/[email protected]'"'"' --outputTransport streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz'
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-19T02:31:21+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
yuque:
image: node:22-alpine
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @wwwwwujl/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
ports:
- 127.0.0.1:8101:8000
volumes:
- npm-cache:/root/.npm
healthcheck:
test:
- CMD-SHELL
- wget -qO- http://127.0.0.1:8000/healthz || exit 1
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
YUQUE_TOKEN: ${YUQUE_TOKEN}
YUQUE_ENDPOINT: ${YUQUE_ENDPOINT}
YUQUE_TIMEOUT_MS: ${YUQUE_TIMEOUT_MS}
YUQUE_MAX_RETRIES: ${YUQUE_MAX_RETRIES}
YUQUE_ALLOW_WRITE: ${YUQUE_ALLOW_WRITE}
YUQUE_WRITE_NAMESPACE_ALLOWLIST: ${YUQUE_WRITE_NAMESPACE_ALLOWLIST}
YUQUE_WRITE_GROUP_ALLOWLIST: ${YUQUE_WRITE_GROUP_ALLOWLIST}
YUQUE_ALLOW_DELETE: ${YUQUE_ALLOW_DELETE}
YUQUE_DELETE_NAMESPACE_ALLOWLIST: ${YUQUE_DELETE_NAMESPACE_ALLOWLIST}
YUQUE_FILE_ROOT: ${YUQUE_FILE_ROOT}
YUQUE_FILE_MAX_BYTES: ${YUQUE_FILE_MAX_BYTES}
YUQUE_FILE_ALLOWED_EXTENSIONS: ${YUQUE_FILE_ALLOWED_EXTENSIONS}
volumes:
npm-cache: {}
uv-cache: {}
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-19T02:31:21+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: yuque
namespace: mcp
labels: &id001
app: yuque
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: yuque
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: YUQUE_TOKEN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_TOKEN
- name: YUQUE_ENDPOINT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_ENDPOINT
- name: YUQUE_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_TIMEOUT_MS
- name: YUQUE_MAX_RETRIES
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_MAX_RETRIES
- name: YUQUE_ALLOW_WRITE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_ALLOW_WRITE
- name: YUQUE_WRITE_NAMESPACE_ALLOWLIST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_WRITE_NAMESPACE_ALLOWLIST
- name: YUQUE_WRITE_GROUP_ALLOWLIST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_WRITE_GROUP_ALLOWLIST
- name: YUQUE_ALLOW_DELETE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_ALLOW_DELETE
- name: YUQUE_DELETE_NAMESPACE_ALLOWLIST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_DELETE_NAMESPACE_ALLOWLIST
- name: YUQUE_FILE_ROOT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_FILE_ROOT
- name: YUQUE_FILE_MAX_BYTES
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_FILE_MAX_BYTES
- name: YUQUE_FILE_ALLOWED_EXTENSIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_FILE_ALLOWED_EXTENSIONS
args:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @wwwwwujl/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: yuque
namespace: mcp
spec:
selector:
app: yuque
ports:
- port: 8000
targetPort: http
name: http
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-19T02:31:21+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
yuque:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: yuque
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: YUQUE_TOKEN
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_TOKEN
- name: YUQUE_ENDPOINT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_ENDPOINT
- name: YUQUE_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_TIMEOUT_MS
- name: YUQUE_MAX_RETRIES
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_MAX_RETRIES
- name: YUQUE_ALLOW_WRITE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_ALLOW_WRITE
- name: YUQUE_WRITE_NAMESPACE_ALLOWLIST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_WRITE_NAMESPACE_ALLOWLIST
- name: YUQUE_WRITE_GROUP_ALLOWLIST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_WRITE_GROUP_ALLOWLIST
- name: YUQUE_ALLOW_DELETE
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_ALLOW_DELETE
- name: YUQUE_DELETE_NAMESPACE_ALLOWLIST
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_DELETE_NAMESPACE_ALLOWLIST
- name: YUQUE_FILE_ROOT
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_FILE_ROOT
- name: YUQUE_FILE_MAX_BYTES
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_FILE_MAX_BYTES
- name: YUQUE_FILE_ALLOWED_EXTENSIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: YUQUE_FILE_ALLOWED_EXTENSIONS
args:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @wwwwwujl/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: YUQUE_TOKEN, YUQUE_ENDPOINT, YUQUE_TIMEOUT_MS, YUQUE_MAX_RETRIES, YUQUE_ALLOW_WRITE, YUQUE_WRITE_NAMESPACE_ALLOWLIST, YUQUE_WRITE_GROUP_ALLOWLIST, YUQUE_ALLOW_DELETE, YUQUE_DELETE_NAMESPACE_ALLOWLIST, YUQUE_FILE_ROOT, YUQUE_FILE_MAX_BYTES, YUQUE_FILE_ALLOWED_EXTENSIONS. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsnpx -y @wwwwwujl/[email protected] # env: YUQUE_TOKEN, YUQUE_ENDPOINT, YUQUE_TIMEOUT_MS, YUQUE_MAX_RETRIES, YUQUE_ALLOW_WRITE, YUQUE_WRITE_NAMESPACE_ALLOWLIST, YUQUE_WRITE_GROUP_ALLOWLIST, YUQUE_ALLOW_DELETE, YUQUE_DELETE_NAMESPACE_ALLOWLIST, YUQUE_FILE_ROOT, YUQUE_FILE_MAX_BYTES, YUQUE_FILE_ALLOWED_EXTENSIONS
{
"mcpServers": {
"yuque": {
"command": "npx",
"args": [
"-y",
"@wwwwwujl/[email protected]"
],
"env": {
"YUQUE_TOKEN": "${YUQUE_TOKEN}",
"YUQUE_ENDPOINT": "${YUQUE_ENDPOINT}",
"YUQUE_TIMEOUT_MS": "${YUQUE_TIMEOUT_MS}",
"YUQUE_MAX_RETRIES": "${YUQUE_MAX_RETRIES}",
"YUQUE_ALLOW_WRITE": "${YUQUE_ALLOW_WRITE}",
"YUQUE_WRITE_NAMESPACE_ALLOWLIST": "${YUQUE_WRITE_NAMESPACE_ALLOWLIST}",
"YUQUE_WRITE_GROUP_ALLOWLIST": "${YUQUE_WRITE_GROUP_ALLOWLIST}",
"YUQUE_ALLOW_DELETE": "${YUQUE_ALLOW_DELETE}",
"YUQUE_DELETE_NAMESPACE_ALLOWLIST": "${YUQUE_DELETE_NAMESPACE_ALLOWLIST}",
"YUQUE_FILE_ROOT": "${YUQUE_FILE_ROOT}",
"YUQUE_FILE_MAX_BYTES": "${YUQUE_FILE_MAX_BYTES}",
"YUQUE_FILE_ALLOWED_EXTENSIONS": "${YUQUE_FILE_ALLOWED_EXTENSIONS}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add yuque -e "YUQUE_TOKEN=${YUQUE_TOKEN}" -e "YUQUE_ENDPOINT=${YUQUE_ENDPOINT}" -e "YUQUE_TIMEOUT_MS=${YUQUE_TIMEOUT_MS}" -e "YUQUE_MAX_RETRIES=${YUQUE_MAX_RETRIES}" -e "YUQUE_ALLOW_WRITE=${YUQUE_ALLOW_WRITE}" -e "YUQUE_WRITE_NAMESPACE_ALLOWLIST=${YUQUE_WRITE_NAMESPACE_ALLOWLIST}" -e "YUQUE_WRITE_GROUP_ALLOWLIST=${YUQUE_WRITE_GROUP_ALLOWLIST}" -e "YUQUE_ALLOW_DELETE=${YUQUE_ALLOW_DELETE}" -e "YUQUE_DELETE_NAMESPACE_ALLOWLIST=${YUQUE_DELETE_NAMESPACE_ALLOWLIST}" -e "YUQUE_FILE_ROOT=${YUQUE_FILE_ROOT}" -e "YUQUE_FILE_MAX_BYTES=${YUQUE_FILE_MAX_BYTES}" -e "YUQUE_FILE_ALLOWED_EXTENSIONS=${YUQUE_FILE_ALLOWED_EXTENSIONS}" -- npx -y @wwwwwujl/[email protected]
{
"mcpServers": {
"yuque": {
"command": "npx",
"args": [
"-y",
"@wwwwwujl/[email protected]"
],
"env": {
"YUQUE_TOKEN": "${YUQUE_TOKEN}",
"YUQUE_ENDPOINT": "${YUQUE_ENDPOINT}",
"YUQUE_TIMEOUT_MS": "${YUQUE_TIMEOUT_MS}",
"YUQUE_MAX_RETRIES": "${YUQUE_MAX_RETRIES}",
"YUQUE_ALLOW_WRITE": "${YUQUE_ALLOW_WRITE}",
"YUQUE_WRITE_NAMESPACE_ALLOWLIST": "${YUQUE_WRITE_NAMESPACE_ALLOWLIST}",
"YUQUE_WRITE_GROUP_ALLOWLIST": "${YUQUE_WRITE_GROUP_ALLOWLIST}",
"YUQUE_ALLOW_DELETE": "${YUQUE_ALLOW_DELETE}",
"YUQUE_DELETE_NAMESPACE_ALLOWLIST": "${YUQUE_DELETE_NAMESPACE_ALLOWLIST}",
"YUQUE_FILE_ROOT": "${YUQUE_FILE_ROOT}",
"YUQUE_FILE_MAX_BYTES": "${YUQUE_FILE_MAX_BYTES}",
"YUQUE_FILE_ALLOWED_EXTENSIONS": "${YUQUE_FILE_ALLOWED_EXTENSIONS}"
}
}
}
}
{
"servers": {
"yuque": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@wwwwwujl/[email protected]"
],
"env": {
"YUQUE_TOKEN": "${YUQUE_TOKEN}",
"YUQUE_ENDPOINT": "${YUQUE_ENDPOINT}",
"YUQUE_TIMEOUT_MS": "${YUQUE_TIMEOUT_MS}",
"YUQUE_MAX_RETRIES": "${YUQUE_MAX_RETRIES}",
"YUQUE_ALLOW_WRITE": "${YUQUE_ALLOW_WRITE}",
"YUQUE_WRITE_NAMESPACE_ALLOWLIST": "${YUQUE_WRITE_NAMESPACE_ALLOWLIST}",
"YUQUE_WRITE_GROUP_ALLOWLIST": "${YUQUE_WRITE_GROUP_ALLOWLIST}",
"YUQUE_ALLOW_DELETE": "${YUQUE_ALLOW_DELETE}",
"YUQUE_DELETE_NAMESPACE_ALLOWLIST": "${YUQUE_DELETE_NAMESPACE_ALLOWLIST}",
"YUQUE_FILE_ROOT": "${YUQUE_FILE_ROOT}",
"YUQUE_FILE_MAX_BYTES": "${YUQUE_FILE_MAX_BYTES}",
"YUQUE_FILE_ALLOWED_EXTENSIONS": "${YUQUE_FILE_ALLOWED_EXTENSIONS}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.wwwwujl/yuque-mcp
- not probed yet: tools unpinned, ingest lists them
tools
Not probed yetThe tools appear once the hub or its worker has listed this entry. Running it still works: your client lists them on first start.