Skip to content

Commit e90f8dd

Browse files
authored
Merge pull request #53 from Appsilon/fix-readme-links
Fix readme links
2 parents 4d3e3bd + 4d24b61 commit e90f8dd

4 files changed

Lines changed: 27 additions & 13 deletions

File tree

README.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,22 @@ Currently supports two Teal module packages:
1414

1515
## Documentation
1616

17-
- **[Quickstart Guide](docs/QUICKSTART.md)** - Get started with VSCode and GitHub Copilot
18-
- **[Tool Reference](docs/TOOLS.md)** - Complete reference for all 14 MCP tools
19-
- **[Configuration Guide](docs/CONFIGURATION.md)** - Setup, usage examples, and FAQs
17+
- **[Quickstart Guide](https://appsilon.github.io/TealFlowMCP/QUICKSTART/)** - Get started with VSCode and GitHub Copilot
18+
- **[Tool Reference](https://appsilon.github.io/TealFlowMCP/TOOLS/)** - Complete reference for all 14 MCP tools
19+
- **[Configuration Guide](https://appsilon.github.io/TealFlowMCP/CONFIGURATION/)** - Setup, usage examples, and FAQs
2020

2121
## Quick Start
2222

23-
**New to TealFlowMCP?** Check out the [Quickstart Guide](docs/QUICKSTART.md) for step-by-step instructions to get up and running with VSCode and GitHub Copilot.
23+
**New to TealFlowMCP?** Check out the [Quickstart Guide](https://appsilon.github.io/TealFlowMCP/QUICKSTART/) for step-by-step instructions to get up and running with VSCode and GitHub Copilot.
2424

2525
## Prerequisites
2626

2727
* Python 3.10+
28-
* uv (Python project manager) installed and available in your PATH
2928
* R (required for running generated Teal applications)
3029

30+
**For development/source installation only:**
31+
* uv (Python project manager) - [Installation guide](https://docs.astral.sh/uv/getting-started/installation/)
32+
3133
## MCP Compatibility
3234

3335
This server implements the **Model Context Protocol (MCP)** standard and works with any MCP-compatible LLM client, including:
@@ -64,7 +66,7 @@ The server is LLM-agnostic—it provides tools that any LLM can use to build Tea
6466

6567
Replace `/absolute/path/to/TealFlowMCP` with the actual absolute path to your cloned repository.
6668

67-
Consult your editor's documentation for the exact location of the MCP configuration file. See the [Quickstart Guide](docs/QUICKSTART.md) and [Configuration Guide](docs/CONFIGURATION.md) for detailed setup instructions.
69+
Consult your editor's documentation for the exact location of the MCP configuration file. See the [Quickstart Guide](https://appsilon.github.io/TealFlowMCP/QUICKSTART/) and [Configuration Guide](https://appsilon.github.io/TealFlowMCP/CONFIGURATION/) for detailed setup instructions.
6870

6971
## Architecture
7072

@@ -229,14 +231,26 @@ print(f'Found {result[\"count\"]} datasets')
229231

230232
## Running the MCP
231233

232-
The MCP can be run with a command:
234+
**For PyPI installation:**
235+
236+
```bash
237+
tealflow-mcp
238+
```
239+
240+
**For source installation:**
233241

234242
```bash
235243
uv --directory /absolute/path/to/TealFlowMCP/ run tealflow_mcp.py
236244
```
237245

238246
You can also test the MCP using the MCP inspector:
239247

248+
**PyPI installation:**
249+
```bash
250+
npx @modelcontextprotocol/inspector tealflow-mcp
251+
```
252+
253+
**Source installation:**
240254
```bash
241255
npx @modelcontextprotocol/inspector uv --directory /absolute/path/to/TealFlowMCP/ run tealflow_mcp.py
242256
```
@@ -269,7 +283,7 @@ TealFlowMCP provides 14 tools for building Teal applications:
269283
- `tealflow_snapshot_renv_environment` - Snapshot current R environment state
270284
- `tealflow_check_shiny_startup` - Validate app startup
271285

272-
**[View complete tool reference →](docs/TOOLS.md)**
286+
**[View complete tool reference →](https://appsilon.github.io/TealFlowMCP/TOOLS/)**
273287

274288
## Configuration
275289

@@ -292,7 +306,7 @@ TealFlowMCP works with any MCP-compatible client (Claude Desktop, Claude Code, G
292306
}
293307
```
294308

295-
**[View complete configuration guide →](docs/CONFIGURATION.md)**
309+
**[View complete configuration guide →](https://appsilon.github.io/TealFlowMCP/CONFIGURATION/)**
296310

297311
## Quick Start
298312

@@ -307,7 +321,7 @@ The LLM will automatically:
307321
- Validate dataset compatibility
308322
- Generate complete app code
309323

310-
**[View usage examples and FAQs →](docs/CONFIGURATION.md)**
324+
**[View usage examples and FAQs →](https://appsilon.github.io/TealFlowMCP/CONFIGURATION/)**
311325

312326
## About Appsilon
313327

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "tealflow-mcp"
7-
version = "0.1.3.post1"
7+
version = "0.1.3.post2"
88
description = "MCP server for discovering, understanding, and generating Teal R Shiny applications for clinical trial data analysis"
99
readme = "README.md"
1010
requires-python = ">=3.10"

tealflow_mcp/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- Generating R code for Teal apps
1414
"""
1515

16-
__version__ = "0.1.3.post1"
16+
__version__ = "0.1.3.post2"
1717

1818
from .core import PackageFilter, ResponseFormat
1919
from .models import (

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)