Commit 760d118f authored by MD. SHAHIDUL ISLAM's avatar MD. SHAHIDUL ISLAM

docs: Update tool docstrings with markdown link formatting instructions and add…

docs: Update tool docstrings with markdown link formatting instructions and add new example commands to the README.
parent 9cbb7326
......@@ -105,6 +105,11 @@ Here are examples of what you can ask:
>
> *"Set my active project to PQCI."*
> *"Show me the details for issues PCM-131, PCM-132, and PCM-133."*
> *"List only those issues which status is qa assign today"*
### ➕ Creating Tasks
You can specify absolutely any Issue Type that is valid on your Jira server when creating an issue. E.g.:
`Bug`, `New Feature`, `Task`, `Improvement`, `Epic`, `Story`, `UAT-Feedback`, `Enhancement`, `Test Result`, `Use Case`, `After UAT - Feedback`.
......
......@@ -70,7 +70,9 @@ def get_active_project() -> str:
@mcp.tool()
def get_my_assigned_issues() -> str:
"""Fetches all open Jira issues assigned to the current user."""
"""Fetches all open Jira issues assigned to the current user.
IMPORTANT: When responding to the user, you MUST format issue keys as clickable markdown links using the URLs provided in this tool's output.
"""
jira = _get_jira()
# JQL to find user's unresolved issues
jql = 'assignee = currentUser() AND resolution = Unresolved ORDER BY priority DESC, created DESC'
......@@ -88,7 +90,9 @@ def get_my_assigned_issues() -> str:
@mcp.tool()
def get_issue_details(issue_key: str) -> str:
"""Retrieves full details for a specific issue ID (e.g. PCM-131)."""
"""Retrieves full details for a specific issue ID (e.g. PCM-131).
IMPORTANT: When responding to the user, you MUST format the issue key as a clickable markdown link using the URL provided in this tool's output.
"""
jira = _get_jira()
try:
issue = jira.issue(issue_key)
......@@ -114,7 +118,9 @@ def get_issue_details(issue_key: str) -> str:
@mcp.tool()
def get_multiple_issues_details(issue_keys: List[str]) -> str:
"""Retrieves details for multiple specific issue IDs (e.g. ['PCM-131', 'PCM-132']) at once."""
"""Retrieves details for multiple specific issue IDs (e.g. ['PCM-131', 'PCM-132']) at once.
IMPORTANT: When responding to the user, you MUST format issue keys as clickable markdown links using the URLs provided in this tool's output.
"""
jira = _get_jira()
try:
if not issue_keys:
......@@ -367,6 +373,7 @@ def transition_issue(issue_key: str, transition_name: str) -> str:
def search_issues(jql_query: str) -> str:
"""Searches Jira for issues using a JQL (Jira Query Language) string.
Example: 'project = PCM AND text ~ "Dashboard" ORDER BY created DESC'
IMPORTANT: When responding to the user, you MUST format issue keys as clickable markdown links using the URLs provided in this tool's output.
"""
jira = _get_jira()
try:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment