perigee-mcp 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 David Fugère-Lamarre
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,52 @@
1
- # Temporary Holding Version
1
+ # perigee-mcp
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ An [MCP](https://modelcontextprotocol.io/) server for [Perigee](https://perigee.info/), the open-source 3D viewer of the
4
+ artificial objects orbiting the Earth, the Moon and Mars and of the spacecraft crossing the solar system. It lets an
5
+ AI assistant (a teaching assistant, for example) answer questions such as “how far is Mars from the Earth on
6
+ 1 December 2026?”, “where is the ISS now?” or “what is Lucy's mission?”, and hand the student a live 3D view, with
7
+ **how each number was obtained, from which data, how fresh and how accurate**.
8
+
9
+ Educational use only: not for navigation, collision avoidance or conjunction assessment.
10
+
11
+ ## Use it
12
+
13
+ Claude Desktop (`claude_desktop_config.json`) or any MCP client that starts servers over stdio:
14
+
15
+ ```json
16
+ {
17
+ "mcpServers": {
18
+ "perigee": { "command": "npx", "args": ["-y", "perigee-mcp"] }
19
+ }
20
+ }
21
+ ```
22
+
23
+ Claude Code: `claude mcp add perigee -- npx -y perigee-mcp`. Node.js 20 or later.
24
+
25
+ ## Tools
26
+
27
+ | Tool | What it returns |
28
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
29
+ | `perigee_find` | Ids of objects matching a name (English or French): planets, moons, missions, any active Earth satellite (name, NORAD or COSPAR id), sites, stars |
30
+ | `perigee_object` | Facts: agency, country, launch, status, mission goals, identifiers, official website, sources and verification date, image with credit and licence |
31
+ | `perigee_state` | Position and velocity at a date relative to a centre, distance, altitude, speed, light time |
32
+ | `perigee_distance` | Distance between two objects at a date (km, au) and light time |
33
+ | `perigee_distance_series` | Distances over a period, with the closest and farthest samples |
34
+ | `perigee_view` | Link to the 3D view, and an `<iframe>` of the live view for a lesson page (the page can drive it and take PNG snapshots with the `perigee:v1` messages) |
35
+ | `perigee_define` | Student-level definitions (EN/FR) of apogee, inclination, NORAD number, ephemeris window… |
36
+ | `perigee_about` | Data sources and fetch times, models and their typical accuracy, attribution |
37
+
38
+ Every computed answer has a `provenance` list: the model (SGP4 from CelesTrak GP or supplemental GP elements,
39
+ Hermite interpolation of JPL Horizons vectors, two-body extrapolation, VSOP87 for planets, analytical or mean-element
40
+ moons), the data state (`fresh`, `interpolated`, `stale`, `extrapolated`, `hidden`, `modelled`, `none`), when the data
41
+ were fetched, the age of the orbital elements, the ephemeris window, and a typical accuracy with its basis.
42
+
43
+ ## Data
44
+
45
+ Positions are computed on your machine with the same code as the web app, from the data Perigee publishes at
46
+ `https://perigee.info/data/` (CelesTrak elements refreshed every 4 hours, JPL Horizons ephemerides daily). Each
47
+ dataset version is downloaded once and kept in a cache (`%LOCALAPPDATA%\perigee-mcp`, `~/Library/Caches/perigee-mcp`
48
+ or `~/.cache/perigee-mcp`; `PERIGEE_MCP_CACHE` overrides it). The server never contacts CelesTrak or Horizons.
49
+ `PERIGEE_SITE` points it to another Perigee deployment.
50
+
51
+ Credits: CelesTrak (T.S. Kelso) / 18th & 19th SDS via Space-Track, NASA/JPL-Caltech Horizons, astronomy-engine (MIT),
52
+ satellite.js (MIT); catalogue images under the licence given with each. Code: MIT, https://github.com/dlamarre-dev/Perigee.