Skip to content

Commit 76872c6

Browse files
Update README.md to include hosted server details and integration examples for MCP clients
1 parent 6630ccf commit 76872c6

File tree

1 file changed

+78
-8
lines changed

1 file changed

+78
-8
lines changed

README.md

Lines changed: 78 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# IO Aerospace MCP Server
22

3+
> Use it now — hosted in production (no setup needed): https://mcp.io-aerospace.org/
4+
>
5+
> SSE endpoint: https://mcp.io-aerospace.org/sse
6+
>
7+
> Note: Most MCP clients that support HTTP/SSE only need the base URL; they will connect to the SSE stream internally (commonly at `/sse`). The explicit `/sse` URL is provided here for manual/web integrations.
8+
39
A Model Context Protocol (MCP) server for aerospace and astrodynamics calculations, providing tools for celestial body ephemeris, orbital mechanics, and space mission analysis.
410

511
## Overview
@@ -16,6 +22,27 @@ The server includes comprehensive tools for:
1622
- Mathematical conversions for aerospace calculations
1723
- Time system conversions and utilities
1824

25+
## Use the hosted server (recommended)
26+
27+
You can start integrating immediately against the production instance:
28+
- Base URL: https://mcp.io-aerospace.org/
29+
- SSE stream: https://mcp.io-aerospace.org/sse
30+
31+
Example (browser/Node):
32+
```javascript
33+
const eventSource = new EventSource('https://mcp.io-aerospace.org/sse');
34+
35+
eventSource.onmessage = (event) => {
36+
console.log('message', event.data);
37+
};
38+
39+
eventSource.onerror = (err) => {
40+
console.error('sse error', err);
41+
};
42+
```
43+
44+
Self-hosting is optional; see below for Docker and .NET instructions.
45+
1946
## Project Structure
2047

2148
```
@@ -81,9 +108,9 @@ mcp-server/
81108
- **MetersToParsec** / **ParsecToMeters**: Stellar distance conversions
82109
- **MetersToLightYears** / **LightYearsToMeters**: Cosmic distance conversions
83110

84-
## Quick Start
111+
## Quick Start (self-hosting)
85112

86-
### Docker Deployment (Recommended)
113+
### Docker Deployment
87114

88115
#### Development
89116
```bash
@@ -92,7 +119,7 @@ cd mcp-server
92119
docker-compose up
93120
```
94121

95-
The SSE server will be available at `http://localhost:8080`
122+
The SSE server will be available at `http://localhost:8080`.
96123

97124
#### Production
98125
1. Copy `docker-compose.prod.example.yml` to `docker-compose.prod.yml`
@@ -172,7 +199,9 @@ dotnet run
172199

173200
## MCP Client Integration
174201

175-
### Claude Desktop Configuration
202+
Note: Many MCP clients use JSON-based configuration files, but schemas differ per client. The JSON examples below use Claude Desktop’s schema; adapt keys to your client’s format.
203+
204+
### Claude Desktop Configuration (STDIO)
176205
Add to your Claude Desktop configuration:
177206

178207
```json
@@ -189,11 +218,52 @@ Add to your Claude Desktop configuration:
189218
}
190219
```
191220

192-
### HTTP/SSE Integration
193-
For web-based integrations, connect to the SSE endpoint:
221+
### Claude Desktop Configuration (HTTP transport to hosted server)
222+
Use your production server over HTTP/SSE by specifying the base URL only:
194223

195-
```javascript
196-
const eventSource = new EventSource('http://your-domain/sse');
224+
```json
225+
{
226+
"mcpServers": {
227+
"astrodynamics": {
228+
"transport": {
229+
"type": "http",
230+
"url": "https://mcp.io-aerospace.org"
231+
}
232+
}
233+
}
234+
}
235+
```
236+
237+
- Only the base URL is required; the client will use the SSE stream internally (commonly at `/sse`).
238+
- This schema is for Claude Desktop; other clients may use different keys.
239+
240+
### Other MCP clients
241+
- Provide the base URL: https://mcp.io-aerospace.org
242+
- Add headers (e.g., Authorization) only if your deployment requires it
243+
- Don’t append `/sse` unless your client documentation requires it; most discover the SSE path
244+
- Refer to your client’s documentation for the exact JSON schema or settings UI
245+
246+
### Node.js MCP client (HTTP/SSE)
247+
Using the MCP SDK to connect to the hosted server and list tools:
248+
249+
```ts
250+
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
251+
import { HttpClientTransport } from "@modelcontextprotocol/sdk/client/transport/http.js";
252+
253+
const transport = new HttpClientTransport(new URL("https://mcp.io-aerospace.org"));
254+
const client = new Client(
255+
{ name: "example-client", version: "1.0.0" },
256+
{ capabilities: { tools: {}, prompts: {}, resources: {} } },
257+
transport
258+
);
259+
260+
await client.connect();
261+
const tools = await client.listTools();
262+
console.log("Tools:", tools);
263+
264+
// Example: call a tool
265+
// const result = await client.callTool({ name: "GetEphemerisAsStateVectors", arguments: { /* ... */ } });
266+
// console.log(result);
197267
```
198268

199269
## Troubleshooting

0 commit comments

Comments
 (0)