Merge pull request #15 from geekbot-com/feature/post-report

Add post_report tool

Author: sabpap

README.md

@@ -146,6 +146,21 @@ Once configured, your LLM client application will have access to the following t
 - `created_at`: Timestamp when the report was submitted.
 - `content`: The actual answers/content of the report.
 
+- `post_report`
+
+**Purpose:** Posts a report to Geekbot.
+
+**Example Prompt:** "Hey, can you post the report for the Daily Standup standup?"
+
+**Data Fields Returned:**
+
+- `id`: Unique report identifier.
+- `reporter_name`: Name of the user who submitted the report.
+- `reporter_id`: ID of the user who submitted the report.
+- `standup_id`: ID of the standup the report belongs to.
+- `created_at`: Timestamp when the report was submitted.
+- `content`: The actual answers/content of the report.
+
 - `list_members`
 
 **Purpose:** Lists all team members you share standups with in your Geekbot workspace.

geekbot_mcp/gb_api.py

@@ -57,6 +57,21 @@ async def get_reports(
         response.raise_for_status()
         return response.json()
 
+    async def post_report(
+        self,
+        standup_id: int,
+        answers: dict[int, dict[str, str]],
+    ) -> dict:
+        """Post a report"""
+        endpoint = f"{self.base_url}/reports/"
+        response = await self._client.post(
+            endpoint,
+            headers=self.headers,
+            json={"standup_id": standup_id, "answers": answers},
+        )
+        response.raise_for_status()
+        return response.json()
+
     async def get_poll_results(
         self, poll_id: int, after: str | None = None, before: str | None = None
     ) -> dict:

geekbot_mcp/models.py

@@ -188,6 +188,18 @@ def report_from_json_response(r_res: dict) -> Report:
     )
 
 
+def posted_report_from_json_response(r_res: dict) -> Report:
+    return Report(
+        id=r_res["id"],
+        standup_id=r_res["standup_id"],
+        created_at=datetime.fromtimestamp(r_res["done_at"]).strftime(
+            "%Y-%m-%d %H:%M:%S"
+        ),
+        reporter=reporter_from_json_response(r_res["member"]),
+        content=content_from_json_response(r_res["answers"]),
+    )
+
+
 def poll_choice_result_from_json_response(c_res: dict) -> PollChoiceResult:
     return PollChoiceResult(
         text=c_res["text"],

geekbot_mcp/tools/__init__.py

@@ -9,13 +9,15 @@
 from geekbot_mcp.tools.list_members import handle_list_members, list_members
 from geekbot_mcp.tools.list_polls import handle_list_polls, list_polls
 from geekbot_mcp.tools.list_standups import handle_list_standups, list_standups
+from geekbot_mcp.tools.post_report import handle_post_report, post_report
 
 
 def list_tools() -> list[types.Tool]:
     return [
         list_members,
         list_standups,
         fetch_reports,
+        post_report,
         list_polls,
         fetch_poll_results,
     ]
@@ -33,6 +35,8 @@ async def run_tool(
             return await handle_list_standups(gb_client)
         case "fetch_reports":
             return await handle_fetch_reports(gb_client, **arguments)
+        case "post_report":
+            return await handle_post_report(gb_client, **arguments)
         case "list_polls":
             return await handle_list_polls(gb_client)
         case "fetch_poll_results":

geekbot_mcp/tools/post_report.py

@@ -0,0 +1,70 @@
+import html
+
+from mcp import types
+
+from geekbot_mcp.gb_api import GeekbotClient
+from geekbot_mcp.models import posted_report_from_json_response
+
+post_report = types.Tool(
+    name="post_report",
+    description="Posts a report to Geekbot. Use this tool to post a report to Geekbot using the context of the conversation. This tool is usually used after the `list_standups` tool to get the standup id and the question ids. If the context of the conversation lacks sufficient information to answer the questions of the standup, the assistant will ask for the missing information. The report should be beautifully formatted. ALWAYS type formatted reporte in the conversation for preview purposes before calling this tool.",
+    inputSchema={
+        "type": "object",
+        "properties": {
+            "standup_id": {
+                "type": "integer",
+                "description": "ID of the specific standup to post the report to.",
+            },
+            "answers": {
+                "type": "object",
+                "description": "An object where keys are the string representation of question IDs and values are objects containing the answer text. All questions of the standup must be included in the object.",
+                "additionalProperties": {
+                    "type": "object",
+                    "properties": {
+                        "text": {"type": "string"},
+                    },
+                    "required": ["text"],
+                },
+            },
+        },
+        "required": ["standup_id", "answers"],
+    },
+)
+
+
+def parse_answer_text(answer_text: any) -> str:
+    """Parse the answer text to ensure it's a string and escape HTML characters."""
+    if not isinstance(answer_text, str):
+        answer_text = str(answer_text)
+    return html.unescape(answer_text)
+
+
+async def handle_post_report(
+    gb_client: GeekbotClient,
+    standup_id: int,
+    answers: dict[int, dict[str, str]],
+) -> list[types.TextContent]:
+    """Post a report to Geekbot
+
+    Args:
+        standup_id: int,
+        answers: dict[int, dict[str, str]],
+    Returns:
+        str: Properly formatted JSON string of reports list
+    """
+    processed_answers_for_api = {}
+    for question_id, answer_obj in answers.items():
+        processed_answers_for_api[question_id] = {
+            "text": parse_answer_text(answer_obj["text"])
+        }
+    report = await gb_client.post_report(
+        standup_id=standup_id,
+        answers=processed_answers_for_api,
+    )
+    parsed_report = posted_report_from_json_response(report)
+    return [
+        types.TextContent(
+            type="text",
+            text=f"Report posted successfully: {parsed_report.model_dump()}",
+        )
+    ]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "geekbot-mcp"
-version = "0.2.1"
+version = "0.3.0"
 description = "Model Context Protocol (MCP) server integrating Geekbot data and tools to Claude AI"
 readme = "README.md"
 requires-python = ">=3.10"

tests/test_models.py

@@ -7,8 +7,10 @@
     PollQuestionResult,
     PollQuestionResults,
     PollResults,
+    Report,
     User,
     poll_results_from_json_response,
+    posted_report_from_json_response,
 )
 
 SAMPLE_POLL_RESULT_JSON = """
@@ -206,7 +208,7 @@
                 "email": "[email protected]",
                 "username": "jd",
                 "realname": "John Doe",
-                "profile_img": "https://avatars.slack-edge.com/2018-07-17/401189377223_47ad4aede92c871ad992_48.jpg",
+                "profile_img": "https://avatars.slack-edge.com/jd-avatar.png",
             },
         ],
         "recurrence": {
@@ -335,6 +337,60 @@
 ]
 """
 
+POSTED_REPORT_JSON = """
+{
+    "id": 27391,
+    "slack_ts": null,
+    "standup_id": 193911,
+    "timestamp": 1746521708,
+    "started_at": 1746521708,
+    "done_at": 1746521709,
+    "broadcasted_at": null,
+    "channel": "--testing",
+    "member": {
+        "id": "UBTDMUC34W",
+        "role": "member",
+        "username": "jd",
+        "realname": "John Doe",
+        "profileImg": "https://avatars.slack-edge.com/jd-avatar.png"
+    },
+    "answers": [
+        {
+            "id": 179012748,
+            "answer": "test",
+            "question": "How do you feel today?",
+            "question_id": 3143977,
+            "color": "EEEEEE",
+            "images": []
+        },
+        {
+            "id": 179011249,
+            "answer": "test",
+            "question": "What have you done since {last_report_date}?",
+            "question_id": 6143980,
+            "color": "CEF1F3",
+            "images": []
+        },
+        {
+            "id": 179018750,
+            "answer": "test",
+            "question": "What will you do today?",
+            "question_id": 6143928,
+            "color": "D299EB",
+            "images": []
+        },
+        {
+            "id": 179018751,
+            "answer": "test",
+            "question": "Anything blocking your progress?",
+            "question_id": 6143979,
+            "color": "FBDADD",
+            "images": []
+        }
+    ]
+}
+"""
+
 
 @pytest.fixture
 def sample_poll_result_data() -> dict:
@@ -354,6 +410,12 @@ def polls_list() -> list[dict]:
     return POLLS_LIST
 
 
+@pytest.fixture
+def posted_report_data() -> dict:
+    """Provides the posted report JSON data as a dictionary."""
+    return json.loads(POSTED_REPORT_JSON)
+
+
 def test_poll_results_parsing(sample_poll_result_data: dict):
     """Tests parsing of sample poll results JSON into a PollResults object."""
     parsed_result = poll_results_from_json_response(sample_poll_result_data)
@@ -422,3 +484,15 @@ def test_poll_results_parsing_multiple_instances(
     assert choice1.votes == 0
     assert choice1.percentage == 0.0
     assert len(choice1.users) == 0
+
+
+def test_posted_report_parsing(posted_report_data: dict):
+    """Tests parsing of posted report JSON into a PostedReport object."""
+    parsed_result = posted_report_from_json_response(posted_report_data)
+
+    assert isinstance(parsed_result, Report)
+    assert parsed_result.id == 27391
+    assert parsed_result.standup_id == 193911
+    assert parsed_result.reporter.id == "UBTDMUC34W"
+    assert parsed_result.reporter.name == "John Doe"
+    assert parsed_result.reporter.username == "jd"

tests/test_tools.py

@@ -0,0 +1,33 @@
+from geekbot_mcp.tools.post_report import parse_answer_text
+
+
+def test_parse_answer_text():
+    assert (
+        parse_answer_text("This is a test. It's great!")
+        == "This is a test. It's great!"
+    )
+
+    assert parse_answer_text(123) == "123"
+
+    assert (
+        parse_answer_text("<div>Hello & World</div>")
+        == "<div>Hello &amp; World</div>"
+    )
+
+    assert (
+        parse_answer_text(
+            "&lt;p&gt;Less than &amp;lt; and greater than &amp;gt;&lt;/p&gt;"
+        )
+        == "<p>Less than &lt; and greater than &gt;</p>"
+    )
+    assert (
+        parse_answer_text("'Single quote &amp;apos; and double quote &amp;quot;'")
+        == "'Single quote &apos; and double quote &quot;'"
+    )
+
+    assert (
+        parse_answer_text(
+            "The main challenge we&#039;re facing involves Slack API limitations, which are creating some constraints on what we can implement. However, I&#039;m confident we can find creative workarounds for these issues. Nothing we can&#039;t overcome with a bit of innovative thinking!"
+        )
+        == "The main challenge we're facing involves Slack API limitations, which are creating some constraints on what we can implement. However, I'm confident we can find creative workarounds for these issues. Nothing we can't overcome with a bit of innovative thinking!"
+    )