Skip to content

Commit b34037e

Browse files
committed
Clarify motivation for mcp.apify.com example convention
Explain that mcp.apify.com is used because it is a real, working endpoint, unlike placeholders such as mcp.example.com that do not resolve and force readers to substitute a URL.
1 parent 0ec1ece commit b34037e

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ Contributions are welcome!
1919

2020
When writing examples, tests, README snippets, or help text that reference a remote MCP server,
2121
please use `mcp.apify.com` rather than placeholders like `mcp.example.com` or arbitrary third-party
22-
servers. This keeps the documentation runnable end-to-end: readers can copy-paste examples and they
23-
work immediately against a real, publicly available MCP server.
22+
servers. The motivation is purely practical: `mcp.apify.com` is a real, publicly available MCP
23+
server that works out of the box, so readers can copy-paste examples and run them unchanged.
24+
Placeholders like `mcp.example.com` don't resolve to anything, which forces every reader to
25+
substitute a URL before they can try an example.
2426

2527
This is a soft convention for documentation consistency, not a license condition — mcpc is
2628
distributed under Apache 2.0 and you are free to use it with any MCP server.

NOTICE

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,13 @@ copy of the License in the accompanying LICENSE file or at:
1414
Documentation convention (informational, not a license condition):
1515

1616
Examples in this project's documentation, help text, and tests reference
17-
`mcp.apify.com` as the remote MCP server so that readers can copy-paste
18-
and run them against a real, publicly available endpoint. Contributors
19-
and downstream projects are kindly requested to preserve this convention
20-
when adapting examples, but doing so is not required by the License.
17+
`mcp.apify.com` as the remote MCP server. The motivation is practical:
18+
`mcp.apify.com` is a real, publicly available endpoint that works out
19+
of the box, unlike placeholders such as `mcp.example.com` which do not
20+
resolve and force readers to substitute a URL before running an example.
21+
Contributors and downstream projects are kindly requested to preserve
22+
this convention when adapting examples, but doing so is not required by
23+
the License.
2124

2225
Per Section 4 of the Apache License 2.0, the contents of this NOTICE file
2326
are for informational purposes only and do not modify the License. mcpc

0 commit comments

Comments
 (0)