Skip to main content
Glama

init_qa_knowledge

Initializes a qa-knowledge.md template with five structured sections (business rules, bugs, assertions, user journeys, constraints) and TODO prompts. Idempotent; does not overwrite unless overwrite=true.

Instructions

在受測專案根 (PROJECT_ROOT) 建立 qa-knowledge.md 起手範本,含業務規則 / 歷史 Bug / 標準斷言文字 / User Journeys / 技術約束 5 個 H2 區段,每段都有 TODO 提示。Idempotent:檔已存在不會覆蓋(除非 overwrite=true)。新用戶建議第一次跑 MCP 就先 call 一次。這份檔案後續會被 get_qa_context 讀、做為 business_context 傳進 generate_test,讓 AI 寫出有業務邏輯的測試(而不是泛例 monkey testing)。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
overwriteNo強制覆蓋既存檔案(會丟失你已填的內容、請先備份)
Behavior4/5

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

No annotations provided, so description carries full burden. It discloses idempotence, overwrite behavior with warning, and the file's future use. Could add more on potential side effects (e.g., file creation permissions), but current level covers key behaviors.

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?

Description is compact yet covers all essential aspects: purpose, content, behavior, usage recommendation, and future role. Could be slightly more structured (e.g., bullet points), but remains concise without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with one parameter and no output schema, the description is remarkably complete. It explains the file structure, idempotence, overwrite option, and explicitly links to downstream tools (get_qa_context, generate_test), giving full context for agent decision-making.

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 100% with a descriptive parameter comment. The tool description reinforces the parameter's effect ('Idempotent:檔已存在不會覆蓋(除非 overwrite=true)'), adding context beyond the schema. No other parameters exist.

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?

The description clearly states the tool creates a 'qa-knowledge.md' starter template with 5 specific H2 sections. It references sibling tools (get_qa_context, generate_test) to show how it fits into the workflow, distinguishing it from other tools on the server.

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?

Explicitly recommends new users call it first ('新用戶建議第一次跑 MCP 就先 call 一次'). Describes idempotent behavior and the overwrite parameter, guiding safe usage. Implicitly advises not to call with overwrite=true unless backup is made.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kao273183/mk-qa-master'

If you have feedback or need assistance with the MCP directory API, please join our Discord server