Skip to main content
Glama
chanshawoh

yudao-pilot-mcp

by chanshawoh

Inspect Project Path

inspect_project_path
Read-only

Identifies backend or frontend project type from pom.xml/package.json dependency fingerprints, not directory names, so AI-generated code lands in the correct yudao/ruoyi-vue-pro structure.

Instructions

根据 pom.xml 或 package.json 的依赖指纹分析项目类型,不依赖目录名。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes that this is a non-mutating inspection, so the safety profile is covered. The description does add real behavioral context beyond the annotation: detection is fingerprint-based on pom.xml/package.json rather than directory naming. It still says nothing about failure modes (e.g., unknown project type) or how confident/partial results are presented.

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 dense sentence with no filler; the analytical method leads and the non-reliance-on-name caveat follows. Nothing is redundant, though it is terse to the point of leaving the parameter format unstated.

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 values need not be explained, and the read-only annotation covers safety. What remains missing is the expected form of project_path and any note about behavior on unrecognized projects, which for a one-parameter inspection tool is a modest but real gap.

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

Parameters3/5

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

Schema description coverage is 0% for the single required parameter project_path, so the description carries the burden. It implicitly frames the input as a project location rather than a name ('does not rely on the directory name'), but it never specifies whether the value is a directory path, a file path, or whether it must be absolute.

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 concrete verb (分析/analyze) and a concrete target (项目类型/project type), plus the mechanism used (dependency fingerprints in pom.xml or package.json). That is enough to distinguish it from siblings like validate_workspace_projects or inspect_table_schema, though it never names which sibling it complements or replaces.

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 statement of when to call this tool versus alternatives such as validate_workspace_projects or load_workspace_config. The only guidance-like content is the methodological note that analysis does not depend on directory names, which is a caveat rather than a when-to-use rule.

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