Skip to content

Commit 5b3a455

Browse files
TMHSDigitalTMHSDigital
committed
Enhance documentation: add Code of Conduct and Security Policy, update skill files with Key References and See Also sections, and correct formatting in various files. Updated plugin manifest to reflect the addition of new issue and pull request templates.
1 parent 933bc0f commit 5b3a455

26 files changed

Lines changed: 450 additions & 9 deletions

File tree

‎.cursor-plugin/plugin.json‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
"steamworks",
1616
"gamedev",
1717
"steam-api",
18-
"game-development"
18+
"game-development",
19+
"multiplayer",
20+
"achievements",
21+
"workshop",
22+
"cloud-saves",
23+
"leaderboards",
24+
"steam-deck",
25+
"mcp",
26+
"cursor-plugin"
1927
],
2028
"category": "developer-tools",
2129
"tags": [

‎.cursorrules‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,31 @@
22

33
## Formatting
44

5-
- Never use em dashes (—). Use a regular dash (-) or rewrite the sentence instead.
5+
- Never use em dashes (-). Use a regular dash (-) or rewrite the sentence instead.
6+
7+
## Skill File Conventions
8+
9+
- Every skill lives in `skills/<kebab-case-name>/SKILL.md`
10+
- YAML frontmatter is required with `name` (matching the directory name) and `description` (one line, when-to-use guidance)
11+
- Required sections in order: Trigger, Required Inputs, Workflow, Key References (if applicable), Example Interaction, MCP Usage, See Also
12+
- Keep `## MCP Usage` present even for SDK-only skills (state that no Web API equivalent exists)
13+
14+
## Rule File Conventions
15+
16+
- Rules use `.mdc` extension in the `rules/` directory
17+
- YAML frontmatter must include `description` and `alwaysApply` (boolean)
18+
- If `alwaysApply` is false, include `globs` to scope when the rule activates
19+
20+
## Steam Conventions
21+
22+
- Achievement API names: `ACH_` prefix, uppercase with underscores (e.g., `ACH_BEAT_FINAL_BOSS`). Stable after release.
23+
- Depot IDs follow `appid + N` pattern (e.g., App ID `2345678` gives depots `2345679`, `2345680`, `2345681`)
24+
- Never hardcode Steam API keys. Use `STEAM_API_KEY` environment variable or `.env` file.
25+
- App ID `480` (SpaceWar) is the Steamworks SDK test app. Flag it in production contexts.
26+
27+
## MCP Tool Signatures
28+
29+
When referencing MCP tools in documentation, use the canonical parameter names from the skill files:
30+
- `steam.searchApps({ term })` not `{ query }`
31+
- `steam.getWorkshopItem({ publishedfileid })` not `{ fileid }`
32+
- `steam.getLeaderboardEntries({ appid, leaderboardid, rangestart?, rangeend? })` not `{ id, range }`

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug Report
3+
about: Report a skill or rule that isn't working as expected
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
**Skill / Rule affected**
10+
Which skill or rule is involved? (e.g., `steam-store-lookup`, `steamworks-secrets.mdc`)
11+
12+
**Describe the bug**
13+
A clear description of what went wrong.
14+
15+
**Steps to reproduce**
16+
1. Open Cursor and ask: "..."
17+
2. Observe that ...
18+
19+
**Expected behavior**
20+
What should have happened instead.
21+
22+
**Actual behavior**
23+
What actually happened (paste relevant Cursor output if possible).
24+
25+
**Environment**
26+
- OS: [e.g., Windows 11, macOS 15, Ubuntu 24.04]
27+
- Cursor version: [e.g., 0.48]
28+
- Plugin version: [e.g., 0.2.0]
29+
- Steam MCP server installed: [yes / no]
30+
31+
**Additional context**
32+
Any other relevant details, screenshots, or error messages.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Steam MCP Server
4+
url: https://github.com/TMHSDigital/steam-mcp/issues
5+
about: For issues with the companion Steam MCP server, file them in the steam-mcp repo.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new skill, rule, or improvement
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
**Is this a new skill, a new rule, or an improvement to an existing one?**
10+
[New skill / New rule / Improvement]
11+
12+
**Describe the feature**
13+
A clear description of what you'd like added or changed.
14+
15+
**Use case**
16+
When would a game developer use this? What problem does it solve?
17+
18+
**Steam API / SDK references**
19+
Link any relevant Steamworks documentation or API endpoints.
20+
21+
**Additional context**
22+
Any examples, mockups, or related skills/rules that this connects to.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## What does this PR do?
2+
3+
<!-- Brief description of the change -->
4+
5+
## Type of change
6+
7+
- [ ] New skill
8+
- [ ] New rule
9+
- [ ] Skill/rule improvement
10+
- [ ] Documentation update
11+
- [ ] Bug fix
12+
- [ ] Other
13+
14+
## Checklist
15+
16+
- [ ] YAML frontmatter is valid (skills: `name` + `description`; rules: `description` + `alwaysApply`)
17+
- [ ] Tested locally in Cursor (symlinked to `~/.cursor/plugins/local/`)
18+
- [ ] Follows existing skill structure (Trigger, Required Inputs, Workflow, Example Interaction, MCP Usage)
19+
- [ ] Updated CHANGELOG.md (if user-facing change)
20+
- [ ] No secrets, API keys, or credentials in the diff

‎.github/workflows/validate.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: Validate Plugin Structure
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
validate:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Validate plugin.json
16+
run: |
17+
echo "Checking plugin.json is valid JSON..."
18+
python3 -c "import json; json.load(open('.cursor-plugin/plugin.json'))"
19+
echo "plugin.json is valid."
20+
21+
- name: Check referenced paths exist
22+
run: |
23+
echo "Checking referenced paths..."
24+
test -d skills || { echo "ERROR: skills/ directory missing"; exit 1; }
25+
test -d rules || { echo "ERROR: rules/ directory missing"; exit 1; }
26+
test -f assets/logo.png || { echo "ERROR: assets/logo.png missing"; exit 1; }
27+
echo "All referenced paths exist."
28+
29+
- name: Validate skill frontmatter
30+
run: |
31+
echo "Checking skill YAML frontmatter..."
32+
errors=0
33+
for skill in skills/*/SKILL.md; do
34+
name=$(echo "$skill" | sed 's|skills/\(.*\)/SKILL.md|\1|')
35+
if ! head -1 "$skill" | grep -q "^---$"; then
36+
echo "ERROR: $skill missing YAML frontmatter opening ---"
37+
errors=$((errors + 1))
38+
continue
39+
fi
40+
frontmatter=$(sed -n '/^---$/,/^---$/p' "$skill" | sed '1d;$d')
41+
if ! echo "$frontmatter" | grep -q "^name:"; then
42+
echo "ERROR: $skill missing 'name' in frontmatter"
43+
errors=$((errors + 1))
44+
fi
45+
if ! echo "$frontmatter" | grep -q "^description:"; then
46+
echo "ERROR: $skill missing 'description' in frontmatter"
47+
errors=$((errors + 1))
48+
fi
49+
done
50+
if [ $errors -gt 0 ]; then
51+
echo "$errors frontmatter error(s) found."
52+
exit 1
53+
fi
54+
echo "All skill frontmatter valid."
55+
56+
- name: Validate rule frontmatter
57+
run: |
58+
echo "Checking rule YAML frontmatter..."
59+
errors=0
60+
for rule in rules/*.mdc; do
61+
if ! head -1 "$rule" | grep -q "^---$"; then
62+
echo "ERROR: $rule missing YAML frontmatter opening ---"
63+
errors=$((errors + 1))
64+
continue
65+
fi
66+
frontmatter=$(sed -n '/^---$/,/^---$/p' "$rule" | sed '1d;$d')
67+
if ! echo "$frontmatter" | grep -q "^description:"; then
68+
echo "ERROR: $rule missing 'description' in frontmatter"
69+
errors=$((errors + 1))
70+
fi
71+
if ! echo "$frontmatter" | grep -q "^alwaysApply:"; then
72+
echo "ERROR: $rule missing 'alwaysApply' in frontmatter"
73+
errors=$((errors + 1))
74+
fi
75+
done
76+
if [ $errors -gt 0 ]; then
77+
echo "$errors frontmatter error(s) found."
78+
exit 1
79+
fi
80+
echo "All rule frontmatter valid."
81+
82+
- name: Count components
83+
run: |
84+
skill_count=$(ls -d skills/*/SKILL.md 2>/dev/null | wc -l)
85+
rule_count=$(ls rules/*.mdc 2>/dev/null | wc -l)
86+
echo "Skills: $skill_count"
87+
echo "Rules: $rule_count"

‎CLAUDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ ln -s "$(pwd)" ~/.cursor/plugins/local/steam-cursor-plugin
101101
| `IPlayerService/GetOwnedGames/v1/` | API key |
102102
| `ISteamUser/ResolveVanityURL/v1/` | API key |
103103
| `ISteamUser/GetPlayerSummaries/v2/` | API key |
104-
| `IPlayerService/GetOwnedGames/v1/` | API key |
104+
| `IPlayerService/GetBadges/v1/` | API key |
105105
| `IPlayerService/GetRecentlyPlayedGames/v1/` | API key |
106106
| `IPlayerService/GetSteamLevel/v1/` | API key |
107107
| `ISteamUser/GetFriendList/v1/` | API key |

‎CODE_OF_CONDUCT.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported to the project maintainers via a
60+
[private security advisory](https://github.com/TMHSDigital/Steam-Cursor-Plugin/security/advisories/new)
61+
on GitHub. Do not use public issues for Code of Conduct reports.
62+
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ Cursor will pick up changes to skills and rules without restarting.
3636

3737
## Plugin Structure
3838

39-
The plugin currently has **14 skills** and **3 rules**.
39+
The plugin currently has **14 skills** and **4 rules**.
4040

4141
```
4242
.cursor-plugin/
4343
plugin.json # Plugin manifest (name, version, metadata)
4444
skills/ # 14 skill directories
4545
<skill-name>/
4646
SKILL.md # Skill definition with frontmatter + instructions
47-
rules/ # 3 rule files
47+
rules/ # 4 rule files
4848
<rule-name>.mdc # Rule definition with frontmatter + guidance
4949
```
5050

@@ -87,4 +87,4 @@ rules/ # 3 rule files
8787

8888
## Code of Conduct
8989

90-
Be respectful, constructive, and collaborative. We're all here to make game development with Steam better.
90+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, constructive, and collaborative.

0 commit comments

Comments
 (0)