init_project_rules
Generates or updates project specification files to define and manage project rules, ensuring clarity and consistency in project setup and modifications.
Instructions
Initialize project rules. Call this tool when the user requests to generate or initialize the project specification file, or if the user requests to change or update the project specification.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/projectTools.ts:12-44 (handler)The main asynchronous handler function for the 'init_project_rules' tool. It retrieves a prompt, ensures the rules file exists, appends the file path to the prompt, and returns it as tool content. Includes error handling.
export async function initProjectRules() { try { // Get prompts from generator const promptContent = getInitProjectRulesPrompt(); // Ensure rules.md file exists in the DATA_DIR directory await ensureRulesFileExists(); // Output the path to the rules file to help users find it const rulesPath = getRulesFilePath(); // Return success response return { content: [ { type: "text" as const, text: promptContent + `\n\nRules file will be located at: ${rulesPath}`, }, ], }; } catch (error) { // Error handling const errorMessage = error instanceof Error ? error.message : "Unknown error"; return { content: [ { type: "text" as const, text: `Error initializing project rules: ${errorMessage}`, }, ], }; } } - src/tools/projectTools.ts:6-6 (schema)Zod input schema for the 'init_project_rules' tool, defined as an empty object since the tool takes no parameters.
export const initProjectRulesSchema = z.object({}); - src/index.ts:325-331 (registration)Tool registration entry in the ListToolsRequest handler. Specifies the tool name, loads description from a Markdown template, and references the input schema.
{ name: "init_project_rules", description: loadPromptFromTemplate( "toolsDescription/initProjectRules.md" ), inputSchema: zodToJsonSchema(initProjectRulesSchema), }, - src/index.ts:564-566 (registration)Dispatch case in the CallToolRequest handler's switch statement. Directly invokes the initProjectRules handler function without input validation (consistent with empty schema).
case "init_project_rules": result = await initProjectRules(); return result; - src/index.ts:55-58 (registration)Import statement bringing in the initProjectRules handler function and its schema from projectTools.ts for use in the MCP server.
import { initProjectRules, initProjectRulesSchema, } from "./tools/projectTools.js";