[twin] Polish README and MCP tool descriptions for clarity and discoverability - #2
Merged
Merged
Conversation
…lity - README: add Quick start section (3 steps); break dense opening paragraph into clearer sentences; tighten Why Halal Terminal bullets; rename client sub-headings to remove "One-liner:" prefix - TOOLS.md: add "Use when:" dispatch hints to all 22 tools; add token-cost warning to bulk_screen; tighten get_stock_info and generate_report descriptions - server.json: rewrite description to lead with "22 tools" and free tier (239 chars, within registry limits) - package.json: rewrite description for npm search discoverability (256 chars, within npm limits) No logic changes — docs and metadata only.
There was a problem hiding this comment.
Pull request overview
This PR polishes user-facing documentation and package/registry metadata to make Halal Terminal’s MCP tools easier to discover and use.
Changes:
- Adds a README quick-start flow and simplifies client setup headings.
- Adds
Use when:dispatch hints across the tool reference. - Rewrites npm and MCP registry descriptions around the 22-tool positioning.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
README.md |
Adds quick start, updates intro copy, and tightens setup/benefit wording. |
TOOLS.md |
Adds tool-selection hints and refines several tool descriptions. |
server.json |
Updates registry description metadata. |
package.json |
Updates npm package description metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "name": "com.halalterminal/mcp", | ||
| "title": "Halal Terminal", | ||
| "description": "Shariah-compliant stock and ETF screening across AAOIFI, DJIM, FTSE, MSCI and S&P methodologies, plus portfolio audit, zakat, dividend purification, market data, news and SEC filings — for any MCP-compatible AI agent.", | ||
| "description": "22 tools for halal investing: screen stocks and ETFs across 5 Shariah methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P), audit portfolios, calculate zakat and dividend purification, fetch market data, news and SEC filings. Free tier available.", |
| "name": "@halalterminal/mcp", | ||
| "version": "1.0.0", | ||
| "description": "Official Halal Terminal MCP server — Shariah-compliant stock and ETF screening across AAOIFI, DJIM, FTSE, MSCI and S&P methodologies, plus portfolio audit, zakat, dividend purification, market data, news and SEC filings, for Claude, Cursor, Windsurf and any MCP-compatible AI agent.", | ||
| "description": "Halal Terminal MCP server — 22 tools: screen stocks/ETFs across 5 Shariah methodologies (AAOIFI, DJIM, FTSE, MSCI, S&P), audit portfolios, calculate zakat and purification, fetch market data and SEC filings. For Claude, Cursor, Windsurf and any MCP client.", |
| | `compare` | `run_id="id1,id2"` | Diff two runs | | ||
| | `list_indices` | — | Available indices | | ||
|
|
||
| Use when screening an entire index, filtering for compliant-only names, or comparing two screening runs. **Note: index runs consume many tokens — check `list_indices` and `summary` before triggering a full run.** |
goww7
added a commit
that referenced
this pull request
May 30, 2026
…imit) PR #2 expanded the description to 239 chars, but the MCP registry caps it at 100 — that value cannot be republished. Restore the as-published value (96 chars), reconciling the pre-existing local commit 47ac649; also ignore *.tgz. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
README.md
Then get a free API key…note that appeared mid-Install; the Quick start section handles it nowTOOLS.md
Use when:dispatch hints to all 22 tools (previously onlyscreen_stockhad one) — helps AI agents pick the right tool without ambiguitybulk_screen: "index runs consume many tokens — checklist_indicesandsummarybefore triggering a full run"get_stock_infodescription to note it returns sector, exchange, and description datagenerate_reportdescription to "ready to share or save"server.json
descriptionto lead with "22 tools for halal investing" and mention the free tier: 239 chars (within registry limits)package.json
descriptionfor npm search discoverability, leading with the concrete tool count: 256 chars (within npm limits)What was NOT changed
bin/cli.mjs— no logic changesCONNECT.md,EXAMPLES.md— no changesTests
No test suite in this repo (docs/metadata package only).
bin/cli.mjssyntax is valid; the only runtime dependency (@modelcontextprotocol/sdk) is unchanged.Human action required
None beyond review and merge. No deploy steps needed — this is docs and package metadata only.
Generated by Claude Code