Skip to content

Add OSRS Companion plugin#10739

Closed
isaachansen wants to merge 1 commit into
runelite:masterfrom
isaachansen:mcp-sync
Closed

Add OSRS Companion plugin#10739
isaachansen wants to merge 1 commit into
runelite:masterfrom
isaachansen:mcp-sync

Conversation

@isaachansen
Copy link
Copy Markdown

@isaachansen isaachansen commented Feb 25, 2026

Summary

Adds the OSRS MCP Companion plugin — saves player data locally as JSON files for use with AI assistants via the Model Context Protocol (MCP).

What it does

  • Periodically saves player data (skills, bank, inventory, equipment, quests, achievement diaries, combat achievements) to ~/.runelite/osrs-companion/{username}.json
  • All data stays local — zero network requests from the plugin
  • Each data category can be individually toggled on/off
  • Configurable save interval (default 60s)

How it's used

The companion MCP server (osrs-companion on npm) reads these local JSON files and exposes them as tools for AI assistants like Claude. It also provides OSRS Wiki search, page summaries, and GE price lookups.

Compliance

  • BSD 2-Clause license
  • Java 11, no reflection, no JNI
  • No HTTP/network calls in the plugin
  • No third-party dependencies beyond what RuneLite bundles (Gson, Lombok)

Repository: https://github.com/isaachansen/runelite-osrs-companion

@runelite-github-app
Copy link
Copy Markdown

runelite-github-app Bot commented Feb 25, 2026

@raiyni
Copy link
Copy Markdown
Member

raiyni commented Feb 25, 2026

https://runelite.net/plugin-hub/show/csvexport already exists

@raiyni
Copy link
Copy Markdown
Member

raiyni commented Feb 25, 2026

Also you should consider https://meta.runescape.wiki/w/Meta:Generative_AI_policy in whatever other app you are hosting.

@isaachansen
Copy link
Copy Markdown
Author

https://runelite.net/plugin-hub/show/csvexport already exists

Thanks for the link! CSVExport is a cool plugin but it solves a different problem — it's designed for exporting game data to spreadsheet tools like Excel or Tableau. This plugin is purpose-built for AI assistants via MCP.

A few key differences:

  • Output format: CSVExport writes flat CSV files every tick; this plugin writes structured JSON on meaningful events (stat changes, bank opens, etc.)
  • Data scope: CSVExport doesn't track quests, achievement diaries, or combat achievements, which are some of the most useful things for AI-driven advice
  • AI integration: This plugin pairs with the osrs-companion MCP server, so tools like Claude can query your player data directly — no custom parsing needed
  • Privacy: All data stays local, nothing is sent over the network

Think of CSVExport as a data analysis tool and this as an AI context provider — different use cases!

@isaachansen
Copy link
Copy Markdown
Author

Also you should consider https://meta.runescape.wiki/w/Meta:Generative_AI_policy in whatever other app you are hosting.

Thanks for flagging that! I've reviewed the policy and I believe this plugin is fully compliant. The MCP only reads from the wiki on-demand when a user makes a query — it doesn't write to the wiki, bulk scrape content, or use wiki data for AI training. The policy's main concerns are around AI-generated wiki edits and using wiki content as training data, neither of which apply here. Happy to discuss further if you have specific concerns!

@raiyni
Copy link
Copy Markdown
Member

raiyni commented Feb 25, 2026

Please send a human

Saves player data locally as JSON for use with AI assistants via Model
Context Protocol (MCP). No network requests — all data stays on disk.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@isaachansen
Copy link
Copy Markdown
Author

Please send a human

I am terrible at english you dont want a human

@runelite-github-app
Copy link
Copy Markdown

This plugin requires a review from a Plugin Hub maintainer. The reviewer will request any additional changes if needed.


Internal use only: Reviewer details Maintainer details

@raiyni
Copy link
Copy Markdown
Member

raiyni commented Feb 25, 2026

I would assume if the wiki wanted an MCP pipeline, they would have one. You should probably discuss your usage with them.

@isaachansen
Copy link
Copy Markdown
Author

I would assume if the wiki wanted an MCP pipeline, they would have one. You should probably discuss your usage with them.

it uses the same public API endpoints any browser or app would use. no scraping, no bulk requests, no training data. Them building an MCP pipeline is a very specific use case that I do not think benefits them.

@isaachansen
Copy link
Copy Markdown
Author

isaachansen commented Feb 25, 2026

If the idea of this being too closely connected to an MCP is not ideal I can change the way this plugin is setup as just a JSONExport or something. Other people could use that outside of MCPs. CSVExport doesn't have all the data i would need, seems like there are some bugs based on the issues and I don't really need to store historical data either (I am not sure if it does do that but I assume so considering it writes a new file every 24 hours?). Thoughts?

@isaachansen isaachansen changed the title Add OSRS MCP Companion plugin Add OSRS Companion plugin Feb 25, 2026
@isaachansen
Copy link
Copy Markdown
Author

Closing — will resubmit with updated naming and scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants