Skip to main content
Glama

generate_project_guidelines

Create structured project guidelines by analyzing and synthesizing official documentation, style guides, and best practices for specified technologies and versions. Input a tech stack to generate actionable rules and recommendations.

Instructions

Generates a structured project guidelines document (e.g., Markdown) based on a specified list of technologies and versions (tech stack). Uses web search to find the latest official documentation, style guides, and best practices for each component and synthesizes them into actionable rules and recommendations. Uses the configured Vertex AI model (gemini-2.5-pro-exp-03-25) with Google Search. Requires 'tech_stack'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tech_stackYesAn array of strings specifying the project's technologies and versions (e.g., ['React 18.3', 'TypeScript 5.2', 'Node.js 20.10', 'Express 5.0', 'PostgreSQL 16.1']).
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses key behaviors: uses web search for latest official docs, style guides, best practices; uses Vertex AI model (gemini-2.5-pro-exp-03-25) with Google Search; generates actionable rules and recommendations. However, it lacks details on rate limits, authentication needs, output format specifics (e.g., Markdown structure), or potential errors. For a tool with no annotations, this is a moderate level of transparency.

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?

The description is appropriately sized and front-loaded: the first sentence states the core purpose, followed by details on method and requirements. Every sentence adds value (e.g., explaining the use of web search and AI model). It could be slightly more concise by combining some clauses, but it avoids redundancy and waste.

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?

Given no annotations, no output schema, and a single parameter with full schema coverage, the description is moderately complete. It covers the purpose, method, and input requirement adequately. However, for a tool that performs web search and AI synthesis, it lacks details on output format, error handling, or performance considerations, which could be important for an agent to use it correctly.

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 100%, with the parameter 'tech_stack' well-described in the schema as an array of strings for technologies and versions. The description adds minimal semantics beyond the schema, only reiterating that it's required and specifying the input as 'a specified list of technologies and versions.' This meets the baseline of 3 since the schema does the heavy lifting.

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's purpose: 'Generates a structured project guidelines document based on a specified list of technologies and versions.' It specifies the output format (Markdown), the input (tech stack), and the method (web search for official docs, style guides, best practices, synthesis via Vertex AI). This distinguishes it from all sibling tools, which are mostly about querying, file operations, or saving outputs, not generating guidelines from tech stacks.

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

Usage Guidelines4/5

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

The description implies usage context: when you need project guidelines for a given tech stack, using web search and AI synthesis. It explicitly states 'Requires tech_stack' as a prerequisite. However, it does not specify when not to use it (e.g., vs. manual research or other tools) or name alternatives among siblings, though the sibling list includes no direct alternatives for guideline generation.

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

Related 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/shariqriazz/vertex-ai-mcp-server'

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