Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Setup cspell for repo with per-tool configs and common words #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
Loading
from
Open

Setup cspell for repo with per-tool configs and common words #98

wants to merge 1 commit into from
+1,278 −0

Conversation

FrankDannie
Copy link

@FrankDannie FrankDannie commented Sep 1, 2025 •
edited
Loading

What does this PR do?

This PR sets up cspell for the MCP repository to help detect spelling issues across tools.

GitHub issue number?

#89

Changes included:

  1. Added .cspell-common.yaml containing repo-wide common words.
  2. Added generate-cspell.sh script to regenerate tool-specific word lists.

With this setup:

  • Unknown words per tool are tracked in their cspell.yaml.
  • Common words are centralized in .cspell-common.yaml.
  • The repository is ready for consistent spell checking across all tools.

All tools have been scanned, and no unknown words were found at this point.

Pre-merge Checklist

  • Required for All PRs
    • Read contribution guidelines
    • PR title clearly describes the change
    • Commit history is clean with descriptive messages (cleanup guide)
    • Added comprehensive tests for new/modified functionality
    • Updated CHANGELOG.md for product changes (features, bug fixes, UI/UX, updated dependencies)
    • Spelling check passes: .\eng\common\spelling\Invoke-Cspell.ps1
  • For MCP tool changes:
    • One tool per PR: This PR adds or modifies only one MCP tool for faster review cycles
    • Updated README.md documentation
    • Updated command list in /docs/azmcp-commands.md
    • Updated test prompts in /docs/e2eTestPrompts.md
    • For new or modified tool descriptions, ran ToolDescriptionEvaluator and obtained a score of 0.4 or more and a top 3 ranking for all related test prompts
  • 👉 For Community (non-Azure team member) PRs:
    • Security review: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (crypto mining, spam, data exfiltration, etc.)
    • Manual tests run: added comment /azp run azure - mcp to run Live Test Pipeline

@FrankDannie
Setup cspell for repo with per-tool configs and common words
e6c5fd1 
- Added .cspell-common.yaml with repo-wide words
- Generated per-tool cspell.yaml files importing common words
@FrankDannie
Copy link
Author

@microsoft-github-policy-service agree

@FrankDannie please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

@microsoft-github-policy-service agree

feiskyer pushed a commit to feiskyer/microsoft-mcp that referenced this pull request Sep 8, 2025
@hallipr
Remove explicit eng-sys ownership (microsoft#98)
c4b8a99 
* Remove explicit eng-sys ownership
* Revert script changes
@jongio
Copy link
Contributor

jongio commented Oct 6, 2025

@hallipr - Do we need this given we already have cspell?

@hallipr
Copy link
Member

hallipr commented Oct 13, 2025

@jongio, we do have cspell, but could use custom config support per tool or server if needed. See #89

@hallipr
Copy link
Member

hallipr commented Oct 13, 2025

Hi @FrankDannie, thanks for the PR. We already have cspell in the repo (see .vscode/cspell.json) and our pipelines run a script that installs cspell and looks for that common config (eng/common/spelling/Invoke-Cspell.ps1)

But we could use a more standardized way of defining new words per server or tool and have issue #89 open for that work. Ideally, each tool or server folder could have its own config and could reference the main config at .vscode/cspell.json. We'd just need to be sure our Invoke-Cspell.ps1 still honors the per-directory configs as well.

@g2vinay g2vinay added the Do Not Merge Do Not Merge / WIP PRs label Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vladimisms vladimisms Awaiting requested review from vladimisms vladimisms is a code owner

@nishtha489 nishtha489 Awaiting requested review from nishtha489 nishtha489 is a code owner

@vurhanau vurhanau Awaiting requested review from vurhanau vurhanau is a code owner

@jongio jongio Awaiting requested review from jongio jongio is a code owner

@xiangyan99 xiangyan99 Awaiting requested review from xiangyan99 xiangyan99 is a code owner

@alzimmermsft alzimmermsft Awaiting requested review from alzimmermsft alzimmermsft is a code owner

@philon-msft philon-msft Awaiting requested review from philon-msft philon-msft is a code owner

@anuchandy anuchandy Awaiting requested review from anuchandy anuchandy is a code owner

@conniey conniey Awaiting requested review from conniey conniey is a code owner

@ramnov ramnov Awaiting requested review from ramnov ramnov is a code owner

@mattkohnms mattkohnms Awaiting requested review from mattkohnms mattkohnms is a code owner

@wolfgang-desalvador wolfgang-desalvador Awaiting requested review from wolfgang-desalvador

@srnagar srnagar Awaiting requested review from srnagar srnagar is a code owner

@meirloichter meirloichter Awaiting requested review from meirloichter meirloichter is a code owner

@danield137 danield137 Awaiting requested review from danield137 danield137 is a code owner

@jayanthjj jayanthjj Awaiting requested review from jayanthjj jayanthjj is a code owner

@vcolin7 vcolin7 Awaiting requested review from vcolin7 vcolin7 is a code owner

@JonathanCrd JonathanCrd Awaiting requested review from JonathanCrd JonathanCrd is a code owner

@weng5e weng5e Awaiting requested review from weng5e weng5e is a code owner

@wbreza wbreza Awaiting requested review from wbreza wbreza is a code owner

@msalaman msalaman Awaiting requested review from msalaman msalaman is a code owner

@g2vinay g2vinay Awaiting requested review from g2vinay g2vinay is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@hallipr hallipr

Labels

Do Not Merge Do Not Merge / WIP PRs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@FrankDannie @jongio @hallipr @g2vinay
Morty Proxy This is a proxified and sanitized view of the page, visit original site.