yuque-mcp-server: Instructions file for Codex

AGENTS.md

yuque-mcp-server AGENTS.md is an instructions file for Codex, OpenCode from yuque/yuque-mcp-server. It costs 714 tokens per session, scanned A, original, MIT.

A repository guide for yuque-mcp, a Node.js and TypeScript server that exposes the Yuque service through MCP, a standard way for AI clients to discover and call tools.

In plain words
What is it for?
Use it when changing Yuque tools, authentication, transport, documentation, project structure, or release configuration.
Why use it?
It identifies the authoritative documentation, required checks, and updates needed when the server's tools, API wrapper, or architecture changes.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md.

This is yuque/yuque-mcp-server's own configuration. It tells Codex and OpenCode how to work on yuque-mcp-server itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything yuque-mcp-server configures →

Reuse

Borrowing it

Nothing to install: this file belongs to yuque/yuque-mcp-server. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/yuque/yuque-mcp-server/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/yuque/yuque-mcp-server

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for yuque-mcp-server AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/yuque/yuque-mcp-server/agents-md/github.svg)](https://agentmods.dev/instructions/yuque/yuque-mcp-server/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/yuque/yuque-mcp-server/agents-md"><img src="https://agentmods.dev/badge/instructions/yuque/yuque-mcp-server/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for yuque-mcp-server AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/yuque/yuque-mcp-server/agents-md"><img src="https://agentmods.dev/badge/instructions/yuque/yuque-mcp-server/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 714 This file is loaded in full into every session.
When invoked 714 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00714 $0.00714
Opus 5.5 $0.00286 $0.00286
Sonnet 5.5 $0.00143 $0.00143
Haiku 4.5 $0.00071 $0.00071

Measured 2mo ago against content hash 7e87efed4cfb, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

yuque-mcp-server AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 52 lines

What it actually says

AGENTS.md

本文件提供当前仓库的协作约定。更通用的个人偏好仍遵循上层或全局 AGENTS.md。

项目定位

这是 yuque-mcp,一个把语雀 API 暴露为 MCP tools 的 Node.js / TypeScript 项目。MCP client 通过 tools/list 发现能力,通过 tools/call 调用语雀相关操作。

项目文档入口

维护或理解项目边界时,优先阅读 docs/ 下的文档:

维护要求

  • 改 MCP tool surface 时,同步更新 docs/capability-scope.md 和 tests/mcp/tool-registry-contract.test.ts。
  • 改 CLI、transport、认证、host/base URL 解析或发布配置时,同步更新 docs/technical-stack.md。
  • 改 server 分层、tool 注册、service API wrapper 或文档读写路径时,同步更新 docs/core-architecture.md。
  • 当前代码和 contract tests 是 authoritative source(权威来源);文档要跟随真实实现更新。

环境自举

  • Fresh clone 后先执行 npm ci,再跑任何命令。
  • 任何命令报 command not found,先跑 npm ci 再重试。
  • Node 版本以 .nvmrc 为准(CI 会覆盖 18/20/22/24)。

常用命令

npm run check       # 质量门:lint + format:check + typecheck + test + build
npm run lint        # 单跑 ESLint(src 和 tests)
npm run typecheck   # 单跑 tsc --noEmit
npm test            # 单跑全量测试,单次运行(watch 用 npm run test:watch)
  • 完成的定义:npm run check 退出码为 0。提交前必须跑通,CI 跑的是同一条命令。
  • 迭代期间跑单个测试文件更快:npx vitest run tests/tools/doc.test.ts。
  • CI 额外跑两个 dist smoke tests(smoke:dist、smoke:pack-install)。
  • Real API smoke tests 默认跳过,开启所需的环境变量见 docs/technical-stack.md。

标准工作流

执行常见变更前,先读 docs/workflows/ 下对应的步骤文档:

  • 新增 MCP tool: docs/workflows/add-tool.md(可先跑 npm run new:tool -- <domain> <yuque_tool_name> 生成骨架)
  • 修改现有 tool 参数或行为: docs/workflows/modify-tool.md
  • 修复 bug: docs/workflows/fix-bug.md
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 52 lines · 714 tokens per session scan A 7e87efed4cfb

Subscribe to this mod's changes

yuque-mcp-server AGENTS.md is an instructions file published in the GitHub repository yuque/yuque-mcp-server (263 stars, last pushed 3mo ago), licensed MIT. It adds 714 tokens to every session, about $0.0029 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

yuque-mcp-server AGENTS.md compared with instructions from other repositories

yuque-mcp-server AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
yuque-mcp-server AGENTS.mdyuque/yuque-mcp-serverInstructions file2633mo agoMITA714Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode