From 552f538d977d20ebd007bdd02362c354496dd37b Mon Sep 17 00:00:00 2001 From: Jason Walker <913443@dadeschools.net> Date: Sat, 4 Jul 2026 16:46:55 -0400 Subject: [PATCH 1/2] fix: redact Gitea web links from MCP PR output --- mcp_server.py | 43 ++++++++++------- tests/test_mcp_server.py | 99 +++++++++++++++++++++++++++++++++++++--- 2 files changed, 118 insertions(+), 24 deletions(-) diff --git a/mcp_server.py b/mcp_server.py index d23f4bf..e63c37a 100644 --- a/mcp_server.py +++ b/mcp_server.py @@ -54,6 +54,13 @@ def _reveal_endpoints() -> bool: return (os.environ.get("GITEA_MCP_REVEAL_ENDPOINTS") or "").strip().lower() \ in ("1", "true", "yes") + +def _with_optional_url(result: dict, url: str | None) -> dict: + """Attach web links only under the explicit endpoint reveal opt-in.""" + if _reveal_endpoints() and url: + result["url"] = url + return result + mcp = FastMCP("gitea-tools", instructions=( "Gitea issue tracker and PR management for dadeschools and prgs instances. " "Use the gitea_ prefixed tools to create issues, PRs, list issues, etc." @@ -310,7 +317,7 @@ def gitea_create_issue( repo: Override the repository name. Returns: - dict with 'number' and 'url' of the created issue. + dict with 'number' of the created issue ('url' only with the reveal opt-in). """ h, o, r = _resolve(remote, host, org, repo) auth = _auth(h) @@ -325,7 +332,7 @@ def gitea_create_issue( _audit("create_issue", host=h, remote=remote, org=o, repo=r, result=gitea_audit.SUCCEEDED, issue_number=data["number"], request_metadata={"title": title}) - return {"number": data["number"], "url": data["html_url"]} + return _with_optional_url({"number": data["number"]}, data.get("html_url")) @mcp.tool() @@ -352,7 +359,7 @@ def gitea_create_pr( repo: Override the repository name. Returns: - dict with 'number' and 'url' of the created PR. + dict with 'number' of the created PR ('url' only with the reveal opt-in). """ h, o, r = _resolve(remote, host, org, repo) auth = _auth(h) @@ -369,7 +376,7 @@ def gitea_create_pr( _audit("create_pr", host=h, remote=remote, org=o, repo=r, result=gitea_audit.SUCCEEDED, pr_number=data["number"], target_branch=head, request_metadata=meta) - return {"number": data["number"], "url": data["html_url"]} + return _with_optional_url({"number": data["number"]}, data.get("html_url")) @mcp.tool() @@ -390,24 +397,25 @@ def gitea_list_prs( repo: Override the repository name. Returns: - List of dicts with 'number', 'title', 'state', 'head', 'base', 'url', 'mergeable'. + List of dicts with 'number', 'title', 'state', 'head', 'base', and + 'mergeable' ('url' only with the reveal opt-in). """ h, o, r = _resolve(remote, host, org, repo) auth = _auth(h) url = f"{repo_api_url(h, o, r)}/pulls?state={state}" prs = api_get_all(url, auth) - return [ - { + results = [] + for pr in prs: + entry = { "number": pr["number"], "title": pr["title"], "state": pr["state"], "head": pr["head"]["ref"], "base": pr["base"]["ref"], - "url": pr["html_url"], "mergeable": pr.get("mergeable"), } - for pr in prs - ] + results.append(_with_optional_url(entry, pr.get("html_url"))) + return results @mcp.tool() @@ -434,17 +442,17 @@ def gitea_view_pr( auth = _auth(h) url = f"{repo_api_url(h, o, r)}/pulls/{pr_number}" pr = api_request("GET", url, auth) - return { + result = { "number": pr["number"], "title": pr["title"], "body": pr.get("body", ""), "state": pr["state"], "head": pr["head"]["ref"], "base": pr["base"]["ref"], - "url": pr["html_url"], "mergeable": pr.get("mergeable"), "user": pr.get("user", {}).get("login", ""), } + return _with_optional_url(result, pr.get("html_url")) # Actions whose eligibility this tool can evaluate. @@ -921,15 +929,15 @@ def gitea_edit_pr( except Exception: pass - return { + result = { "success": True, "number": data["number"], "title": data["title"], "body": data.get("body", ""), "state": data["state"], - "url": data["html_url"], "cleanup_status": cleanup_status, } + return _with_optional_url(result, data.get("html_url")) @mcp.tool() @@ -1424,21 +1432,22 @@ def gitea_view_issue( repo: Override the repository name. Returns: - dict with 'number', 'title', 'body', 'state', 'labels', 'assignee', 'url'. + dict with 'number', 'title', 'body', 'state', 'labels', and 'assignee' + ('url' only with the reveal opt-in). """ h, o, r = _resolve(remote, host, org, repo) auth = _auth(h) url = f"{repo_api_url(h, o, r)}/issues/{issue_number}" i = api_request("GET", url, auth) - return { + result = { "number": i["number"], "title": i["title"], "body": i.get("body", ""), "state": i["state"], "labels": [lb["name"] for lb in i.get("labels", [])], "assignee": (i.get("assignee") or {}).get("login", ""), - "url": i["html_url"], } + return _with_optional_url(result, i.get("html_url")) def _issue_comment_gate(op: str) -> list[str]: diff --git a/tests/test_mcp_server.py b/tests/test_mcp_server.py index 83817ce..f52b129 100644 --- a/tests/test_mcp_server.py +++ b/tests/test_mcp_server.py @@ -48,15 +48,24 @@ class TestCreateIssue(unittest.TestCase): @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) def test_creates_issue(self, _auth, mock_api): mock_api.return_value = {"number": 1, "html_url": "https://gitea.example.com/issues/1"} - result = gitea_create_issue(title="Test issue", body="body text") + with patch.dict(os.environ, {}, clear=True): + result = gitea_create_issue(title="Test issue", body="body text") self.assertEqual(result["number"], 1) - self.assertIn("issues/1", result["url"]) + self.assertNotIn("url", result) mock_api.assert_called_once() # Verify payload call_args = mock_api.call_args self.assertEqual(call_args[0][0], "POST") self.assertEqual(call_args[0][3]["title"], "Test issue") + @patch("mcp_server.api_request") + @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) + def test_create_issue_reveal_opt_in_includes_url(self, _auth, mock_api): + mock_api.return_value = {"number": 1, "html_url": "https://gitea.example.com/issues/1"} + with patch.dict(os.environ, {"GITEA_MCP_REVEAL_ENDPOINTS": "1"}, clear=True): + result = gitea_create_issue(title="Test issue", body="body text") + self.assertIn("issues/1", result["url"]) + @patch("mcp_server.api_request") @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) def test_creates_on_prgs(self, _auth, mock_api): @@ -77,12 +86,22 @@ class TestCreatePR(unittest.TestCase): @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) def test_creates_pr(self, _auth, mock_api): mock_api.return_value = {"number": 3, "html_url": "https://example.com/pulls/3"} - result = gitea_create_pr(title="feat: X", head="feat/x", base="main") + with patch.dict(os.environ, {}, clear=True): + result = gitea_create_pr(title="feat: X", head="feat/x", base="main") self.assertEqual(result["number"], 3) + self.assertNotIn("url", result) payload = mock_api.call_args[0][3] self.assertEqual(payload["head"], "feat/x") self.assertEqual(payload["base"], "main") + @patch("mcp_server.api_request") + @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) + def test_create_pr_reveal_opt_in_includes_url(self, _auth, mock_api): + mock_api.return_value = {"number": 3, "html_url": "https://example.com/pulls/3"} + with patch.dict(os.environ, {"GITEA_MCP_REVEAL_ENDPOINTS": "1"}, clear=True): + result = gitea_create_pr(title="feat: X", head="feat/x", base="main") + self.assertIn("pulls/3", result["url"]) + # --------------------------------------------------------------------------- # Close Issue @@ -158,11 +177,25 @@ class TestViewIssue(unittest.TestCase): "assignee": {"login": "jason"}, "html_url": "https://gitea.prgs.cc/issues/7", } - result = gitea_view_issue(issue_number=7, remote="prgs") + with patch.dict(os.environ, {}, clear=True): + result = gitea_view_issue(issue_number=7, remote="prgs") self.assertEqual(result["number"], 7) self.assertEqual(result["body"], "Build it") self.assertEqual(result["labels"], ["important"]) self.assertEqual(result["assignee"], "jason") + self.assertNotIn("url", result) + + @patch("mcp_server.api_request") + @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) + def test_view_issue_reveal_opt_in_includes_url(self, _auth, mock_api): + mock_api.return_value = { + "number": 7, "title": "MCP server", "body": "Build it", + "state": "open", "labels": [], "assignee": None, + "html_url": "https://gitea.prgs.cc/issues/7", + } + with patch.dict(os.environ, {"GITEA_MCP_REVEAL_ENDPOINTS": "1"}, clear=True): + result = gitea_view_issue(issue_number=7, remote="prgs") + self.assertIn("issues/7", result["url"]) # --------------------------------------------------------------------------- @@ -272,10 +305,26 @@ class TestListPRs(unittest.TestCase): "html_url": "http://url1", "mergeable": True } ] - result = gitea_list_prs() + with patch.dict(os.environ, {}, clear=True): + result = gitea_list_prs() self.assertEqual(len(result), 1) self.assertEqual(result[0]["number"], 1) self.assertEqual(result[0]["head"], "branch1") + self.assertNotIn("url", result[0]) + + @patch("mcp_server.api_get_all") + @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) + def test_list_prs_reveal_opt_in_includes_url(self, _auth, mock_api): + mock_api.return_value = [ + { + "number": 1, "title": "PR 1", "state": "open", + "head": {"ref": "branch1"}, "base": {"ref": "main"}, + "html_url": "http://url1", "mergeable": True + } + ] + with patch.dict(os.environ, {"GITEA_MCP_REVEAL_ENDPOINTS": "1"}, clear=True): + result = gitea_list_prs() + self.assertEqual(result[0]["url"], "http://url1") # --------------------------------------------------------------------------- @@ -292,10 +341,25 @@ class TestViewPR(unittest.TestCase): "html_url": "http://url1", "mergeable": True, "body": "description", "user": {"login": "user1"} } - result = gitea_view_pr(pr_number=1) + with patch.dict(os.environ, {}, clear=True): + result = gitea_view_pr(pr_number=1) self.assertEqual(result["number"], 1) self.assertEqual(result["body"], "description") self.assertEqual(result["user"], "user1") + self.assertNotIn("url", result) + + @patch("mcp_server.api_request") + @patch("mcp_server.get_auth_header", return_value=FAKE_AUTH) + def test_view_pr_reveal_opt_in_includes_url(self, _auth, mock_api): + mock_api.return_value = { + "number": 1, "title": "PR 1", "state": "open", + "head": {"ref": "branch1"}, "base": {"ref": "main"}, + "html_url": "http://url1", "mergeable": True, "body": "description", + "user": {"login": "user1"} + } + with patch.dict(os.environ, {"GITEA_MCP_REVEAL_ENDPOINTS": "1"}, clear=True): + result = gitea_view_pr(pr_number=1) + self.assertEqual(result["url"], "http://url1") # --------------------------------------------------------------------------- @@ -1674,9 +1738,30 @@ class TestTrackerHygieneCleanup(unittest.TestCase): return {} self.mock_api.side_effect = api_side_effect - res = gitea_edit_pr(pr_number=1, state="closed") + with patch.dict(os.environ, {}, clear=True): + res = gitea_edit_pr(pr_number=1, state="closed") self.assertTrue(res["success"]) self.assertEqual(res["cleanup_status"].get(123), "released") + self.assertNotIn("url", res) + + def test_edit_pr_reveal_opt_in_includes_url(self): + def api_side_effect(method, url, auth, payload=None): + if method == "PATCH" and "pulls/1" in url: + return { + "number": 1, + "title": "My PR", + "state": "open", + "html_url": "http://url1", + "body": "No issue link", + "head": {"ref": "feat/my-branch"} + } + return {} + self.mock_api.side_effect = api_side_effect + + with patch.dict(os.environ, {"GITEA_MCP_REVEAL_ENDPOINTS": "1"}, clear=True): + res = gitea_edit_pr(pr_number=1, title="Updated") + self.assertTrue(res["success"]) + self.assertEqual(res["url"], "http://url1") def test_multiple_linked_issues(self): def api_side_effect(method, url, auth, payload=None): From c349b98206c017b79620c544d218e97a1af80e7b Mon Sep 17 00:00:00 2001 From: Jason Walker <913443@dadeschools.net> Date: Sat, 4 Jul 2026 17:06:41 -0400 Subject: [PATCH 2/2] docs: note in-place mutation contract on _with_optional_url Subagent review (read-only) found no blockers; this addresses its one LOW note by documenting that the helper mutates the passed dict and must receive a freshly-built one. Co-Authored-By: Claude Fable 5 --- mcp_server.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/mcp_server.py b/mcp_server.py index e63c37a..3964f76 100644 --- a/mcp_server.py +++ b/mcp_server.py @@ -56,7 +56,11 @@ def _reveal_endpoints() -> bool: def _with_optional_url(result: dict, url: str | None) -> dict: - """Attach web links only under the explicit endpoint reveal opt-in.""" + """Attach web links only under the explicit endpoint reveal opt-in. + + Mutates *result* in place and returns it; pass a freshly-built dict, + never a shared/aliased one. + """ if _reveal_endpoints() and url: result["url"] = url return result