DefProd 1
DefProd Documentation
Welcome to the DefProd documentation. This site provides comprehensive guides and references for the various methods of accessing your DefProd information and functionality. These access methods are designed to support different use cases and workflows, enabling you to integrate DefProd into your development process and provide powerful context and structure as you build your software products and applications.
Whether you're building web applications, integrating with AI agents, automating workflows, or creating custom tooling, DefProd offers access methods to suit the widest possible set of use cases.
Quick Links
Access Methods
API Reference
The DefProd REST API provides programmatic access to all DefProd functionality through a standardized RPC-style interface. This is the primary method for integrating DefProd into your applications and services.
Use Cases:
- Building web applications that interact with DefProd data
- Creating custom dashboards and reporting tools
- Integrating DefProd into existing development workflows
- Automating product definition management tasks
- Building third-party integrations and plugins
- Creating CI/CD pipelines that leverage product definitions
How it helps build your software product:
The API enables you to programmatically access and manipulate your product definitions, user stories, architecture elements, and other DefProd data. This allows you to:
- Build custom interfaces and tools tailored to your team's specific needs
- Automate repetitive tasks and workflows
- Integrate DefProd data into your existing toolchain
- Create custom reporting and analytics dashboards
- Build applications that leverage your product definitions as a data source
- Enable real-time synchronization between DefProd and other systems
The API uses a simple RPC-style endpoint with JSON request/response formats, making it easy to integrate with any programming language or framework. OpenAPI documentation and Postman collections are available to help you get started quickly.
MCP Server Reference
The DefProd MCP (Model Context Protocol) server provides AI agents with direct access to DefProd functionality and data. This enables AI assistants to understand and interact with your product definitions, helping you build better software through intelligent assistance.
Use Cases:
- Enabling AI coding assistants (like Cursor, Claude Desktop, or custom agents) to understand your product architecture
- Getting AI-powered insights and suggestions based on your product definitions
- Using AI to help generate code, documentation, or tests aligned with your product structure
- Creating AI-powered development workflows that leverage your product knowledge
- Building custom AI agents that understand your specific product domain
- Enabling AI assistants to answer questions about your product architecture and requirements
How it helps build your software product:
By connecting AI agents to your DefProd data, you enable them to:
- Understand your product's architecture, user stories, and requirements
- Generate code and documentation that aligns with your product structure
- Provide context-aware suggestions based on your actual product definitions
- Help maintain consistency between your product definition and implementation
- Assist with refactoring and architecture decisions informed by your product model
- Answer questions about your product using real data from DefProd
The MCP server supports both SSE (Server-Sent Events) and HTTP streaming transports, making it compatible with a wide range of MCP clients. When AI agents can understand your product definition, they become significantly more effective at helping you build software that matches your vision.
CLI Reference
The DefProd CLI (Command Line Interface) provides terminal-based access to DefProd functionality, enabling automation, scripting, and integration into command-line workflows.
Use Cases:
- Automating product definition tasks through shell scripts
- Integrating DefProd operations into CI/CD pipelines
- Creating custom automation workflows
- Batch operations on product data
- Command-line tooling for developers who prefer terminal interfaces
- Integration with other command-line tools and scripts
How it helps build your software product:
The CLI enables you to:
- Automate repetitive product definition tasks
- Integrate DefProd operations into your build and deployment pipelines
- Create scripts that manage product definitions programmatically
- Perform bulk operations on product data efficiently
- Build custom tooling that combines DefProd with other command-line utilities
- Enable version control workflows for product definitions
- Create automated reports and exports from the command line
The CLI is perfect for developers who work primarily in the terminal and need to integrate DefProd into their existing command-line workflows and automation scripts.