Skip to Content
The Makinari API repo now includes an MCP Server — connect your AI models directly. View on GitHub →
MCP ServerToolsRequirement StatusPOST

Requirement Status Tool

The requirement_status tool allows you to log progress and update statuses on a client requirement, as well as list the status history for a specific requirement. Use this tool whenever there’s an update, failure, or completion of a task requested by the client. It stores an entry into the requirement_status database and optionally updates the parent requirement.

Parameters

ParameterTypeRequiredDescription
actionstringNoThe action to perform (create or list). Defaults to create.
requirement_idstringYesThe ID of the requirement being processed or queried.
instance_idstringNoThe ID of the instance processing the requirement.
asset_idstringYes*The related asset ID (Required when action is create).
statusstringYes*The new status (e.g. in-progress, completed, failed) (Required when action is create).
repo_urlstringNoThe GitHub or repository URL associated with this requirement progress.
preview_urlstringNoThe live preview or staging URL associated with this requirement progress.
source_codestringNoURL to a zip file containing the source code related to the requirement objective or preview.
messagestringNoAny details, descriptions, or error logs about the status.
cyclestringNoSpecify the source of the work cycle. Set this to ensure an entire development cycle is performed for the requirement (can be null or a new numeric or text value).

Usage Examples

Creating a Status Update

{ "name": "requirement_status", "arguments": { "action": "create", "instance_id": "inst_01ABCDEF", "asset_id": "asset_01GHIJKL", "requirement_id": "req_12345", "status": "completed", "repo_url": "https://github.com/uncodie/my-project", "preview_url": "https://my-project-staging.vercel.app", "source_code": "https://storage.googleapis.com/my-bucket/source-code-preview.zip", "message": "The login page layout has been successfully implemented and tested.", "cycle": "Sprint 4" } }

Listing Statuses of a Requirement

{ "name": "requirement_status", "arguments": { "action": "list", "requirement_id": "req_12345" } }
Last updated on