Skip to main content
Glama

scaffold_project

Create a new project skeleton with README, .gitignore, and entry file, returning the list of generated files. Specify project name, language, and description to initialize a ready-to-use directory structure.

Instructions

创建一个新项目的目录骨架(README/.gitignore/入口文件),返回创建的文件清单。

  • name: 项目名(单级目录名,防路径穿越)

  • language: python / node / plain

  • description: 项目简介,写入 README

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
languageNopython
descriptionNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Install Server

TDQS

A3.5/5.0
Behavior2/5

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

未提供注释,描述承担了披露行为的全部责任。描述说明该工具会创建文件并返回清单,但未透露副作用(如是否覆盖现有文件)、先决条件(如目标目录、权限需求)或失败模式。它提到了“防路径穿越”,但那是针对参数的,而非整体行为。对于一个修改文件系统的工具,缺乏这些信息是明显的缺陷。

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

描述高度简洁,开头的总结句后跟参数列表,每句话都有信息量且无冗余。它将核心功能置于首位,参数语义随后,结构清晰且便于快速阅读。

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?

该描述对工具而言基本可用:它说明了作用、返回内容,并定义了参数。然而,它缺少使用指南、行为细节和先决条件(如项目创建位置、是否影响当前工作目录),以及输出模式的详情(虽然描述提及返回文件清单,但未说明格式)。鉴于无注释和输出模式存在,描述本可以做得更完整。

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?

输入模式的描述覆盖率为0%,但描述通过列出参数及含义予以补偿:name(单级目录名,防路径穿越)、language(python/node/plain)、description(写入README)。这些信息超出了模式中仅有类型和默认值的范围,为Agent提供了必要的上下文。描述覆盖了所有三个参数,有效弥补了模式描述缺失的问题。

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?

描述明确指出该工具用于创建新项目的目录骨架,包含README、.gitignore和入口文件,并返回文件清单。它指定了动词“创建”和资源“项目目录骨架”,清晰地将自身与兄弟工具(如paper_search、pdf_extract等)区分开来,那些工具主要用于搜索或提取操作。

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?

描述未提供任何使用指南,没有说明何时使用此工具与兄弟工具相比,也未提及替代方案或排除条件。对于scaffold_project这一用于初始化项目的工具,缺乏上下文,比如是否仅适用于新项目而非已有项目,或其他工具的适用条件,Agent只能凭推断使用。

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

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/xyser-craner/personal-student-MCP'

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