Add MCP tool for on-demand Git documentation sync

This commit is contained in:
Joren de Graaf
2026-11-06 15:01:54 +01:00
parent 3a12d56f8b
commit 2a6450b416
3 changed files with 104 additions and 3 deletions
+59 -2
View File
@@ -9,13 +9,13 @@ from unittest.mock import patch
from asgiref.sync import async_to_sync
from django.contrib.auth import get_user_model
from django.core.exceptions import ValidationError
from django.test import Client, TestCase, override_settings
from django.test import Client, TestCase, TransactionTestCase, override_settings
from django.urls import reverse
from django.utils import timezone
from mcp.server.auth.provider import AccessToken
from mcp.server.mcpserver.exceptions import ToolError
from mcp_server.server import create_server
from mcp_server.server import create_server, _docs_sync_result, _safe
from .documentation import (_fetch_snapshot, _git_env, _repository_url, audit_status,
document_diff, document_history, historical_document,
normal_path, sync_project)
@@ -211,3 +211,60 @@ class DocumentationTests(TestCase):
with self.captureOnCommitCallbacks(execute=True):
self.project.delete()
self.assertFalse(mirror.exists())
class DocumentationMcpSyncTests(TransactionTestCase):
"""Exercise the sync handler without the in-process MCP async bridge."""
def setUp(self):
users = get_user_model()
self.owner = users.objects.create_user('sync-owner', password='password')
self.viewer = users.objects.create_user('sync-viewer', password='password')
self.project = create_project(self.owner, name='MCP sync test',
git_repository_url='https://git.jorendegraaf.eu/owner/project.git')
Membership.objects.create(project=self.project, user=self.viewer, role='viewer')
def snapshot(self):
markdown = '# Read me\n'
document = ProjectDocument(project=self.project, path='docs/README.md', title='Read me',
headings=['Read me'], markdown=markdown, content_hash=hashlib.sha256(markdown.encode()).hexdigest(),
source_commit='a' * 40)
return (self.project.git_repository_url, 'refs/heads/main', 'a' * 40, timezone.now(), [document], {})
def test_mcp_sync_permissions_metadata_cooldown_and_failure(self):
server = create_server()
def call(arguments):
return _safe(lambda: _docs_sync_result(**arguments))
self.assertIn('docs_sync', [tool.name for tool in server._tool_manager.list_tools()])
owner = AccessToken(token='test', client_id='test', scopes=['projects:read', 'projects:write'], subject=str(self.owner.pk))
read_only = AccessToken(token='test', client_id='test', scopes=['projects:read'], subject=str(self.owner.pk))
viewer = AccessToken(token='test', client_id='test', scopes=['projects:read', 'projects:write'], subject=str(self.viewer.pk))
args = {'project': str(self.project.pk)}
with patch('mcp_server.server.get_access_token', return_value=read_only):
with self.assertRaisesRegex(ToolError, 'projects:write authorization required'):
call(args)
with patch('mcp_server.server.get_access_token', return_value=viewer):
with self.assertRaisesRegex(ToolError, 'not_found|permission_denied'):
call(args)
with patch('mcp_server.server.get_access_token', return_value=owner):
with patch('projects.documentation._fetch_snapshot', return_value=self.snapshot()) as fetch:
first = call(args)
self.assertEqual(first['status'], 'completed')
self.assertEqual(first['document_count'], 1)
self.assertEqual(first['indexed_commit'], 'a' * 40)
self.assertIsNotNone(first['last_success_at'])
again = call(args)
self.assertEqual(again['status'], 'already_current')
self.assertIsNotNone(again['retry_after_seconds'])
diverged = call({**args, 'expected_remote_commit': 'b' * 40})
self.assertEqual(diverged['status'], 'failed')
self.assertIn('differs', diverged['error'])
fetch.assert_called_once()
DocumentationSync.objects.filter(project=self.project).update(last_attempt_at=timezone.now() - timedelta(minutes=2))
from .documentation import DocumentationError
with patch('projects.documentation._fetch_snapshot', side_effect=DocumentationError('fetch unavailable')):
failed = call(args)
self.assertEqual(failed['status'], 'failed')
self.assertEqual(failed['indexed_commit'], 'a' * 40)
self.assertIn('fetch unavailable', failed['error'])
self.assertTrue(ProjectDocument.objects.filter(project=self.project, path='docs/README.md').exists())