Spaces:
Sleeping
Sleeping
File size: 3,244 Bytes
def69a7 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# TutorX MCP API Documentation
## Overview
The TutorX MCP API provides a comprehensive set of endpoints for educational tools and resources. The API follows RESTful principles and uses JSON for request/response bodies.
## Base URL
```
http://127.0.0.1:8000
```
## Authentication
Currently, the API does not require authentication. This will be implemented in future versions.
## Endpoints
### Health Check
```http
GET /health
```
Returns the health status of the server.
**Response**
```json
{
"status": "healthy",
"timestamp": "2024-03-14T12:00:00.000Z",
"server": "TutorX MCP",
"version": "1.0.0"
}
```
### Core Features
#### Assess Skill
```http
POST /mcp/tools/assess_skill
```
Assesses a student's skill level on a specific concept.
**Request Body**
```json
{
"student_id": "string",
"concept_id": "string"
}
```
**Response**
```json
{
"student_id": "string",
"concept_id": "string",
"skill_level": 0.75,
"confidence": 0.85,
"recommendations": [
"Practice more complex problems",
"Review related concept: algebra_linear_equations"
],
"timestamp": "2024-03-14T12:00:00.000Z"
}
```
#### Get Concept Graph
```http
GET /mcp/resources/concept-graph://
```
Returns the full knowledge concept graph.
**Response**
```json
{
"nodes": [
{
"id": "math_algebra_basics",
"name": "Algebra Basics",
"difficulty": 1
}
],
"edges": [
{
"from": "math_algebra_basics",
"to": "math_algebra_linear_equations",
"weight": 1.0
}
]
}
```
#### Get Learning Path
```http
GET /mcp/resources/learning-path://{student_id}
```
Returns a personalized learning path for a student.
**Response**
```json
{
"student_id": "string",
"current_concepts": ["math_algebra_linear_equations"],
"recommended_next": ["math_algebra_quadratic_equations"],
"mastered": ["math_algebra_basics"],
"estimated_completion_time": "2 weeks"
}
```
#### Generate Quiz
```http
POST /mcp/tools/generate_quiz
```
Generates a quiz based on specified concepts and difficulty.
**Request Body**
```json
{
"concept_ids": ["string"],
"difficulty": 2
}
```
**Response**
```json
{
"quiz_id": "string",
"concept_ids": ["string"],
"difficulty": 2,
"questions": [
{
"id": "string",
"text": "string",
"type": "string",
"answer": "string",
"solution_steps": ["string"]
}
]
}
```
## Error Responses
The API uses standard HTTP status codes and returns error details in the response body:
```json
{
"error": "Error message",
"timestamp": "2024-03-14T12:00:00.000Z"
}
```
Common status codes:
- 200: Success
- 400: Bad Request
- 404: Not Found
- 500: Internal Server Error
## Rate Limiting
Currently, there are no rate limits implemented. This will be added in future versions.
## Versioning
The API version is included in the response headers and health check endpoint. Future versions will support versioning through the URL path.
## Support
For support or to report issues, please contact the development team or create an issue in the project repository. |