Repository navigation
Add Skills extension
#3485
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.
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
Open
vijaydeepsinha
wants to merge
29
commits into
modelcontextprotocol:main
Choose a base branch
from
vijaydeepsinha:sep-2640-python-sdk-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,074
−0
Open
Add Skills extension
#3485
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
a4c6ae3
Add SEP-2640 protocol types and validation
573fc06
Add SEP-2640 server support
0cc8dbc
Add SEP-2640 client support
0729d95
Document SEP-2640 Python SDK support
3a3725b
Strengthen SEP-2640 validation test coverage
d31511c
Rename skill resource-URI validator for clarity
c00a1e7
Extract parallel directory-URI validator in Skills handlers
b4edd53
Pin the skill-name grammar rejection cases
b845490
Fix documentation accuracy in the Skills guide
2f363d5
Add end-to-end dynamic-skill and cursor-resume client tests
1adba1d
Report Skills handler-output faults as INTERNAL_ERROR, not INVALID_PA…
70493de
Reject directory-shaped skill resource URIs and dot-segment directory…
38706c1
Seed the pagination cursor and preserve request _meta across skills p…
f1d2920
Correct Skills docs on read_skill_uri return type and verify on dynam…
63254f8
Construct ListSkillsParams _meta via model_validate in the skills cli…
7e32fc9
Test that request _meta is camelCase on the wire and snake_case to a …
473804e
Empty commit to re-trigger CI after a transient PyPI network flake
a2e49d5
empty coomit to re-trigger ci check
071ad0e
added changes for cache-attributes and its tests
6972162
Merge branch 'main' into sep-2640-python-sdk-support
vijaydeepsinha e90e294
Merge branch 'main' into sep-2640-python-sdk-support
vijaydeepsinha cde5cff
incorporated review comments and defined skills as extensions
1ddace7
removed restriction to allow only 512 files and 16 mb for each skill,…
488e706
removed separate skill validations as per review suggestion
7ca165a
re validate the outbound payload for mutation
662ce93
modified the docs and added check for de-dup across pages
083a5dc
relaxed the de-dup failure
12957be
removed extra logging and extra exports
03e24f0
Merge branch 'main' into sep-2640-python-sdk-support
vijaydeepsinha File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Document SEP-2640 Python SDK support
Adds the Skills page under Advanced, with a runnable server/client example, and tests proving every claim the page makes against the real SDK.
- Loading branch information
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # Skills | ||
|
|
||
| [SEP-2640](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2640) defines a | ||
| convention for serving [Agent Skills](https://agentskills.io/) over MCP: a skill is a directory | ||
| of files — minimally a `SKILL.md` with YAML frontmatter — exposed as ordinary MCP resources, | ||
| conventionally under a `skill://` URI. A server enumerates its skills with `skills/list`, | ||
| answers for any one of them by URI with `skills/get`, and — optionally — lists a directory's | ||
| direct children with `resources/directory/read`. | ||
|
|
||
| The SDK ships this as the built-in `Skills` extension (`io.modelcontextprotocol/skills`). If | ||
| [Extensions](extensions.md) are new to you, skim that page first. | ||
|
|
||
| `Skills` provides the **protocol** primitives: request/response handling, capability | ||
| advertisement, and SEP-2640 conformance validation. It does not discover, read, or hash skills | ||
| from a filesystem — you supply handlers that answer from wherever your catalog actually lives | ||
| (a database, a generated index, an in-memory list, or a directory you walk yourself), and serve | ||
| each skill's files as ordinary resources through `MCPServer.add_resource` or | ||
| `add_resource_template`. | ||
|
|
||
| ## Serving a skill | ||
|
|
||
| ```python title="server.py" hl_lines="19-20 39-40 42" | ||
| --8<-- "docs_src/skills/tutorial001.py" | ||
| ``` | ||
|
|
||
| Three moves: | ||
|
|
||
| * `Skill(uri=..., frontmatter=..., resources=[...])`: one entry, identical in shape whether it | ||
| comes back from `skills/list` or `skills/get`. `resources` is the skill's complete file | ||
| manifest — every file, `SKILL.md` included, each with a `sha256:...` digest and byte size — or | ||
| the string `"dynamic"` for content generated on demand. | ||
| * `list_skills`/`get_skill`: plain async callables, invoked per request. `get_skill` **must** | ||
| answer for a skill even if a real `list_skills` implementation omitted it — SEP-2640 requires | ||
| a server to answer by URI for every skill it serves, listed or not. | ||
| * `mcp.add_resource(TextResource(uri=SKILL_URI, ...))`: the skill's actual file content, served | ||
| through the SDK's ordinary resource machinery. `Skills` never reads or writes resource content | ||
| itself. | ||
|
|
||
| `Skills(list_skills=..., get_skill=...)` is all a server needs; `resources/directory/read` is | ||
| optional (below). | ||
|
|
||
| ## Fetching a skill | ||
|
|
||
| ```python title="client.py" hl_lines="4" | ||
| --8<-- "docs_src/skills/tutorial001_client.py" | ||
| ``` | ||
|
|
||
| `list_skills` and `read_directory` follow `nextCursor` to completion, so you get every page's | ||
| skills or resources in one call. `get_skill` and `read_skill_uri` (a thin, discoverable alias for | ||
| `resources/read`) each cost exactly one request. All four validate the server's response against | ||
| the SEP-2640 conformance rules before returning it — a name that doesn't match its URI, a digest | ||
| in the wrong shape, or an incomplete manifest raises `ValueError` rather than reaching your code. | ||
|
|
||
| `verify_skill_resource(skill, uri, content)` checks a file's bytes — size, then SHA-256 digest — | ||
| against the entry you hold for it. Call it after `read_skill_uri` and before treating the content | ||
| as trustworthy: `resources/read` returns whatever bytes the server sends *right now*, verification | ||
| is what ties those bytes back to the manifest you already validated. | ||
|
|
||
| !!! warning | ||
| Skill content is untrusted model input, exactly like any other server-provided text. SEP-2640 | ||
| requires a host to tag it with its originating server before it reaches the model, and to | ||
| never grant the frontmatter's `allowed-tools` field (or any other permission-widening field) | ||
| without explicit per-skill user approval. Both are host responsibilities the SDK cannot | ||
| discharge for you — see the SEP's [Security Implications](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2640) | ||
| section before building a host on top of this extension. | ||
|
|
||
| ## Directory reads | ||
|
|
||
| A skill's instructions often point at a directory rather than a file ("pick the matching | ||
| template from `templates/`"). `resources/list` cannot answer that — it enumerates a server's | ||
| entire resource space, not one subtree — so SEP-2640 adds `resources/directory/read`, gated | ||
| behind the `directoryRead` capability setting: | ||
|
|
||
| ```python | ||
| mcp = MCPServer( | ||
| "catalog", | ||
| extensions=[ | ||
| Skills( | ||
| list_skills=list_skills, | ||
| get_skill=get_skill, | ||
| read_directory=read_directory, # lists uri's direct children | ||
| ) | ||
| ], | ||
| ) | ||
| ``` | ||
|
|
||
| Supplying `read_directory` advertises `{"directoryRead": true}` under the extension's | ||
| capabilities; omitting it advertises neither the setting nor the method — a client calling | ||
| `resources/directory/read` against such a server gets `METHOD_NOT_FOUND`. | ||
| `mcp.client.skills.read_directory` raises before sending if the connected server hasn't | ||
| advertised the setting. | ||
|
|
||
| ## Protocol version and caching | ||
|
|
||
| In protocol version `2026-07-28` and later, `skills/list` results carry the base protocol's | ||
| list-caching fields, [`ttlMs` and `cacheScope`](https://github.com/modelcontextprotocol/modelcontextprotocol/pull/2549) — the | ||
| same freshness hint `tools/list` and `resources/list` carry. `Skills` fills `cacheScope` with | ||
| `"public"` when your handler leaves it unset, and omits both fields entirely on an | ||
| older connection, so you don't have to branch on protocol version yourself. | ||
|
|
||
| ## What this SDK doesn't do | ||
|
|
||
| `Skills` is a protocol adapter, not a skills provider. It has no opinion on where a skill's | ||
| bytes live, how they're indexed, or when a catalog is refreshed — that's for a higher-level | ||
| library, or your own handler, to decide. If you're looking for "scan this directory and serve | ||
| whatever's in it," you're looking for a provider built on top of `Skills`, not `Skills` itself. | ||
Empty file.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| import hashlib | ||
| from typing import Any | ||
|
|
||
| from mcp_types import INVALID_PARAMS | ||
|
cubic-dev-ai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| from mcp.server.context import ServerRequestContext | ||
| from mcp.server.mcpserver import MCPServer | ||
| from mcp.server.mcpserver.resources import TextResource | ||
| from mcp.server.skills import Skills | ||
| from mcp.shared.exceptions import MCPError | ||
| from mcp.shared.skills import ( | ||
| GetSkillParams, | ||
| GetSkillResult, | ||
| ListSkillsParams, | ||
| ListSkillsResult, | ||
| Skill, | ||
| SkillResource, | ||
| ) | ||
|
|
||
| SKILL_URI = "skill://git-workflow/SKILL.md" | ||
| SKILL_MD = """\ | ||
| --- | ||
| name: git-workflow | ||
| description: Follow this team's Git conventions for branching and commits | ||
| --- | ||
|
|
||
| Branch from `main` using `type/short-description`. Write commit subjects in the | ||
| imperative mood, under 72 characters. | ||
| """ | ||
|
|
||
| GIT_WORKFLOW = Skill( | ||
| uri=SKILL_URI, | ||
| frontmatter={"name": "git-workflow", "description": "Follow this team's Git conventions for branching and commits"}, | ||
| resources=[ | ||
| SkillResource( | ||
| uri=SKILL_URI, | ||
| digest=f"sha256:{hashlib.sha256(SKILL_MD.encode()).hexdigest()}", | ||
| size=len(SKILL_MD.encode()), | ||
| ) | ||
| ], | ||
| ) | ||
|
|
||
|
|
||
| async def list_skills(ctx: ServerRequestContext[Any, Any], params: ListSkillsParams) -> ListSkillsResult: | ||
| return ListSkillsResult(skills=[GIT_WORKFLOW]) | ||
|
|
||
|
|
||
| async def get_skill(ctx: ServerRequestContext[Any, Any], params: GetSkillParams) -> GetSkillResult: | ||
| if params.uri != SKILL_URI: | ||
| raise MCPError(code=INVALID_PARAMS, message=f"unknown skill: {params.uri}") | ||
| return GetSkillResult(skill=GIT_WORKFLOW) | ||
|
|
||
|
|
||
| mcp = MCPServer("catalog", extensions=[Skills(list_skills=list_skills, get_skill=get_skill)]) | ||
| mcp.add_resource(TextResource(uri=SKILL_URI, name="SKILL.md", mime_type="text/markdown", text=SKILL_MD)) | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import anyio | ||
| from mcp_types import TextResourceContents | ||
|
|
||
| from mcp import Client | ||
| from mcp.client.skills import get_skill, list_skills, read_skill_uri, verify_skill_resource | ||
|
|
||
|
|
||
| async def main() -> None: | ||
| async with Client("http://localhost:8000/mcp") as client: | ||
| for skill in await list_skills(client.session): | ||
| print(skill.uri, skill.frontmatter["description"]) | ||
|
|
||
| skill = await get_skill(client.session, "skill://git-workflow/SKILL.md") | ||
| result = await read_skill_uri(client.session, skill.uri) | ||
| content = result.contents[0] | ||
| if isinstance(content, TextResourceContents): | ||
| verify_skill_resource(skill, skill.uri, content.text.encode()) | ||
| print(content.text) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| anyio.run(main) |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| """`docs/advanced/skills.md`: every claim the page makes, proved against the real SDK.""" | ||
|
|
||
| import pytest | ||
| from mcp_types import INVALID_PARAMS, TextResourceContents | ||
|
|
||
| from docs_src.skills import tutorial001 | ||
| from mcp import Client | ||
| from mcp.client.skills import get_skill, list_skills, read_skill_uri, verify_skill_resource | ||
| from mcp.shared.exceptions import MCPError | ||
|
|
||
| pytestmark = pytest.mark.anyio | ||
|
|
||
|
|
||
| async def test_list_skills_returns_the_registered_skill() -> None: | ||
| """tutorial001: `list_skills` returns the one skill the server declared.""" | ||
| async with Client(tutorial001.mcp) as client: | ||
| skills = await list_skills(client.session) | ||
| assert [s.uri for s in skills] == [tutorial001.SKILL_URI] | ||
|
|
||
|
|
||
| async def test_get_skill_answers_by_uri() -> None: | ||
| """tutorial001: `get_skill` returns the same entry `list_skills` does.""" | ||
| async with Client(tutorial001.mcp) as client: | ||
| skill = await get_skill(client.session, tutorial001.SKILL_URI) | ||
| assert skill.frontmatter["name"] == "git-workflow" | ||
|
|
||
|
|
||
| async def test_get_skill_rejects_an_unknown_uri() -> None: | ||
| """tutorial001: `get_skill` raises `-32602` (Invalid params) for an unknown skill.""" | ||
| async with Client(tutorial001.mcp) as client: | ||
| with pytest.raises(MCPError) as exc_info: | ||
| await get_skill(client.session, "skill://unknown/SKILL.md") | ||
| assert exc_info.value.code == INVALID_PARAMS | ||
|
|
||
|
|
||
| async def test_the_skill_file_is_served_as_an_ordinary_resource() -> None: | ||
| """tutorial001: `Skills` never reads or serves content itself — the file is registered | ||
| through `mcp.add_resource`, the SDK's ordinary resource machinery.""" | ||
| async with Client(tutorial001.mcp) as client: | ||
| result = await client.read_resource(tutorial001.SKILL_URI) | ||
| contents = result.contents[0] | ||
| assert isinstance(contents, TextResourceContents) | ||
| assert contents.mime_type == "text/markdown" | ||
| assert contents.text == tutorial001.SKILL_MD | ||
|
|
||
|
|
||
| async def test_read_skill_uri_content_verifies_against_the_held_skill() -> None: | ||
| """tutorial001_client: fetch the entry, read the file, verify the bytes against it - | ||
| the digest/size check `verify_skill_resource` performs.""" | ||
| async with Client(tutorial001.mcp) as client: | ||
| skill = await get_skill(client.session, tutorial001.SKILL_URI) | ||
| result = await read_skill_uri(client.session, skill.uri) | ||
| contents = result.contents[0] | ||
| assert isinstance(contents, TextResourceContents) | ||
| verify_skill_resource(skill, skill.uri, contents.text.encode()) |
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.
Uh oh!
There was an error while loading. Please reload this page.