Skip to main content
Glama
chanshawoh

yudao-pilot-mcp

by chanshawoh

Validate Workspace Projects

validate_workspace_projects
Read-only

Validate backend and frontend projects in a workspace against the configured yudao/ruoyi-vue-pro structure, ensuring generated code lands in the correct project.

Instructions

校验工作区中的后端和前端项目是否与配置严格匹配。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspace_rootNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.0

TDQS

B3/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read operation, so the description carries a lighter burden. It adds the useful 'strict match' semantic, but leaves open the key behavioral question for a validator: whether a mismatch raises an error or is returned as a report, and whether validation is recursive over all projects.

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?

A single, front-loaded sentence with no filler — the verb and scope come first. It is efficient, though its brevity shades into under-specification rather than disciplined conciseness.

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

Completeness3/5

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

An output schema exists, so return structure need not be explained. What is missing is what exactly counts as a 'strict match,' what happens on failure, and how workspace_root defaults — gaps that matter for a validation tool an agent must decide to invoke.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single workspace_root parameter has 0% schema description coverage and is undocumented in the description beyond the vague phrase 'in the workspace.' The default of null and any path syntax or resolution behavior are never explained, so the description does not compensate for the schema gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb plus resource pair — validate backend and frontend projects in the workspace against the configuration — and adds the qualifier 'strictly matches.' That is enough for an agent to know what the tool does. It does not, however, distinguish itself from close siblings such as load_workspace_config or inspect_project_path.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no stated prerequisites, and no mention of alternatives among the many sibling config/inspect tools. An agent can only infer that this is a preflight check, not when it should be preferred over loading the config directly.

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