A tool for analyzing user stories using the INVEST criteria
Project description
User Story INVEST Analyzer
A tool for analyzing user stories using the INVEST criteria and providing improvement recommendations.
Installation
pip install refine-user-story-mcp
Setup
- Create a
.envfile with your Groq API credentials:
GROQ_API_KEY=your_groq_api_key_here
GROQ_MODEL=mixtral-8x7b-32768
- Import and use the tool in your Python code:
from refine_user_story_mcp import invest_analyze
# Sample user story
user_story = {
"UserStory": {
"Title": "User Registration",
"Description": "As a website visitor, I want to register an account so that I can access member features.",
"AcceptanceCriteria": [
"User can enter email and password",
"System validates email format",
"User receives confirmation email"
],
"AdditionalInformation": "Registration should be quick and intuitive."
}
}
# Analyze the user story
result = invest_analyze(user_story=user_story, format_output=True)
print(result["content"][0]["text"])
Features
- Analyzes user stories based on the INVEST criteria (Independent, Negotiable, Valuable, Estimable, Small, Testable)
- Scores each criterion on a scale of 1-5
- Provides detailed explanations and recommendations
- Suggests improvements to the original user story
- Returns results in either formatted text or raw JSON
Usage as MCP Tool
You can also use this as an MCP (Multi-Agent Conversational Protocol) tool:
from mcp.client import MCPClient
client = MCPClient()
client.register_tool("refine_user_story_mcp")
result = client.call_tool("invest_analyze", {"user_story": user_story})
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file refine_user_story_mcp-0.4.0.tar.gz.
File metadata
- Download URL: refine_user_story_mcp-0.4.0.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5cc89db43074905715e45d2d801717da05e09ffa47397a25e06e7bf43dd6b5e3
|
|
| MD5 |
37f9b7da4f168523b49b51cdfa807088
|
|
| BLAKE2b-256 |
c30436a65d78f69807f576a9e610f6e43a294eb0f5a36cb2310b7093b5220a54
|
File details
Details for the file refine_user_story_mcp-0.4.0-py3-none-any.whl.
File metadata
- Download URL: refine_user_story_mcp-0.4.0-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e410083b86cbb8c3959905417e7ae9c0e9dfdeb44c9b9a5c25e31f5c269c597f
|
|
| MD5 |
d5e4ac37e6eb7e34827a8d1d89a7b9df
|
|
| BLAKE2b-256 |
d43c6d1269f383467e9a282d0053e8ad0ccd47c0fec72f7b8701f26b410d7220
|