dylanebert
commited on
Commit
·
6c7274f
1
Parent(s):
2569caf
minimize readme
Browse files
README.md
CHANGED
@@ -9,86 +9,3 @@ app_file: app.py
|
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
12 |
-
|
13 |
-
# Research Tracker MCP Server
|
14 |
-
|
15 |
-
A Gradio-based MCP (Model Context Protocol) server that provides research inference utilities for AI assistants and tools. This server offers public-facing APIs to extract and infer research metadata from various sources like papers, repositories, and project pages.
|
16 |
-
|
17 |
-
## Features
|
18 |
-
|
19 |
-
### MCP Tools Available
|
20 |
-
|
21 |
-
- **`infer_authors`**: Extract author names from research papers, repositories, or project URLs
|
22 |
-
- **`infer_paper_url`**: Find associated research papers from GitHub repos, project pages, or partial information
|
23 |
-
- **`infer_code_repository`**: Locate code repositories from paper URLs or project information
|
24 |
-
- **`infer_research_name`**: Extract formal paper/project titles from various inputs
|
25 |
-
- **`classify_research_url`**: Classify URLs as Paper, Code, Model, Dataset, Space, or Project
|
26 |
-
|
27 |
-
### Supported Input Types
|
28 |
-
|
29 |
-
- **arXiv papers**: `https://arxiv.org/abs/2010.11929`
|
30 |
-
- **GitHub repositories**: `https://github.com/google-research/vision_transformer`
|
31 |
-
- **Hugging Face resources**: Models, Datasets, Spaces, Papers
|
32 |
-
- **Project pages**: GitHub Pages, personal websites
|
33 |
-
- **Research titles**: Natural language paper titles
|
34 |
-
|
35 |
-
## Usage
|
36 |
-
|
37 |
-
### As MCP Server
|
38 |
-
|
39 |
-
This space can be used as an MCP server by AI assistants that support the MCP protocol. Configure your MCP client with:
|
40 |
-
|
41 |
-
```json
|
42 |
-
{
|
43 |
-
"mcpServers": {
|
44 |
-
"research-tracker": {
|
45 |
-
"url": "https://YOUR_SPACE_NAME.hf.space/gradio_api/mcp/sse"
|
46 |
-
}
|
47 |
-
}
|
48 |
-
}
|
49 |
-
```
|
50 |
-
|
51 |
-
### Web Interface
|
52 |
-
|
53 |
-
The space also provides a web interface for testing the inference functions directly in your browser.
|
54 |
-
|
55 |
-
## Architecture
|
56 |
-
|
57 |
-
This MCP server delegates all inference logic to the [Research Tracker Backend](https://huggingface.co/spaces/dylanebert/research-tracker-backend) to ensure consistency and avoid code duplication. It serves as a public-facing interface for research inference utilities without requiring database access.
|
58 |
-
|
59 |
-
## Examples
|
60 |
-
|
61 |
-
### Infer Authors from arXiv Paper
|
62 |
-
```python
|
63 |
-
infer_authors("https://arxiv.org/abs/2010.11929")
|
64 |
-
# Returns: ["Alexey Dosovitskiy", "Lucas Beyer", "Alexander Kolesnikov", ...]
|
65 |
-
```
|
66 |
-
|
67 |
-
### Find Paper from GitHub Repository
|
68 |
-
```python
|
69 |
-
infer_paper_url("https://github.com/google-research/vision_transformer")
|
70 |
-
# Returns: "https://arxiv.org/abs/2010.11929"
|
71 |
-
```
|
72 |
-
|
73 |
-
### Classify URL Type
|
74 |
-
```python
|
75 |
-
classify_research_url("https://huggingface.co/google/vit-base-patch16-224")
|
76 |
-
# Returns: "Model"
|
77 |
-
```
|
78 |
-
|
79 |
-
## Requirements
|
80 |
-
|
81 |
-
- Python 3.11+
|
82 |
-
- Gradio with MCP support
|
83 |
-
- Internet connection for backend API calls
|
84 |
-
|
85 |
-
## Development
|
86 |
-
|
87 |
-
The server is built with:
|
88 |
-
- **Gradio**: Web interface and MCP protocol support
|
89 |
-
- **Requests**: HTTP client for backend communication
|
90 |
-
- **Backend Integration**: Calls to research-tracker-backend API
|
91 |
-
|
92 |
-
## License
|
93 |
-
|
94 |
-
MIT License - Feel free to use and modify for your research needs.
|
|
|
9 |
pinned: false
|
10 |
license: mit
|
11 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|